guac_object Struct Reference

Represents a single object within the Guacamole protocol. More...

Data Fields
int	index
	The index of this object.
void *	data
	Arbitrary data associated with this object.
guac_user_get_handler *	get_handler
	Handler for get events sent by the Guacamole web-client.
guac_user_put_handler *	put_handler
	Handler for put events sent by the Guacamole web-client.

Detailed Description

Represents a single object within the Guacamole protocol.

Field Documentation

get_handler

guac_user_get_handler* guac_object::get_handler

Handler for get events sent by the Guacamole web-client.

The handler takes a guac_object, containing the object index which will persist through the duration of the transfer, and the name of the stream being requested. It is up to the get handler to create the required body stream.

Example:

int get_handler(guac_user* user, guac_object* object,
        char* name);
 
int some_function(guac_user* user) {
 
    guac_object* object = guac_user_alloc_object(user);
    object->get_handler = get_handler;
 
}

put_handler

guac_user_put_handler* guac_object::put_handler

Handler for put events sent by the Guacamole web-client.

The handler takes a guac_object and guac_stream, which each contain their respective indices which will persist through the duration of the transfer, the mimetype of the data being transferred, and the name of the stream within the object being written to.

Example:

int put_handler(guac_user* user, guac_object* object,
        guac_stream* stream, char* mimetype, char* name);
 
int some_function(guac_user* user) {
 
    guac_object* object = guac_user_alloc_object(user);
    object->put_handler = put_handler;
 
}

---

The documentation for this struct was generated from the following file:

• guacamole/object.h