From d73b86b4b7c41fc7fa16423fc340d644c729b233 Mon Sep 17 00:00:00 2001 From: Michael Jumper Date: Mon, 7 Jan 2019 09:37:08 -0800 Subject: [PATCH] GUACAMOLE-661: Mark "nest" instruction and socket as deprecated. --- src/libguac/guacamole/protocol.h | 7 +++++++ src/libguac/guacamole/socket.h | 7 +++++++ 2 files changed, 14 insertions(+) diff --git a/src/libguac/guacamole/protocol.h b/src/libguac/guacamole/protocol.h index fd824af6c..d1a0420a3 100644 --- a/src/libguac/guacamole/protocol.h +++ b/src/libguac/guacamole/protocol.h @@ -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 * 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 index The integer index of the stram to send the protocol * data over. diff --git a/src/libguac/guacamole/socket.h b/src/libguac/guacamole/socket.h index e83a4ebc2..2da697fed 100644 --- a/src/libguac/guacamole/socket.h +++ b/src/libguac/guacamole/socket.h @@ -180,6 +180,13 @@ guac_socket* guac_socket_open(int fd); * If an error occurs while allocating the guac_socket object, NULL is 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 parent The guac_socket this new guac_socket should write nest * instructions to. * @param index The stream index to use for the written nest instructions.