Asterisk - The Open Source Telephony Project GIT-master-25686a5
Data Fields
ast_websocket_client_options Struct Reference

Options used for a websocket client. More...

#include <http_websocket.h>

Collaboration diagram for ast_websocket_client_options:
Collaboration graph
[legend]

Data Fields

const char * protocols
 
int timeout
 
struct ast_tls_configtls_cfg
 
const char * uri
 

Detailed Description

Options used for a websocket client.

Definition at line 446 of file http_websocket.h.

Field Documentation

◆ protocols

const char* protocols

A comma separated string of supported protocols

Definition at line 460 of file http_websocket.h.

Referenced by ast_websocket_client_create().

◆ timeout

int timeout

Optional connection timeout

How long (in milliseconds) to attempt to connect (-1 equals infinite)

Definition at line 466 of file http_websocket.h.

Referenced by websocket_connect().

◆ tls_cfg

struct ast_tls_config* tls_cfg

Secure websocket credentials

Definition at line 470 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 456 of file http_websocket.h.

Referenced by ast_websocket_client_create(), and websocket_connect().


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