Options used for a websocket client. More...
#include <http_websocket.h>
Data Fields | |
| const char * | password |
| const char * | protocols |
| int | suppress_connection_msgs |
| 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 475 of file http_websocket.h.
Field Documentation
◆ password
| const char* password |
Auth password
Definition at line 501 of file http_websocket.h.
◆ protocols
| const char* protocols |
A comma separated string of supported protocols
Definition at line 489 of file http_websocket.h.
Referenced by ast_websocket_client_create().
◆ suppress_connection_msgs
| int suppress_connection_msgs |
Suppress connection log messages
Definition at line 502 of file http_websocket.h.
◆ timeout
| int timeout |
Optional connection timeout
How long (in milliseconds) to attempt to connect (-1 equals infinite)
Definition at line 495 of file http_websocket.h.
Referenced by websocket_connect().
◆ tls_cfg
| struct ast_tls_config* tls_cfg |
Secure websocket credentials
Definition at line 499 of file http_websocket.h.
Referenced by ast_websocket_client_create().
◆ 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 485 of file http_websocket.h.
Referenced by ast_websocket_client_connect(), ast_websocket_client_create(), and websocket_connect().
◆ username
| const char* username |
Auth username
Definition at line 500 of file http_websocket.h.
The documentation for this struct was generated from the following file:
