client-fntypes.h File Reference

Function type definitions related to the Guacamole client structure, guac_client. More...

Go to the source code of this file.

Typedefs
typedef int	guac_client_free_handler(guac_client *client)
	Handler for freeing up any extra data allocated by the client implementation.
typedef int	guac_client_join_pending_handler(guac_client *client)
	Handler that will run before immediately before pending users are promoted to full users.
typedef void	guac_client_log_handler(guac_client *client, guac_client_log_level level, const char *format, va_list args)
	Handler for logging messages related to a given guac_client instance.
typedef int	guac_client_init_handler(guac_client *client)
	The entry point of a client plugin which must initialize the given guac_client.

Detailed Description

Function type definitions related to the Guacamole client structure, guac_client.

Typedef Documentation

guac_client_free_handler

typedef int guac_client_free_handler(guac_client *client)

Handler for freeing up any extra data allocated by the client implementation.

Parameters

client

The client whose extra data should be freed (if any).

Returns

Zero if the data was successfully freed, non-zero if an error prevents the data from being freed.

guac_client_init_handler

typedef int guac_client_init_handler(guac_client *client)

The entry point of a client plugin which must initialize the given guac_client.

In practice, this function will be called "guac_client_init".

Parameters

client

The guac_client that must be initialized.

Returns

Zero on success, non-zero if initialization fails for any reason.

guac_client_join_pending_handler

typedef int guac_client_join_pending_handler(guac_client *client)

Handler that will run before immediately before pending users are promoted to full users.

The pending user socket should be used to communicate to the pending users.

Parameters

client

The client whose handler was invoked.

Returns

Zero if the pending handler ran successfully, or a non-zero value if an error occurred.

guac_client_log_handler

typedef void guac_client_log_handler(guac_client *client, guac_client_log_level level, const char *format, va_list args)

Handler for logging messages related to a given guac_client instance.

Parameters

client	The client related to the message being logged.
level	The log level at which to log the given message.
format	A printf-style format string, defining the message to be logged.
args	The va_list containing the arguments to be used when filling the conversion specifiers ("%s", "%i", etc.) within the format string.