maride/guacamole-spice-protocol
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

GUACAMOLE-661: Mark "nest" instruction and socket as deprecated.

Browse Source
This commit is contained in:
Michael Jumper 2019-01-07 09:37:08 -08:00
parent bb9560716d
commit d73b86b4b7
2 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/libguac/guacamole/protocol.h
View File

@ -214,6 +214,13 @@ int guac_protocol_send_mouse(guac_socket* socket, int x, int y,
* If an error occurs sending the instruction, a non-zero value is * If an error occurs sending the instruction, a non-zero value is
* returned, and guac_error is set appropriately. * returned, and guac_error is set appropriately.
* *
* @deprecated
* The "nest" instruction and the corresponding guac_socket
* implementation are no longer necessary, having been replaced by
* the streaming instructions ("blob", "ack", "end"). Code using nested
* sockets or the "nest" instruction should instead write to a normal
* socket directly.
*
* @param socket The guac_socket connection to use. * @param socket The guac_socket connection to use.
* @param index The integer index of the stram to send the protocol * @param index The integer index of the stram to send the protocol
* data over. * data over.

7
src/libguac/guacamole/socket.h
View File

@ -180,6 +180,13 @@ guac_socket* guac_socket_open(int fd);
* If an error occurs while allocating the guac_socket object, NULL is returned, * If an error occurs while allocating the guac_socket object, NULL is returned,
* and guac_error is set appropriately. * and guac_error is set appropriately.
* *
* @deprecated
* The "nest" instruction and the corresponding guac_socket
* implementation are no longer necessary, having been replaced by
* the streaming instructions ("blob", "ack", "end"). Code using nested
* sockets or the "nest" instruction should instead write to a normal
* socket directly.
*
* @param parent The guac_socket this new guac_socket should write nest * @param parent The guac_socket this new guac_socket should write nest
* instructions to. * instructions to.
* @param index The stream index to use for the written nest instructions. * @param index The stream index to use for the written nest instructions.