Provides functions and structures required for defining (and handling) a proxy client. More...

Data Structures
struct	guac_client_info
	Information exposed by the remote client during the connection handshake which can be used by a client plugin. More...
struct	guac_client
	Guacamole proxy client. More...

Macros
#define	GUAC_CLIENT_MAX_STREAMS 64
	The maximum number of inbound streams supported by any one guac_client.
#define	GUAC_CLIENT_CLOSED_STREAM_INDEX -1
	The index of a closed stream.
#define	GUAC_CLIENT_MOUSE_LEFT 0x01
	The flag set in the mouse button mask when the left mouse button is down.
#define	GUAC_CLIENT_MOUSE_MIDDLE 0x02
	The flag set in the mouse button mask when the middle mouse button is down.
#define	GUAC_CLIENT_MOUSE_RIGHT 0x04
	The flag set in the mouse button mask when the right mouse button is down.
#define	GUAC_CLIENT_MOUSE_SCROLL_UP 0x08
	The flag set in the mouse button mask when the mouse scrollwheel is scrolled up.
#define	GUAC_CLIENT_MOUSE_SCROLL_DOWN 0x10
	The flag set in the mouse button mask when the mouse scrollwheel is scrolled down.
#define	GUAC_BUFFER_POOL_INITIAL_SIZE 1024
	The minimum number of buffers to create before allowing free'd buffers to be reclaimed.

Typedefs
typedef int	guac_client_handle_messages (guac_client *client)
	Handler for server messages (where "server" refers to the server that the proxy client is connected to).
typedef int	guac_client_mouse_handler (guac_client *client, int x, int y, int button_mask)
	Handler for Guacamole mouse events.
typedef int	guac_client_key_handler (guac_client *client, int keysym, int pressed)
	Handler for Guacamole key events.
typedef int	guac_client_clipboard_handler (guac_client client, char copied)
	Handler for Guacamole clipboard events.
typedef int	guac_client_size_handler (guac_client *client, int width, int height)
	Handler for Guacamole screen size events.
typedef int	guac_client_file_handler (guac_client client, guac_stream stream, char mimetype, char filename)
	Handler for Guacamole file transfer events.
typedef int	guac_client_pipe_handler (guac_client client, guac_stream stream, char mimetype, char name)
	Handler for Guacamole pipe events.
typedef int	guac_client_blob_handler (guac_client client, guac_stream stream, void *data, int length)
	Handler for Guacamole stream blob events.
typedef int	guac_client_ack_handler (guac_client client, guac_stream stream, char *error, guac_protocol_status status)
	Handler for Guacamole stream ack events.
typedef int	guac_client_end_handler (guac_client client, guac_stream stream)
	Handler for Guacamole stream end events.
typedef int	guac_client_audio_handler (guac_client client, char mimetype)
	Handler for Guacamole audio format events.
typedef int	guac_client_video_handler (guac_client client, char mimetype)
	Handler for Guacamole video format events.
typedef int	guac_client_free_handler (guac_client *client)
	Handler for freeing up any extra data allocated by the client implementation.
typedef void	guac_client_log_handler (guac_client client, const char format, va_list args)
	Handler for logging messages.
typedef int	guac_client_init_handler (guac_client client, int argc, char *argv)
	Handler which should initialize the given guac_client.

Enumerations
enum	guac_client_state { GUAC_CLIENT_RUNNING, GUAC_CLIENT_STOPPING }
	Possible current states of the Guacamole client. More...

Functions
guac_client *	guac_client_alloc ()
	Returns a new, barebones guac_client.
void	guac_client_free (guac_client *client)
	Free all resources associated with the given client.
int	guac_client_handle_instruction (guac_client client, guac_instruction instruction)
	Call the appropriate handler defined by the given client for the given instruction.
void	guac_client_log_info (guac_client client, const char format,...)
	Logs an informational message in the log used by the given client.
void	guac_client_log_error (guac_client client, const char format,...)
	Logs an error message in the log used by the given client.
void	vguac_client_log_info (guac_client client, const char format, va_list ap)
	Logs an informational message in the log used by the given client.
void	vguac_client_log_error (guac_client client, const char format, va_list ap)
	Logs an error message in the log used by the given client.
