From 3249d068d334b8ae61540bbe71bcce103b1f1c92 Mon Sep 17 00:00:00 2001 From: Michael Jumper Date: Wed, 20 Jun 2012 13:45:15 -0700 Subject: [PATCH] Prototypes for streaming inructions. --- libguac/include/protocol.h | 66 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 66 insertions(+) diff --git a/libguac/include/protocol.h b/libguac/include/protocol.h index e73db9a1..c1cbef3d 100644 --- a/libguac/include/protocol.h +++ b/libguac/include/protocol.h @@ -51,6 +51,21 @@ */ +/** + * Annotates a resource related to printing. + */ +#define GUAC_REL_PRINTER "printer" + +/** + * Annotates a resource related to file transfer. + */ +#define GUAC_REL_FILE "file" + +/** + * Annotates a resource related to audio. + */ +#define GUAC_REL_AUDIO "audio" + /** * An arbitrary timestamp denoting a relative time value in milliseconds. */ @@ -182,6 +197,13 @@ struct guac_layer { */ int index; + /** + * The string which must be passed via a resource instruction to denote + * a resource related to this layer. This value is automatically set + * upon allocation. + */ + const char* rel; + /** * The next allocated layer in the list of all layers. */ @@ -290,6 +312,20 @@ guac_timestamp guac_protocol_get_timestamp(); /* CONTROL INSTRUCTIONS */ +/** + * Sends an accept instruction over the given guac_socket connection. + * + * If an error occurs sending the instruction, a non-zero value is + * returned, and guac_error is set appropriately. + * + * @param socket The guac_socket connection to use. + * @param uuid The UUID of the resource that is being accepted. + * @param mimetype The mimetype being accepted. + * @return Zero on success, non-zero on error. + */ +int guac_protocol_send_accept(guac_socket* socket, const char* uuid, + const char* mimetype); + /** * Sends an args instruction over the given guac_socket connection. * @@ -337,6 +373,36 @@ int guac_protocol_send_disconnect(guac_socket* socket); */ int guac_protocol_send_error(guac_socket* socket, const char* error); +/** + * Sends a reject instruction over the given guac_socket connection. + * + * If an error occurs sending the instruction, a non-zero value is + * returned, and guac_error is set appropriately. + * + * @param socket The guac_socket connection to use. + * @param uuid The UUID of the resource that is being rejected. + * @return Zero on success, non-zero on error. + */ +int guac_protocol_send_reject(guac_socket* socket, const char* uuid); + +/** + * Sends a resource instruction over the given guac_socket connection. + * + * If an error occurs sending the instruction, a non-zero value is + * returned, and guac_error is set appropriately. + * + * @param socket The guac_socket connection to use. + * @param rel What this resource is related to (see the GUAC_REL_* + * constants). + * @param uuid The UUID of the resource that will be exposed. + * @param mimetypes An array of strings, where each string is an available + * mimetype. + * @param length The number of elements in the array of mimetype strings. + * @return Zero on success, non-zero on error. + */ +int guac_protocol_send_resource(guac_socket* socket, const char* rel, + const char* uuid, const char** mimetypes, int length); + /** * Sends a set instruction over the given guac_socket connection. *