protocol-constants.h File Reference

Constants related to the Guacamole protocol. More...

Go to the source code of this file.

Macros
#define	GUACAMOLE_PROTOCOL_VERSION   "VERSION_1_5_0"
	This defines the overall protocol version that this build of libguac supports.
#define	GUAC_PROTOCOL_BLOB_MAX_LENGTH   6048
	The maximum number of bytes that should be sent in any one blob instruction to ensure the instruction does not exceed the maximum allowed instruction size.
#define	GUAC_PROTOCOL_LAYER_PARAMETER_MULTI_TOUCH   "multi-touch"
	The name of the layer parameter defining the number of simultaneous points of contact supported by a layer.

Detailed Description

Constants related to the Guacamole protocol.

Macro Definition Documentation

GUAC_PROTOCOL_BLOB_MAX_LENGTH

#define GUAC_PROTOCOL_BLOB_MAX_LENGTH   6048

The maximum number of bytes that should be sent in any one blob instruction to ensure the instruction does not exceed the maximum allowed instruction size.

See also

GUAC_INSTRUCTION_MAX_LENGTH

GUAC_PROTOCOL_LAYER_PARAMETER_MULTI_TOUCH

#define GUAC_PROTOCOL_LAYER_PARAMETER_MULTI_TOUCH   "multi-touch"

The name of the layer parameter defining the number of simultaneous points of contact supported by a layer.

This parameter should be set to a non-zero value if the associated layer should receive touch events ("touch" instructions).

This value specified for this parameter is advisory, and the client is not required to honor the declared level of touch support. Implementations are expected to safely handle or ignore any received touch events, regardless of the level of touch support declared.

See also

guac_protocol_send_set_int()

GUACAMOLE_PROTOCOL_VERSION

#define GUACAMOLE_PROTOCOL_VERSION   "VERSION_1_5_0"

This defines the overall protocol version that this build of libguac supports.

The protocol version is used to provide compatibility between potentially different versions of Guacamole server and clients. The version number is a MAJOR_MINOR_PATCH version that matches the versioning used throughout the components of the Guacamole project. This version will not necessarily increment with the other components, unless additional functionality is introduced that affects compatibility.

This version is passed by the __guac_protocol_send_args() function from the server to the client during the client/server handshake.