Asterisk - The Open Source Telephony Project  21.4.1
Data Fields
ast_websocket Struct Reference

Structure definition for session. More...

Data Fields

char buf [MAXIMUM_FRAME_SIZE]
 
struct websocket_clientclient
 
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_iostreamstream
 
int timeout
 

Detailed Description

Structure definition for session.

Definition at line 88 of file res_http_websocket.c.

Field Documentation

char buf[MAXIMUM_FRAME_SIZE]

Fixed buffer for reading data into

Definition at line 103 of file res_http_websocket.c.

struct websocket_client* client

Client object when connected as a client websocket

Definition at line 100 of file res_http_websocket.c.

Referenced by ast_websocket_close(), ast_websocket_write(), session_destroy_fn(), and websocket_mask_payload().

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 99 of file res_http_websocket.c.

Referenced by ast_websocket_close().

uint16_t close_status_code

Status code sent in a CLOSE frame upon shutdown

Definition at line 102 of file res_http_websocket.c.

Referenced by session_destroy_fn().

unsigned int closing

Bit to indicate that the session is in the process of being closed

Definition at line 98 of file res_http_websocket.c.

Referenced by ast_websocket_close(), and ast_websocket_write().

struct ast_sockaddr local_address

Our local address

Definition at line 91 of file res_http_websocket.c.

enum ast_websocket_opcode opcode

Cached opcode for multi-frame messages

Definition at line 92 of file res_http_websocket.c.

Referenced by ast_websocket_close().

char* payload

Pointer to the payload

Definition at line 94 of file res_http_websocket.c.

Referenced by session_destroy_fn().

size_t payload_len

Length of the payload

Definition at line 93 of file res_http_websocket.c.

size_t reconstruct

Number of bytes before a reconstructed payload will be returned and a new one started

Definition at line 95 of file res_http_websocket.c.

struct ast_sockaddr remote_address

Address of the remote client

Definition at line 90 of file res_http_websocket.c.

Referenced by ast_websocket_close(), and session_destroy_fn().

unsigned int secure

Bit to indicate that the transport is secure

Definition at line 97 of file res_http_websocket.c.

char session_id[AST_UUID_STR_LEN]

The identifier for the websocket session

Definition at line 101 of file res_http_websocket.c.

struct ast_iostream* stream

iostream of the connection

Definition at line 89 of file res_http_websocket.c.

Referenced by ast_websocket_close(), ast_websocket_write(), and session_destroy_fn().

int timeout

The timeout for operations on the socket

Definition at line 96 of file res_http_websocket.c.

Referenced by ast_websocket_close(), and ast_websocket_write().


The documentation for this struct was generated from the following file: