Structure definition for session. More...
Data Fields | |
| char | buf [AST_WEBSOCKET_MAX_RX_PAYLOAD_SIZE] |
| struct websocket_client * | client |
| unsigned int | close_sent:1 |
| uint16_t | close_status_code |
| unsigned int | closing:1 |
| struct ast_sockaddr | local_address |
| enum ast_websocket_opcode | opcode |
| char * | payload |
| size_t | payload_len |
| size_t | reconstruct |
| struct ast_sockaddr | remote_address |
| unsigned int | secure:1 |
| char | session_id [AST_UUID_STR_LEN] |
| struct ast_iostream * | stream |
| int | timeout |
Detailed Description
Structure definition for session.
Definition at line 82 of file res_http_websocket.c.
Field Documentation
◆ buf
| char buf[AST_WEBSOCKET_MAX_RX_PAYLOAD_SIZE] |
Fixed buffer for reading data into
Definition at line 97 of file res_http_websocket.c.
Referenced by ws_send_msg().
◆ client
| struct websocket_client* client |
Client object when connected as a client websocket
Definition at line 94 of file res_http_websocket.c.
Referenced by ast_websocket_client_accept_protocol(), websocket_client_connect(), websocket_client_create(), websocket_client_handle_response_code(), and websocket_client_handshake_get_response().
◆ close_sent
| unsigned int close_sent |
Bit to indicate that the session close opcode has been sent and no further data will be sent
Definition at line 93 of file res_http_websocket.c.
◆ close_status_code
| uint16_t close_status_code |
Status code sent in a CLOSE frame upon shutdown
Definition at line 96 of file res_http_websocket.c.
◆ closing
| unsigned int closing |
Bit to indicate that the session is in the process of being closed
Definition at line 92 of file res_http_websocket.c.
◆ local_address
| struct ast_sockaddr local_address |
Our local address
Definition at line 85 of file res_http_websocket.c.
◆ opcode
| enum ast_websocket_opcode opcode |
Cached opcode for multi-frame messages
Definition at line 86 of file res_http_websocket.c.
Referenced by ast_websocket_close(), ast_websocket_read(), ast_websocket_read_string(), ast_websocket_write(), websocket_client_create(), websocket_opcode2str(), and ws_safe_read().
◆ payload
| char* payload |
Pointer to the payload
Definition at line 88 of file res_http_websocket.c.
Referenced by ast_websocket_read(), ast_websocket_read_string(), and ast_websocket_write().
◆ payload_len
| size_t payload_len |
Length of the payload
Definition at line 87 of file res_http_websocket.c.
Referenced by ast_websocket_read(), and ast_websocket_read_string().
◆ reconstruct
| size_t reconstruct |
Number of bytes before a reconstructed payload will be returned and a new one started
Definition at line 89 of file res_http_websocket.c.
Referenced by websocket_client_create().
◆ remote_address
| struct ast_sockaddr remote_address |
Address of the remote client
Definition at line 84 of file res_http_websocket.c.
Referenced by websocket_client_connect().
◆ secure
| unsigned int secure |
Bit to indicate that the transport is secure
Definition at line 91 of file res_http_websocket.c.
Referenced by websocket_client_connect().
◆ session_id
| char session_id[AST_UUID_STR_LEN] |
The identifier for the websocket session
Definition at line 95 of file res_http_websocket.c.
Referenced by websocket_client_create().
◆ stream
| struct ast_iostream* stream |
iostream of the connection
Definition at line 83 of file res_http_websocket.c.
Referenced by websocket_client_connect().
◆ timeout
| int timeout |
The timeout for operations on the socket
Definition at line 90 of file res_http_websocket.c.
Referenced by ast_websocket_set_timeout(), ast_websocket_wait_for_input(), and websocket_client_create().
The documentation for this struct was generated from the following file:
