Asterisk - The Open Source Telephony Project  18.5.0
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Macros Modules Pages
Data Fields
ast_websocket_protocol Struct Reference

A websocket protocol implementation. More...

#include <http_websocket.h>

Collaboration diagram for ast_websocket_protocol:
Collaboration graph
[legend]

Data Fields

char * name
 Name of the protocol. More...
 
ast_websocket_pre_callback session_attempted
 Callback called when a new session is attempted. Optional. More...
 
ast_websocket_callback session_established
 
unsigned int version
 Protocol version. Should be set to /ref AST_WEBSOCKET_PROTOCOL_VERSION. More...
 

Detailed Description

A websocket protocol implementation.

Users of the Websocket API can register themselves as a websocket protocol. See ast_websocket_add_protocol2 and ast_websocket_server_add_protocol2. Simpler implementations may use only ast_websocket_add_protocol and ast_websocket_server_add_protocol.

Since
13.5.0

Definition at line 112 of file http_websocket.h.

Field Documentation

◆ name

char* name

◆ session_attempted

ast_websocket_pre_callback session_attempted

Callback called when a new session is attempted. Optional.

Definition at line 123 of file http_websocket.h.

Referenced by ast_websocket_uri_cb(), and load_module().

◆ session_established

ast_websocket_callback session_established

◆ version

unsigned int version

Protocol version. Should be set to /ref AST_WEBSOCKET_PROTOCOL_VERSION.

Definition at line 121 of file http_websocket.h.

Referenced by ast_websocket_sub_protocol_alloc(), and ParsingContext::next().


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