void	guac_client_stop (guac_client *client)
	Signals the given client to stop gracefully.
void	guac_client_abort (guac_client client, guac_protocol_status status, const char format,...)
	Signals the given client to stop gracefully, while also signalling via the Guacamole protocol that an error has occurred.
void	vguac_client_abort (guac_client client, guac_protocol_status status, const char format, va_list ap)
	Signals the given client to stop gracefully, while also signalling via the Guacamole protocol that an error has occurred.
guac_layer *	guac_client_alloc_buffer (guac_client *client)
	Allocates a new buffer (invisible layer).
guac_layer *	guac_client_alloc_layer (guac_client *client)
	Allocates a new layer.
void	guac_client_free_buffer (guac_client client, guac_layer layer)
	Returns the given buffer to the pool of available buffers, such that it can be reused by any subsequent call to guac_client_allow_buffer().
void	guac_client_free_layer (guac_client client, guac_layer layer)
	Returns the given layer to the pool of available layers, such that it can be reused by any subsequent call to guac_client_allow_layer().
guac_stream *	guac_client_alloc_stream (guac_client *client)
	Allocates a new stream.
void	guac_client_free_stream (guac_client client, guac_stream stream)
	Returns the given stream to the pool of available streams, such that it can be reused by any subsequent call to guac_client_alloc_stream().

Variables
const guac_layer *	GUAC_DEFAULT_LAYER
	The default Guacamole client layer, layer 0.

Detailed Description

Provides functions and structures required for defining (and handling) a proxy client.

Macro Definition Documentation

#define GUAC_BUFFER_POOL_INITIAL_SIZE 1024

The minimum number of buffers to create before allowing free'd buffers to be reclaimed.

In the case a protocol rapidly creates, uses, and destroys buffers, this can prevent unnecessary reuse of the same buffer (which would make draw operations unnecessarily synchronous).

#define GUAC_CLIENT_MOUSE_SCROLL_DOWN 0x10

The flag set in the mouse button mask when the mouse scrollwheel is scrolled down.

Note that mouse scrollwheels are actually sets of two buttons. One button is pressed and released for an upward scroll, and the other is pressed and released for a downward scroll. Some mice may actually implement these as separate buttons, not a wheel.

#define GUAC_CLIENT_MOUSE_SCROLL_UP 0x08

The flag set in the mouse button mask when the mouse scrollwheel is scrolled up.

Note that mouse scrollwheels are actually sets of two buttons. One button is pressed and released for an upward scroll, and the other is pressed and released for a downward scroll. Some mice may actually implement these as separate buttons, not a wheel.

Enumeration Type Documentation

enum guac_client_state

Possible current states of the Guacamole client.

Currently, the only two states are GUAC_CLIENT_RUNNING and GUAC_CLIENT_STOPPING.

Enumerator:

GUAC_CLIENT_RUNNING	The state of the client from when it has been allocated by the main daemon until it is killed or disconnected.
GUAC_CLIENT_STOPPING	The state of the client when a stop has been requested, signalling the I/O threads to shutdown.

Function Documentation

void guac_client_abort	(	guac_client *	client,
		guac_protocol_status	status,
		const char *	format,
			...
	)

Signals the given client to stop gracefully, while also signalling via the Guacamole protocol that an error has occurred.

Note that this is a completely cooperative signal, and can be ignored by the client or the hosting daemon. The message given will be logged to the system logs.

Parameters

client	The proxy client to signal to stop.
status	The status to send over the Guacamole protocol.
format	A printf-style format string to log.
...	Arguments to use when filling the format string for printing.

guac_client* guac_client_alloc ( )

Returns a new, barebones guac_client.

This new guac_client has no handlers set, but is otherwise usable.

Returns: A pointer to the new client.

guac_layer* guac_client_alloc_buffer ( guac_client * client )

Allocates a new buffer (invisible layer).

An arbitrary index is automatically assigned if no existing buffer is available for use.

Parameters

client The proxy client to allocate the buffer for.

Returns: The next available buffer, or a newly allocated buffer.

guac_layer* guac_client_alloc_layer ( guac_client * client )

Allocates a new layer.

An arbitrary index is automatically assigned if no existing layer is available for use.

Parameters

client The proxy client to allocate the layer buffer for.

