Options used for a websocket client. More...
#include <http_websocket.h>
Data Fields | |
| const char * | password |
| unsigned int | pingpong_interval |
| unsigned int | pingpong_probes |
| int | pingpongs |
| const char * | protocols |
| const char * | proxy_host |
| const char * | proxy_password |
| const char * | proxy_username |
| int | suppress_connection_msgs |
| unsigned int | tcp_keepalive_interval |
| unsigned int | tcp_keepalive_probes |
| unsigned int | tcp_keepalive_time |
| int | tcp_keepalives |
| int | timeout |
| struct ast_tls_config * | tls_cfg |
| const char * | uri |
| const char * | username |
Detailed Description
Options used for a websocket client.
Definition at line 503 of file http_websocket.h.
Field Documentation
◆ password
| const char* password |
WebSocket server auth password
Definition at line 529 of file http_websocket.h.
Referenced by client_options_clone(), and client_options_destroy().
◆ pingpong_interval
| unsigned int pingpong_interval |
Send PING messages at this interval in seconds
Definition at line 549 of file http_websocket.h.
Referenced by ast_websocket_client_create_with_options().
◆ pingpong_probes
| unsigned int pingpong_probes |
Close connection after this many missed responses
Definition at line 550 of file http_websocket.h.
◆ pingpongs
| int pingpongs |
WebSocket PING/PONG Enable Websocket PING/PONGs
Definition at line 548 of file http_websocket.h.
Referenced by ast_websocket_client_create_with_options().
◆ protocols
| const char* protocols |
A comma separated string of supported protocols
Definition at line 517 of file http_websocket.h.
Referenced by ast_websocket_client_create(), client_options_clone(), and client_options_destroy().
◆ proxy_host
| const char* proxy_host |
Forward proxy Proxy server host:port
Definition at line 535 of file http_websocket.h.
Referenced by client_options_clone(), client_options_destroy(), websocket_client_args_create(), websocket_client_connect(), websocket_client_create(), websocket_client_handle_response_code(), websocket_client_handshake_get_response(), and websocket_proxy_handshake().
◆ proxy_password
| const char* proxy_password |
Proxy server auth password
Definition at line 537 of file http_websocket.h.
Referenced by client_options_clone(), and client_options_destroy().
◆ proxy_username
| const char* proxy_username |
Proxy server auth username
Definition at line 536 of file http_websocket.h.
Referenced by client_options_clone(), and client_options_destroy().
◆ suppress_connection_msgs
| int suppress_connection_msgs |
Suppress connection log messages
Definition at line 531 of file http_websocket.h.
◆ tcp_keepalive_interval
| unsigned int tcp_keepalive_interval |
Send keepalives at this interval in seconds
Definition at line 543 of file http_websocket.h.
◆ tcp_keepalive_probes
| unsigned int tcp_keepalive_probes |
Close connection after this many missed responses
Definition at line 544 of file http_websocket.h.
◆ tcp_keepalive_time
| unsigned int tcp_keepalive_time |
Start sending when connection has been idle for this many seconds
Definition at line 542 of file http_websocket.h.
◆ tcp_keepalives
| int tcp_keepalives |
TCP Keepalives Enable TCP keepalives
Definition at line 541 of file http_websocket.h.
Referenced by ast_websocket_client_create_with_options().
◆ timeout
| int timeout |
Optional connection timeout
How long (in milliseconds) to attempt to connect (-1 equals infinite)
Definition at line 523 of file http_websocket.h.
Referenced by websocket_client_start_handshake_timer(), and websocket_connect().
◆ tls_cfg
| struct ast_tls_config* tls_cfg |
Secure websocket credentials
Definition at line 527 of file http_websocket.h.
Referenced by ast_websocket_client_create(), client_options_clone(), and client_options_destroy().
◆ uri
| const char* uri |
The URI to connect to
Expected uri form:
ws[s]://<address>[:port][/<path>]
The address (can be a host name) and port are parsed out and used to connect to the remote server. If multiple IPs are returned during address resolution then the first one is chosen.
Definition at line 513 of file http_websocket.h.
Referenced by ast_websocket_client_connect(), ast_websocket_client_create(), ast_websocket_client_create_with_options(), client_options_clone(), client_options_destroy(), websocket_client_destroy(), websocket_client_handshake(), websocket_client_handshake_get_response(), websocket_connect(), and websocket_proxy_handshake().
◆ username
| const char* username |
WebSocket server auth username
Definition at line 528 of file http_websocket.h.
Referenced by client_options_clone(), and client_options_destroy().
The documentation for this struct was generated from the following file:
