GUACAMOLE-269: More documentation updates.

This commit is contained in:
Nick Couchman 2018-03-24 15:09:34 -04:00
parent 112ce5299e
commit 11136f7d7b

View File

@ -46,21 +46,43 @@
#define GUAC_SSH_TTY_OP_VERASE 3 #define GUAC_SSH_TTY_OP_VERASE 3
/** /**
* Simple structure that defines a opcode and * The SSH protocol attempts to configure the remote
* value pair. * terminal by sending pairs of opcodes and values, as
* described in Section 8 of RFC 4254. These are
* comprised of a single byte opcode and a 4-byte
* value. This data structure stores a single opcode
* and value pair.
*/ */
typedef struct guac_ssh_ttymode { typedef struct guac_ssh_ttymode {
/**
* The single byte opcode for defining the TTY
* encoding setting for the remote terminal. The
* stadard codes are defined in Section 8 of
* the SSH RFC (4254).
*/
char opcode; char opcode;
/**
* The four byte value of the setting for the
* defined opcode.
*/
uint32_t value; uint32_t value;
} guac_ssh_ttymode; } guac_ssh_ttymode;
/** /**
* Initialize an array with the specified opcode/value * Opcodes and value pairs are passed to the SSH connection
* pairs, returning 0 if successful, or a non-zero value * in a single array, beginning with the opcode and followed
* if a failure occurs. * by a four byte value, repeating until the end opcode is
* encountered. This function takes the array, the array
* size, expected number of opcodes, and that number of
* guac_ssh_ttymode arguments and puts them in the array
* exepcted by the SSH connection.
* *
* @param opcode_array * @param opcode_array
* Pointer to the opcode array. * Pointer to the opcode array that will ultimately
* be passed to the SSH connection.
* *
* @param array_size * @param array_size
* Size, in bytes, of the array. * Size, in bytes, of the array.