Returns: The next available layer, or a newly allocated layer.

guac_stream* guac_client_alloc_stream ( guac_client * client )

Allocates a new stream.

An arbitrary index is automatically assigned if no previously-allocated stream is available for use.

Parameters

client The proxy client to allocate the layer buffer for.

Returns: The next available stream, or a newly allocated stream.

void guac_client_free ( guac_client * client )

Free all resources associated with the given client.

Parameters

client The proxy client to free all reasources of.

void guac_client_free_buffer	(	guac_client *	client,
		guac_layer *	layer
	)

Returns the given buffer to the pool of available buffers, such that it can be reused by any subsequent call to guac_client_allow_buffer().

Parameters

client	The proxy client to return the buffer to.
layer	The buffer to return to the pool of available buffers.

void guac_client_free_layer	(	guac_client *	client,
		guac_layer *	layer
	)

Returns the given layer to the pool of available layers, such that it can be reused by any subsequent call to guac_client_allow_layer().

Parameters

client	The proxy client to return the layer to.
layer	The buffer to return to the pool of available layer.

void guac_client_free_stream	(	guac_client *	client,
		guac_stream *	stream
	)

Returns the given stream to the pool of available streams, such that it can be reused by any subsequent call to guac_client_alloc_stream().

Parameters

client	The proxy client to return the buffer to.
stream	The stream to return to the pool of available stream.

int guac_client_handle_instruction	(	guac_client *	client,
		guac_instruction *	instruction
	)

Call the appropriate handler defined by the given client for the given instruction.

A comparison is made between the instruction opcode and the initial handler lookup table defined in client-handlers.c. The intial handlers will in turn call the client's handler (if defined).

Parameters

client	The proxy client whose handlers should be called.
instruction	The instruction to pass to the proxy client via the appropriate handler.

void guac_client_log_error	(	guac_client *	client,
		const char *	format,
			...
	)

Logs an error message in the log used by the given client.

The logger used will normally be defined by guacd (or whichever program loads the proxy client) by setting the logging handlers of the client when it is loaded.

Parameters

client	The proxy client to log an error for.
format	A printf-style format string to log.
...	Arguments to use when filling the format string for printing.

void guac_client_log_info	(	guac_client *	client,
		const char *	format,
			...
	)

Logs an informational message in the log used by the given client.

The logger used will normally be defined by guacd (or whichever program loads the proxy client) by setting the logging handlers of the client when it is loaded.

Parameters

client	The proxy client to log an informational message for.
format	A printf-style format string to log.
...	Arguments to use when filling the format string for printing.

void guac_client_stop ( guac_client * client )

Signals the given client to stop gracefully.

This is a completely cooperative signal, and can be ignored by the client or the hosting daemon.

Parameters

client The proxy client to signal to stop.

void vguac_client_abort	(	guac_client *	client,
		guac_protocol_status	status,
		const char *	format,
		va_list	ap
	)

Signals the given client to stop gracefully, while also signalling via the Guacamole protocol that an error has occurred.

Note that this is a completely cooperative signal, and can be ignored by the client or the hosting daemon. The message given will be logged to the system logs.

Parameters

client	The proxy client to signal to stop.
status	The status to send over the Guacamole protocol.
format	A printf-style format string to log.
ap	The va_list containing the arguments to be used when filling the format string for printing.

void vguac_client_log_error	(	guac_client *	client,
		const char *	format,
		va_list	ap
	)

Logs an error message in the log used by the given client.

The logger used will normally be defined by guacd (or whichever program loads the proxy client) by setting the logging handlers of the client when it is loaded.

Parameters

client	The proxy client to log an error for.
format	A printf-style format string to log.
ap	The va_list containing the arguments to be used when filling the format string for printing.

void vguac_client_log_info	(	guac_client *	client,
		const char *	format,
		va_list	ap
	)

Logs an informational message in the log used by the given client.

The logger used will normally be defined by guacd (or whichever program loads the proxy client) by setting the logging handlers of the client when it is loaded.

Parameters

client	The proxy client to log an informational message for.
format	A printf-style format string to log.
ap	The va_list containing the arguments to be used when filling the format string for printing.

Data Structures

Macros

Typedefs

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

Enumeration Type Documentation

Function Documentation