#include <websocket_client.h>
Public Member Functions | |
| AST_STRING_FIELD_EXTENDED (proxy_host) | |
| AST_STRING_FIELD_EXTENDED (proxy_password) | |
| AST_STRING_FIELD_EXTENDED (proxy_username) | |
| AST_STRING_FIELD_EXTENDED (uri_params) | |
| SORCERY_OBJECT (details) | |
Data Fields | |
| struct ast_string_field_mgr | __field_mgr |
| struct ast_string_field_pool * | __field_mgr_pool |
| const ast_string_field | ca_list_file |
| const ast_string_field | ca_list_path |
| const ast_string_field | cert_file |
| int | connect_timeout |
| enum ast_websocket_type | connection_type |
| int | invalid |
| enum ast_ws_client_fields | invalid_fields |
| const ast_string_field | password |
| unsigned int | pingpong_interval |
| unsigned int | pingpong_probes |
| int | pingpongs |
| const ast_string_field | priv_key_file |
| const ast_string_field | protocols |
| unsigned int | reconnect_attempts |
| unsigned int | reconnect_interval |
| unsigned int | tcp_keepalive_interval |
| unsigned int | tcp_keepalive_probes |
| unsigned int | tcp_keepalive_time |
| int | tcp_keepalives |
| int | tls_enabled |
| const ast_string_field | uri |
| const ast_string_field | username |
| int | verify_server_cert |
| int | verify_server_hostname |
Detailed Description
Definition at line 76 of file websocket_client.h.
Member Function Documentation
◆ AST_STRING_FIELD_EXTENDED() [1/4]
| AST_STRING_FIELD_EXTENDED | ( | proxy_host | ) |
Proxy server URI
◆ AST_STRING_FIELD_EXTENDED() [2/4]
| AST_STRING_FIELD_EXTENDED | ( | proxy_password | ) |
Proxy password
◆ AST_STRING_FIELD_EXTENDED() [3/4]
| AST_STRING_FIELD_EXTENDED | ( | proxy_username | ) |
Proxy username
◆ AST_STRING_FIELD_EXTENDED() [4/4]
| AST_STRING_FIELD_EXTENDED | ( | uri_params | ) |
Additional URI parameters
◆ SORCERY_OBJECT()
| SORCERY_OBJECT | ( | details | ) |
Server URI Websocket protocols to use with server Auth user name Auth password CA file CA path Certificate file Private key file
Field Documentation
◆ __field_mgr
| struct ast_string_field_mgr __field_mgr |
Definition at line 87 of file websocket_client.h.
◆ __field_mgr_pool
| struct ast_string_field_pool* __field_mgr_pool |
Definition at line 87 of file websocket_client.h.
◆ ca_list_file
| const ast_string_field ca_list_file |
Definition at line 87 of file websocket_client.h.
Referenced by ast_websocket_client_connect().
◆ ca_list_path
| const ast_string_field ca_list_path |
Definition at line 87 of file websocket_client.h.
Referenced by ast_websocket_client_connect().
◆ cert_file
| const ast_string_field cert_file |
Definition at line 87 of file websocket_client.h.
Referenced by ast_websocket_client_connect().
◆ connect_timeout
| int connect_timeout |
Connection timeout (ms)
Definition at line 91 of file websocket_client.h.
Referenced by ast_websocket_client_connect().
◆ connection_type
| enum ast_websocket_type connection_type |
Connection type
Definition at line 90 of file websocket_client.h.
Referenced by ari_conf_get_owc_for_app(), ast_websocket_client_connect(), outbound_session_apply_config(), outbound_session_create(), show_owc_cb(), wc_apply(), websocket_client_connection_type_from_str(), and websocket_client_connection_type_to_str().
◆ invalid
| int invalid |
Invalid configuration
Definition at line 88 of file websocket_client.h.
◆ invalid_fields
| enum ast_ws_client_fields invalid_fields |
Invalid fields
Definition at line 89 of file websocket_client.h.
◆ password
| const ast_string_field password |
Definition at line 87 of file websocket_client.h.
Referenced by ast_websocket_client_connect().
◆ pingpong_interval
| unsigned int pingpong_interval |
Send WebSocket PINGs at this interval in seconds
Definition at line 106 of file websocket_client.h.
Referenced by ast_websocket_client_connect(), and wc_apply().
◆ pingpong_probes
| unsigned int pingpong_probes |
Close connection after this many missed PONG responses
Definition at line 107 of file websocket_client.h.
Referenced by ast_websocket_client_connect(), and wc_apply().
◆ pingpongs
| int pingpongs |
Enable WebSocket PING/PONGs
Definition at line 105 of file websocket_client.h.
Referenced by ast_websocket_client_connect(), and wc_apply().
◆ priv_key_file
| const ast_string_field priv_key_file |
Definition at line 87 of file websocket_client.h.
Referenced by ast_websocket_client_connect().
◆ protocols
| const ast_string_field protocols |
Definition at line 87 of file websocket_client.h.
Referenced by ast_websocket_client_connect().
◆ reconnect_attempts
| unsigned int reconnect_attempts |
How many attempts before returning an error
Definition at line 92 of file websocket_client.h.
Referenced by ast_websocket_client_connect(), and wc_apply().
◆ reconnect_interval
| unsigned int reconnect_interval |
How often to attempt a reconnect (ms)
Definition at line 93 of file websocket_client.h.
Referenced by ast_websocket_client_connect().
◆ tcp_keepalive_interval
| unsigned int tcp_keepalive_interval |
Send keepalives at this interval in seconds
Definition at line 103 of file websocket_client.h.
Referenced by ast_websocket_client_connect(), and wc_apply().
◆ tcp_keepalive_probes
| unsigned int tcp_keepalive_probes |
Close connection after this many missed responses
Definition at line 104 of file websocket_client.h.
Referenced by ast_websocket_client_connect(), and wc_apply().
◆ tcp_keepalive_time
| unsigned int tcp_keepalive_time |
Start sending when connection has been idle for this many seconds
Definition at line 102 of file websocket_client.h.
Referenced by ast_websocket_client_connect(), and wc_apply().
◆ tcp_keepalives
| int tcp_keepalives |
Enable TCP Keepalives
Definition at line 101 of file websocket_client.h.
Referenced by ast_websocket_client_connect(), and wc_apply().
◆ tls_enabled
| int tls_enabled |
TLS enabled
Definition at line 94 of file websocket_client.h.
Referenced by ast_websocket_client_connect().
◆ uri
| const ast_string_field uri |
Definition at line 87 of file websocket_client.h.
Referenced by ast_websocket_client_connect(), show_owc_cb(), and wc_apply().
◆ username
| const ast_string_field username |
Definition at line 87 of file websocket_client.h.
Referenced by ast_websocket_client_connect().
◆ verify_server_cert
| int verify_server_cert |
Verify server certificate
Definition at line 95 of file websocket_client.h.
Referenced by ast_websocket_client_connect().
◆ verify_server_hostname
| int verify_server_hostname |
Verify server hostname
Definition at line 96 of file websocket_client.h.
Referenced by ast_websocket_client_connect().
The documentation for this struct was generated from the following file:
