A websocket protocol implementation. More...
#include <http_websocket.h>
Data Fields | |
| char * | name |
| Name of the protocol. | |
| ast_websocket_pre_callback | session_attempted |
| Callback called when a new session is attempted. Optional. | |
| ast_websocket_callback | session_established |
| Callback called when a new session is established. Mandatory. | |
| unsigned int | version |
| Protocol version. Should be set to /ref AST_WEBSOCKET_PROTOCOL_VERSION. | |
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 141 of file http_websocket.h.
Field Documentation
◆ name
| char* name |
Name of the protocol.
Definition at line 143 of file http_websocket.h.
Referenced by ast_websocket_sub_protocol_alloc(), ast_websocket_uri_cb(), PathSegment::get_child(), SwaggerType::load(), protocol_cmp_fn(), protocol_destroy_fn(), and protocol_hash_fn().
◆ session_attempted
| ast_websocket_pre_callback session_attempted |
Callback called when a new session is attempted. Optional.
Definition at line 152 of file http_websocket.h.
Referenced by ari_websocket_load_module(), and ast_websocket_uri_cb().
◆ session_established
| ast_websocket_callback session_established |
Callback called when a new session is established. Mandatory.
Definition at line 154 of file http_websocket.h.
Referenced by ari_websocket_load_module(), ast_websocket_server_add_protocol(), ast_websocket_server_remove_protocol(), ast_websocket_uri_cb(), and load_module().
◆ version
| unsigned int version |
Protocol version. Should be set to /ref AST_WEBSOCKET_PROTOCOL_VERSION.
Definition at line 150 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:
