guac_stream Struct Reference

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

Data Fields

int index
 The index of this stream.
void * data
 Arbitrary data associated with this stream.
guac_user_ack_handlerack_handler
 Handler for ack events sent by the Guacamole web-client.
guac_user_blob_handlerblob_handler
 Handler for blob events sent by the Guacamole web-client.
guac_user_end_handlerend_handler
 Handler for stream end events sent by the Guacamole web-client.

Detailed Description

Represents a single stream within the Guacamole protocol.


Field Documentation

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

The handler takes a guac_stream which contains the stream index and will persist through the duration of the transfer, a string containing the error or status message, and a status code.

Example:

     int ack_handler(guac_user* user, guac_stream* stream,
             char* error, guac_protocol_status status);

     int some_function(guac_user* user) {

         guac_stream* stream = guac_user_alloc_stream(user);
         stream->ack_handler = ack_handler;

         guac_protocol_send_clipboard(user->socket,
             stream, "text/plain");

     }

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

The handler takes a guac_stream which contains the stream index and will persist through the duration of the transfer, an arbitrary buffer containing the blob, and the length of the blob.

Example:

     int blob_handler(guac_user* user, guac_stream* stream,
             void* data, int length);

     int my_clipboard_handler(guac_user* user, guac_stream* stream,
             char* mimetype) {
         stream->blob_handler = blob_handler;
     }

Handler for stream end events sent by the Guacamole web-client.

The handler takes only a guac_stream which contains the stream index. This guac_stream will be disposed of immediately after this event is finished.

Example:

     int end_handler(guac_user* user, guac_stream* stream);

     int my_clipboard_handler(guac_user* user, guac_stream* stream,
             char* mimetype) {
         stream->end_handler = end_handler;
     }

The documentation for this struct was generated from the following file:
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines

Generated on 12 Jan 2021 for libguac by  doxygen 1.6.1