client-constants.h File Reference

Constants related to the Guacamole client structure, guac_client. More...

Go to the source code of this file.

Macros
#define	GUAC_CLIENT_MAX_STREAMS   64
	The maximum number of inbound or outbound streams supported by any one guac_client.
#define	GUAC_CLIENT_CLOSED_STREAM_INDEX   -1
	The index of a closed stream.
#define	GUAC_CLIENT_ID_PREFIX   '$'
	The character prefix which identifies a client ID.
#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. More...
#define	GUAC_CLIENT_MOUSE_SCROLL_DOWN   0x10
	The flag set in the mouse button mask when the mouse scrollwheel is scrolled down. More...
#define	GUAC_BUFFER_POOL_INITIAL_SIZE   1024
	The minimum number of buffers to create before allowing free'd buffers to be reclaimed. More...

Detailed Description

Constants related to the Guacamole client structure, guac_client.

Macro Definition Documentation

GUAC_BUFFER_POOL_INITIAL_SIZE

#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).

GUAC_CLIENT_MOUSE_SCROLL_DOWN

#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.

GUAC_CLIENT_MOUSE_SCROLL_UP

#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.