dd/d14/res__websocket__client_8c_source.html

/*

 * Asterisk -- An open source telephony toolkit.

 *

 * Copyright (C) 2025, Sangoma Technologies Corporation

 *

 * George Joseph <gjoseph@sangoma.com>

 *

 * See http://www.asterisk.org for more information about

 * the Asterisk project. Please do not directly contact

 * any of the maintainers of this project for assistance;

 * the project provides a web site, mailing lists and IRC

 * channels for your use.

 *

 * This program is free software, distributed under the terms of

 * the GNU General Public License Version 2. See the LICENSE file

 * at the top of the source tree.

 */


/*** MODULEINFO

    <support_level>core</support_level>

 ***/


/*** DOCUMENTATION

    <configInfo name="res_websocket_client" language="en_US">

        <synopsis>Websocket Client Configuration</synopsis>

        <configFile name="websocket_client.conf">

            <configObject name="websocket_client">

                <since>

                    <version>20.15.0</version>

                    <version>21.10.0</version>

                    <version>22.5.0</version>

                </since>

                <synopsis>Websocket Client Configuration</synopsis>

                <see-also>

                    <ref type="link">/Configuration/Channel-Drivers/WebSocket/</ref>

                    <ref type="link">/Configuration/Interfaces/Asterisk-REST-Interface-ARI/ARI-Outbound-Websockets/</ref>

                </see-also>

                <description>

                    <para>

                    These config objects are currently shared by the following Asterisk capabilities:

                    </para>

                    <enumlist>

                            <enum name="chan_websocket"><para>The WebSocket channel driver.</para></enum>

                            <enum name="res_ari"><para>ARI Outbound WebSockets.</para></enum>

                    </enumlist>

                    <para>

                    They may have more specific information or restrictions on the parameters below.

                    </para>

                    <example title="websocket_client.conf">

;

; A connection for use by chan_websocket

[media_connection1]

type = websocket_client

uri = ws://localhost:8787

protocols = media

username = media_username

password = media_password

connection_type = per_call_config

connection_timeout = 500

reconnect_interval = 500

reconnect_attempts = 5

tls_enabled = no

;

; A TLS connection for use by ARI Outbound Websocket

[ari_connection1]

type = websocket_client

uri = wss://localhost:8765

protocols = ari

username = some_username

password = some_password

connection_type = persistent

connection_timeout = 500

reconnect_interval = 500

reconnect_attempts = 5

tls_enabled = yes

ca_list_file = /etc/pki/tls/cert.pem

verify_server_cert = no

verify_server_hostname = no

                    </example>

                </description>

                <configOption name="type">

                    <since>

                        <version>20.15.0</version>

                        <version>21.10.0</version>

                        <version>22.5.0</version>

                    </since>

                    <synopsis>Must be "websocket_client".</synopsis>

                </configOption>

                <configOption name="uri">

                    <since>

                        <version>20.15.0</version>

                        <version>21.10.0</version>

                        <version>22.5.0</version>

                    </since>

                    <synopsis>Full URI to remote server.</synopsis>

                </configOption>

                <configOption name="protocols">

                    <since>

                        <version>20.15.0</version>

                        <version>21.10.0</version>

                        <version>22.5.0</version>

                    </since>

                    <synopsis>Comma separated list of protocols acceptable to the server.</synopsis>

                </configOption>

                <configOption name="username">

                    <since>

                        <version>20.15.0</version>

                        <version>21.10.0</version>

                        <version>22.5.0</version>

                    </since>

                    <synopsis>Server authentication username if required.</synopsis>

                </configOption>

                <configOption name="password">

                    <since>

                        <version>20.15.0</version>

                        <version>21.10.0</version>

                        <version>22.5.0</version>

                    </since>

                    <synopsis>Server authentication password if required.</synopsis>

                </configOption>

                <configOption name="connection_type">

                    <since>

                        <version>20.15.0</version>

                        <version>21.10.0</version>

                        <version>22.5.0</version>

                    </since>

                    <synopsis>Single persistent connection or per-call configuration.</synopsis>

                    <description>

                    <enumlist>

                        <enum name="persistent"><para>Single persistent connection for all calls.</para></enum>

                        <enum name="per_call_config"><para>New connection for each call to the Stasis() dialplan app.</para></enum>

                    </enumlist>

                    </description>

                </configOption>

                <configOption name="connection_timeout">

                    <since>

                        <version>20.15.0</version>

                        <version>21.10.0</version>

                        <version>22.5.0</version>

                    </since>

                    <synopsis>Connection timeout (ms).</synopsis>

                    <description>

                        <para>

                            The maximum number of milliseconds to wait for a connection

                            to the WebSocket server to succeed. If the timer expires,

                            reconnection will be attempted based on the settings of the

                            <literal>reconnect_attempts</literal> and <literal>reconnect_interval</literal>

                            parameters.

                        </para>

                    </description>

                    <see-also>

                        <ref type="configOption">write_timeout</ref>

                        <ref type="configOption">reconnect_attempts</ref>

                        <ref type="configOption">reconnect_interval</ref>

                    </see-also>

                </configOption>

                <configOption name="reconnect_attempts">

                    <since>

                        <version>20.15.0</version>

                        <version>21.10.0</version>

                        <version>22.5.0</version>

                    </since>

                    <synopsis>On failure, how many times should reconnection be attempted?</synopsis>

                    <description>

                        <para>

                            For per_call connections, this is the number of

                            (re)connection attempts to make before returning an

                            and terminating the call.  Persistent connections

                            always retry forever but this setting will control

                            how often failure messages are logged.

                        </para>

                    </description>

                    <see-also>

                        <ref type="configOption">connection_timeout</ref>

                        <ref type="configOption">reconnect_interval</ref>

                    </see-also>

                </configOption>

                <configOption name="reconnect_interval">

                    <since>

                        <version>20.15.0</version>

                        <version>21.10.0</version>

                        <version>22.5.0</version>

                    </since>

                    <synopsis>How often should reconnection be attempted (ms)?</synopsis>

                    <see-also>

                        <ref type="configOption">connection_timeout</ref>

                        <ref type="configOption">reconnect_attempts</ref>

                    </see-also>

                </configOption>

                <configOption name="write_timeout">

                    <since>

                        <version>20.22.0</version>

                        <version>22.12.0</version>

                        <version>23.6.0</version>

                        <version>24.0.0</version>

                    </since>

                    <synopsis>Write timeout (ms).</synopsis>

                    <description>

                        <para>

                            The maximum number of milliseconds to wait for a write

                            to the WebSocket to succeed. If this connection is used

                            by chan_websocket, the WebSocket will be closed and the

                            channel hung up when the timeout is reached. The default

                            value is set by the module creating the client.

                        </para>

                        <note>

                            <para>

                            Success means the write request was accepted by the

                            operating system and does not imply the payload was

                            actually transmitted or received by the server.

                            </para>

                        </note>

                    </description>

                    <see-also>

                        <ref type="configOption">connection_timeout</ref>

                    </see-also>

                </configOption>

                <configOption name="tls_enabled">

                    <since>

                        <version>20.15.0</version>

                        <version>21.10.0</version>

                        <version>22.5.0</version>

                    </since>

                    <synopsis>Enable TLS</synopsis>

                </configOption>

                <configOption name="ca_list_file">

                    <since>

                        <version>20.15.0</version>

                        <version>21.10.0</version>

                        <version>22.5.0</version>

                    </since>

                    <synopsis>File containing the server's CA certificate. (optional)</synopsis>

                </configOption>

                <configOption name="ca_list_path">

                    <since>

                        <version>20.15.0</version>

                        <version>21.10.0</version>

                        <version>22.5.0</version>

                    </since>

                    <synopsis>Path to a directory containing one or more hashed CA certificates. (optional)</synopsis>

                </configOption>

                <configOption name="cert_file">

                    <since>

                        <version>20.15.0</version>

                        <version>21.10.0</version>

                        <version>22.5.0</version>

                    </since>

                    <synopsis>File containing a client certificate. (optional)</synopsis>

                </configOption>

                <configOption name="priv_key_file">

                    <since>

                        <version>20.15.0</version>

                        <version>21.10.0</version>

                        <version>22.5.0</version>

                    </since>

                    <synopsis>File containing the client's private key. (optional)</synopsis>

                </configOption>

                <configOption name="verify_server_cert">

                    <since>

                        <version>20.15.0</version>

                        <version>21.10.0</version>

                        <version>22.5.0</version>

                    </since>

                    <synopsis>If set to true, verify the server's certificate. (optional)</synopsis>

                </configOption>

                <configOption name="verify_server_hostname">

                    <since>

                        <version>20.15.0</version>

                        <version>21.10.0</version>

                        <version>22.5.0</version>

                    </since>

                    <synopsis>If set to true, verify that the server's hostname matches the common name in it's certificate. (optional)</synopsis>

                </configOption>

                <configOption name="proxy_host">

                    <since>

                        <version>20.21.0</version>

                        <version>22.11.0</version>

                        <version>23.5.0</version>

                    </since>

                    <synopsis>Proxy host including port for outbound proxy if required. (optional)</synopsis>

                    <description>

                        <para>

                            If an outbound proxy is required to reach the websocket server,

                            specify a host in the form <literal>&lt;host&gt;:&lt;port7gt;</literal>.

                            Currently only http (non-TLS) proxies are supported although the tunnelled

                            connection to the websocket server can have TLS enabled.

                        </para>

                    </description>

                </configOption>

                <configOption name="proxy_username">

                    <since>

                        <version>20.21.0</version>

                        <version>22.11.0</version>

                        <version>23.5.0</version>

                    </since>

                    <synopsis>Proxy authentication username if required. (optional)</synopsis>

                </configOption>

                <configOption name="proxy_password">

                    <since>

                        <version>20.21.0</version>

                        <version>22.11.0</version>

                        <version>23.5.0</version>

                    </since>

                    <synopsis>Proxy authentication password if required. (optional)</synopsis>

                </configOption>

                <configOption name="enable_tcp_keepalives">

                    <since>

                        <version>20.21.0</version>

                        <version>22.11.0</version>

                        <version>23.5.0</version>

                    </since>

                    <synopsis>Enable TCP Keepalives. (optional)</synopsis>

                </configOption>

                <configOption name="tcp_keepalive_time">

                    <since>

                        <version>20.21.0</version>

                        <version>22.11.0</version>

                        <version>23.5.0</version>

                    </since>

                    <synopsis>Start sending keepalives when no data has been sent for this many seconds. (optional)</synopsis>

                </configOption>

                <configOption name="tcp_keepalive_interval">

                    <since>

                        <version>20.21.0</version>

                        <version>22.11.0</version>

                        <version>23.5.0</version>

                    </since>

                    <synopsis>Send keepalives at this interval in seconds. (optional)</synopsis>

                    <description>

                        <para>

                            If a reply isn't received by the time the next keepalive is due

                            to be sent, it's considered missed so this option also controls

                            how long it takes to detect a failure.

                        </para>

                    </description>

                </configOption>

                <configOption name="tcp_keepalive_probes">

                    <since>

                        <version>20.21.0</version>

                        <version>22.11.0</version>

                        <version>23.5.0</version>

                    </since>

                    <synopsis>Close the connection after this many missed replies. (optional)</synopsis>

                    <description>

                        <para>

                            If a reply isn't received by the time the next keepalive is due

                            to be sent, it's considered missed.  The time to detect a failure

                            is therefore between (probes * interval) and

                            ((probes + 1) * interval) seconds. If the connection closes

                            and reconnect_interval reconnect_attempts are set, a new connection

                            will be attempted using those parameters.

                        </para>

                    </description>

                </configOption>

                <configOption name="enable_pingpongs">

                    <since>

                        <version>20.21.0</version>

                        <version>22.11.0</version>

                        <version>23.5.0</version>

                    </since>

                    <synopsis>Enable WebSocket PING/PONGs.. (optional)</synopsis>

                </configOption>

                <configOption name="pingpong_interval">

                    <since>

                        <version>20.21.0</version>

                        <version>22.11.0</version>

                        <version>23.5.0</version>

                    </since>

                    <synopsis>Send WebSocket PINGs at this interval in seconds. (optional)</synopsis>

                    <description>

                        <para>

                            If a reply isn't received by the time the next PING is due

                            to be sent, it's considered missed so this option also controls

                            how long it takes to detect a failure.

                        </para>

                    </description>

                </configOption>

                <configOption name="pingpong_probes">

                    <since>

                        <version>20.21.0</version>

                        <version>22.11.0</version>

                        <version>23.5.0</version>

                    </since>

                    <synopsis>Close the connection after this many missed PONG replies. (optional)</synopsis>

                    <description>

                        <para>

                            If a reply isn't received by the time the next PING is due

                            to be sent, it's considered missepingd.  The time to detect a failure

                            is therefore between (probes * interval) and

                            ((probes + 1) * interval) seconds. If the connection closes

                            and reconnect_interval reconnect_attempts are set, a new connection

                            will be attempted using those parameters.

                        </para>

                    </description>

                </configOption>

            </configObject>

        </configFile>

    </configInfo>

***/


#include "asterisk.h"


#include "asterisk/module.h"

#include "asterisk/astobj2.h"

#include "asterisk/strings.h"

#include "asterisk/vector.h"

#include "asterisk/websocket_client.h"


static struct ast_sorcery *sorcery = NULL;


void ast_websocket_client_add_uri_params(struct ast_websocket_client *wc,

    const char *uri_params)

{

    ast_string_field_set(wc, uri_params, uri_params);

}


struct ast_websocket *ast_websocket_client_connect(struct ast_websocket_client *wc,

    void *lock_obj, const char *display_name, enum ast_websocket_result *result)

{

    int reconnect_counter = wc->reconnect_attempts;

    char *uri = NULL;


    if (ast_strlen_zero(display_name)) {

        display_name = ast_sorcery_object_get_id(wc);

    }


    if (!ast_strlen_zero(wc->uri_params)) {

        /*

         * If the configured URI doesn't already contain parameters, we append the

         * new ones to the URI path component with '?'.  If it does, we append the

         * new ones to the existing ones with a '&'.

         */

        char sep = '?';

        uri = ast_alloca(strlen(wc->uri) + strlen(wc->uri_params) + 2);

        if (strchr(wc->uri, '?')) {

            sep = '&';

        }

        sprintf(uri, "%s%c%s", wc->uri, sep, wc->uri_params); /*Safe */

    }


    while (1) {

        struct ast_websocket *astws = NULL;

        struct ast_websocket_client_options options = {

            .uri = S_OR(uri, wc->uri),

            .protocols = wc->protocols,

            .username = wc->username,

            .password = wc->password,

            .timeout = wc->connect_timeout,

            .write_timeout = wc->write_timeout != INT_MAX ? wc->write_timeout : AST_DEFAULT_WEBSOCKET_WRITE_TIMEOUT,

            .suppress_connection_msgs = 1,

            .proxy_host = wc->proxy_host,

            .proxy_username = wc->proxy_username,

            .proxy_password = wc->proxy_password,

            .tcp_keepalives = wc->tcp_keepalives,

            .tcp_keepalive_time = wc->tcp_keepalive_time,

            .tcp_keepalive_interval = wc->tcp_keepalive_interval,

            .tcp_keepalive_probes = wc->tcp_keepalive_probes,

            .pingpongs = wc->pingpongs,

            .pingpong_interval = wc->pingpong_interval,

            .pingpong_probes = wc->pingpong_probes,

            .tls_cfg = NULL,

        };


        if (lock_obj) {

            ao2_lock(lock_obj);

        }


        if (wc->tls_enabled) {

            /*

             * tls_cfg and its contents are freed automatically

             * by res_http_websocket when the connection ends.

             * We create it even if tls is not enabled to we can

             * suppress connection error messages and print our own.

             */

            options.tls_cfg = ast_calloc(1, sizeof(*options.tls_cfg));

            if (!options.tls_cfg) {

                if (lock_obj) {

                    ao2_unlock(lock_obj);

                }

                return NULL;

            }

            /* TLS options */

            options.tls_cfg->enabled = wc->tls_enabled;

            options.tls_cfg->cafile = ast_strdup(wc->ca_list_file);

            options.tls_cfg->capath = ast_strdup(wc->ca_list_path);

            options.tls_cfg->certfile = ast_strdup(wc->cert_file);

            options.tls_cfg->pvtfile = ast_strdup(wc->priv_key_file);

            ast_set2_flag(&options.tls_cfg->flags, !wc->verify_server_cert, AST_SSL_DONT_VERIFY_SERVER);

            ast_set2_flag(&options.tls_cfg->flags, !wc->verify_server_hostname, AST_SSL_IGNORE_COMMON_NAME);

        }


        astws = ast_websocket_client_create_with_options(&options, result);

        if (astws && *result == WS_OK) {

            if (lock_obj) {

                ao2_unlock(lock_obj);

            }

            return astws;

        }


        reconnect_counter--;

        if (reconnect_counter <= 0) {

            if (wc->connection_type == AST_WS_TYPE_CLIENT_PERSISTENT) {

                ast_log(LOG_WARNING,

                    "%s: Websocket connection to %s failed after %d tries: %s%s%s%s.  Retrying in %d ms.\n",

                    display_name,

                    wc->uri,

                    wc->reconnect_attempts,

                    ast_websocket_result_to_str(*result),

                    errno ? " (" : "",

                    errno ? strerror(errno) : "",

                    errno ? ")" : "",

                    wc->reconnect_interval

                );

            } else {

                ast_log(LOG_WARNING,

                    "%s: Websocket connection to %s failed after %d tries: %s%s%s%s.  Hanging up after exhausting retries.\n",

                    display_name,

                    wc->uri,

                    wc->reconnect_attempts,

                    ast_websocket_result_to_str(*result),

                    errno ? " (" : "",

                    errno ? strerror(errno) : "",

                    errno ? ")" : ""

                );

            }

            break;

        }


        if (lock_obj) {

            ao2_unlock(lock_obj);

        }

        usleep(wc->reconnect_interval * 1000);

    }


    if (lock_obj) {

        ao2_unlock(lock_obj);

    }


    return NULL;

}


static void wc_dtor(void *obj)

{

    struct ast_websocket_client *wc = obj;


    ast_debug(3, "%s: Disposing of websocket client config\n",

        ast_sorcery_object_get_id(wc));

    ast_string_field_free_memory(wc);

}


static void *wc_alloc(const char *id)

{

    struct ast_websocket_client *wc = NULL;


    wc = ast_sorcery_generic_alloc(sizeof(*wc), wc_dtor);

    if (!wc) {

        return NULL;

    }


    if (ast_string_field_init(wc, 1024) != 0) {

        ao2_cleanup(wc);

        return NULL;

    }


    if (ast_string_field_init_extended(wc, uri_params) != 0) {

        ao2_cleanup(wc);

        return NULL;

    }


    if (ast_string_field_init_extended(wc, proxy_host) != 0) {

        ao2_cleanup(wc);

        return NULL;

    }


    if (ast_string_field_init_extended(wc, proxy_username) != 0) {

        ao2_cleanup(wc);

        return NULL;

    }


    if (ast_string_field_init_extended(wc, proxy_password) != 0) {

        ao2_cleanup(wc);

        return NULL;

    }


    ast_debug(2, "%s: Allocated websocket client config\n", id);

    return wc;

}


static int websocket_client_connection_type_from_str(const struct aco_option *opt,

    struct ast_variable *var, void *obj)

{

    struct ast_websocket_client *ws = obj;


    if (strcasecmp(var->value, "persistent") == 0) {

        ws->connection_type = AST_WS_TYPE_CLIENT_PERSISTENT;

    } else if (strcasecmp(var->value, "per_call_config") == 0) {

        ws->connection_type = AST_WS_TYPE_CLIENT_PER_CALL_CONFIG;

    } else {

        return -1;

    }


    return 0;

}


static int websocket_client_connection_type_to_str(const void *obj, const intptr_t *args, char **buf)

{

    const struct ast_websocket_client *wc = obj;


    if (wc->connection_type ==  AST_WS_TYPE_CLIENT_PERSISTENT) {

        *buf = ast_strdup("persistent");

    } else if (wc->connection_type == AST_WS_TYPE_CLIENT_PER_CALL_CONFIG) {

        *buf = ast_strdup("per_call_config");

    } else {

        return -1;

    }


    return 0;

}


/*

 * Can't use INT_MIN because it's an expression

 * and macro substitutions using stringify can't

 * handle that.

 */

#define DEFAULT_RECONNECT_ATTEMPTS -2147483648


static int wc_apply(const struct ast_sorcery *sorcery, void *obj)

{

    struct ast_websocket_client *wc = obj;

    const char *id = ast_sorcery_object_get_id(wc);

    int res = 0;


    ast_debug(3, "%s: Applying config\n", id);


    if (ast_strlen_zero(wc->uri)) {

        ast_log(LOG_WARNING, "%s: Websocket client missing uri\n", id);

        res = -1;

    }


    if (!ast_strlen_zero(wc->proxy_host)) {

        char *host = NULL;

        char *port = NULL;

        char *s = ast_strdupa(wc->proxy_host);

        if (!ast_sockaddr_split_hostport(s, &host, &port, PARSE_PORT_REQUIRE)) {

            ast_log(LOG_WARNING, "%s: proxy_host '%s' is missing a port\n", id, wc->proxy_host);

            res = -1;

        }

    }


    if (wc->tcp_keepalives) {

        if (!wc->tcp_keepalive_time || !wc->tcp_keepalive_interval || !wc->tcp_keepalive_probes) {

            ast_log(LOG_WARNING, "%s: tcp_keepalive_time, tcp_keepalive_interval and tcp_keepalive_probes must all be non-zero\n", id);

            res = -1;

        }

    }


    if (wc->pingpongs) {

        if (!wc->pingpong_interval || !wc->pingpong_probes) {

            ast_log(LOG_WARNING, "%s: pingpong_interval and pingpong_probes must be non-zero\n", id);

            res = -1;

        }

    }


    if (wc->write_timeout <= 0) {

        ast_log(LOG_WARNING, "The write_timeout parameter must be > 0\n");

        res = -1;

    }


    if (res != 0) {

        ast_log(LOG_WARNING, "%s: Websocket client configuration failed\n", id);

    } else {

        ast_debug(3, "%s: Websocket client configuration succeeded\n", id);


        if (wc->reconnect_attempts == DEFAULT_RECONNECT_ATTEMPTS) {

            if (wc->connection_type == AST_WS_TYPE_CLIENT_PERSISTENT) {

                wc->reconnect_attempts = INT_MAX;

            } else {

                wc->reconnect_attempts = 4;

            }

        }

    }


    return res;

}


struct ao2_container *ast_websocket_client_retrieve_all(void)

{

    if (!sorcery) {

        return NULL;

    }


    return ast_sorcery_retrieve_by_fields(sorcery, "websocket_client",

        AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL);

}


struct ast_websocket_client *ast_websocket_client_retrieve_by_id(const char *id)

{

    if (!sorcery) {

        return NULL;

    }


    return ast_sorcery_retrieve_by_id(sorcery, "websocket_client", id);

}


enum ast_ws_client_fields ast_websocket_client_get_field_diff(

    struct ast_websocket_client *old_wc,

    struct ast_websocket_client *new_wc)

{

    enum ast_ws_client_fields changed = AST_WS_CLIENT_FIELD_NONE;

    const char *new_id = ast_sorcery_object_get_id(new_wc);

    RAII_VAR(struct ast_variable *, changes, NULL, ast_variables_destroy);

    struct ast_variable *v = NULL;

    int res = 0;

    int changes_found = 0;


    ast_debug(2, "%s: Detecting changes\n", new_id);


    res = ast_sorcery_diff(sorcery, old_wc, new_wc, &changes);

    if (res != 0) {

        ast_log(LOG_WARNING, "%s: Failed to create changeset\n", new_id);

        return AST_WS_CLIENT_FIELD_NONE;

    }


    for (v = changes; v; v = v->next) {

        changes_found = 1;

        ast_debug(2, "%s: %s changed to %s\n", new_id, v->name, v->value);

        if (ast_strings_equal(v->name, "connection_type")) {

            changed |= AST_WS_CLIENT_FIELD_CONNECTION_TYPE;

        } else if (ast_strings_equal(v->name, "uri")) {

            changed |= AST_WS_CLIENT_FIELD_URI;

        } else if (ast_strings_equal(v->name, "protocols")) {

            changed |= AST_WS_CLIENT_FIELD_PROTOCOLS;

        } else if (ast_strings_equal(v->name, "username")) {

            changed |= AST_WS_CLIENT_FIELD_USERNAME;

        } else if (ast_strings_equal(v->name, "password")) {

            changed |= AST_WS_CLIENT_FIELD_PASSWORD;

        } else if (ast_strings_equal(v->name, "tls_enabled")) {

            changed |= AST_WS_CLIENT_FIELD_TLS_ENABLED;

        } else if (ast_strings_equal(v->name, "ca_list_file")) {

            changed |= AST_WS_CLIENT_FIELD_CA_LIST_FILE;

        } else if (ast_strings_equal(v->name, "ca_list_path")) {

            changed |= AST_WS_CLIENT_FIELD_CA_LIST_PATH;

        } else if (ast_strings_equal(v->name, "cert_file")) {

            changed |= AST_WS_CLIENT_FIELD_CERT_FILE;

        } else if (ast_strings_equal(v->name, "priv_key_file")) {

            changed |= AST_WS_CLIENT_FIELD_PRIV_KEY_FILE;

        } else if (ast_strings_equal(v->name, "reconnect_interval")) {

            changed |= AST_WS_CLIENT_FIELD_RECONNECT_INTERVAL;

        } else if (ast_strings_equal(v->name, "reconnect_attempts")) {

            changed |= AST_WS_CLIENT_FIELD_RECONNECT_ATTEMPTS;

        } else if (ast_strings_equal(v->name, "connection_timeout")) {

            changed |= AST_WS_CLIENT_FIELD_CONNECTION_TIMEOUT;

        } else if (ast_strings_equal(v->name, "verify_server_cert")) {

            changed |= AST_WS_CLIENT_FIELD_VERIFY_SERVER_CERT;

        } else if (ast_strings_equal(v->name, "verify_server_hostname")) {

            changed |= AST_WS_CLIENT_FIELD_VERIFY_SERVER_HOSTNAME;

        } else if (ast_strings_equal(v->name, "proxy_host")) {

            changed |= AST_WS_CLIENT_FIELD_PROXY_HOST;

        } else if (ast_strings_equal(v->name, "proxy_username")) {

            changed |= AST_WS_CLIENT_FIELD_PROXY_USERNAME;

        } else if (ast_strings_equal(v->name, "proxy_password")) {

            changed |= AST_WS_CLIENT_FIELD_PROXY_PASSWORD;

        } else if (ast_strings_equal(v->name, "enable_tcp_keepalives")) {

            changed |= AST_WS_CLIENT_FIELD_TCP_KEEPALIVES;

        } else if (ast_strings_equal(v->name, "tcp_keepalive_time")) {

            changed |= AST_WS_CLIENT_FIELD_TCP_KEEPALIVE_TIME;

        } else if (ast_strings_equal(v->name, "tcp_keepalive_interval")) {

            changed |= AST_WS_CLIENT_FIELD_TCP_KEEPALIVE_INTERVAL;

        } else if (ast_strings_equal(v->name, "tcp_keepalive_probes")) {

            changed |= AST_WS_CLIENT_FIELD_TCP_KEEPALIVE_PROBES;

        } else if (ast_strings_equal(v->name, "enable_pingpongs")) {

            changed |= AST_WS_CLIENT_FIELD_PINGPONGS;

        } else if (ast_strings_equal(v->name, "pingpong_interval")) {

            changed |= AST_WS_CLIENT_FIELD_PINGPONG_INTERVAL;

        } else if (ast_strings_equal(v->name, "pingpong_probes")) {

            changed |= AST_WS_CLIENT_FIELD_PINGPONG_PROBES;

        } else if (ast_strings_equal(v->name, "write_timeout")) {

            changed |= AST_WS_CLIENT_FIELD_WRITE_TIMEOUT;

        } else {

            ast_debug(2, "%s: Unknown change %s\n", new_id, v->name);

        }

    }


    if (!changes_found) {

        ast_debug(2, "%s: No changes found %p %p\n", new_id,

            old_wc,new_wc);

    }

    return changed;


}


int ast_websocket_client_observer_add(const struct ast_sorcery_observer *callbacks)

{

    if (!sorcery || !callbacks) {

        return -1;

    }


    if (ast_sorcery_observer_add(sorcery, "websocket_client", callbacks)) {

        ast_log(LOG_ERROR, "Failed to register websocket client observers\n");

        return -1;

    }


    return 0;

}


void ast_websocket_client_observer_remove(const struct ast_sorcery_observer *callbacks)

{

    if (!sorcery || !callbacks) {

        return;

    }


    ast_sorcery_observer_remove(sorcery, "websocket_client", callbacks);

}


static int load_module(void)

{

    ast_debug(2, "Initializing Websocket Client Configuration\n");

    sorcery = ast_sorcery_open();

    if (!sorcery) {

        ast_log(LOG_ERROR, "Failed to open sorcery\n");

        return -1;

    }


    ast_sorcery_apply_default(sorcery, "websocket_client", "config",

        "websocket_client.conf,criteria=type=websocket_client");


    if (ast_sorcery_object_register(sorcery, "websocket_client", wc_alloc,

        NULL, wc_apply)) {

        ast_log(LOG_ERROR, "Failed to register websocket_client object with sorcery\n");

        ast_sorcery_unref(sorcery);

        sorcery = NULL;

        return -1;

    }


    ast_sorcery_object_field_register(sorcery, "websocket_client", "type", "", OPT_NOOP_T, 0, 0);

    ast_sorcery_register_cust(websocket_client, connection_type, "");

    ast_sorcery_register_sf(websocket_client, ast_websocket_client, uri, uri, "");

    ast_sorcery_register_sf(websocket_client, ast_websocket_client, protocols, protocols, "");

    ast_sorcery_register_sf(websocket_client, ast_websocket_client, username, username, "");

    ast_sorcery_register_sf(websocket_client, ast_websocket_client, password, password, "");

    ast_sorcery_register_sf(websocket_client, ast_websocket_client, ca_list_file, ca_list_file, "");

    ast_sorcery_register_sf(websocket_client, ast_websocket_client, ca_list_path, ca_list_path, "");

    ast_sorcery_register_sf(websocket_client, ast_websocket_client, cert_file, cert_file, "");

    ast_sorcery_register_sf(websocket_client, ast_websocket_client, priv_key_file, priv_key_file, "");

    ast_sorcery_register_bool(websocket_client, ast_websocket_client, tls_enabled, tls_enabled, "no");

    ast_sorcery_register_bool(websocket_client, ast_websocket_client, verify_server_cert, verify_server_cert, "yes");

    ast_sorcery_register_bool(websocket_client, ast_websocket_client, verify_server_hostname, verify_server_hostname, "yes");

    ast_sorcery_register_int(websocket_client, ast_websocket_client, connection_timeout, connect_timeout, 500);

    ast_sorcery_register_int(websocket_client, ast_websocket_client, reconnect_attempts, reconnect_attempts, 4);

    ast_sorcery_register_int(websocket_client, ast_websocket_client, reconnect_interval, reconnect_interval, 500);

    ast_sorcery_register_sf(websocket_client, ast_websocket_client, proxy_host, proxy_host, "");

    ast_sorcery_register_sf(websocket_client, ast_websocket_client, proxy_username, proxy_username, "");

    ast_sorcery_register_sf(websocket_client, ast_websocket_client, proxy_password, proxy_password, "");

    ast_sorcery_register_bool(websocket_client, ast_websocket_client, enable_tcp_keepalives, tcp_keepalives, "no");

    ast_sorcery_register_uint(websocket_client, ast_websocket_client, tcp_keepalive_time, tcp_keepalive_time, 20);

    ast_sorcery_register_uint(websocket_client, ast_websocket_client, tcp_keepalive_interval, tcp_keepalive_interval, 20);

    ast_sorcery_register_uint(websocket_client, ast_websocket_client, tcp_keepalive_probes, tcp_keepalive_probes, 3);

    ast_sorcery_register_bool(websocket_client, ast_websocket_client, enable_pingpongs, pingpongs, "no");

    ast_sorcery_register_uint(websocket_client, ast_websocket_client, pingpong_interval, pingpong_interval, 20);

    ast_sorcery_register_uint(websocket_client, ast_websocket_client, pingpong_probes, pingpong_probes, 3);

    /*

     * The default for write_timeout needs to be INT_MAX so we can tell that it's not set.

     * This allows the modules using this capability to apply their own default value.

     */

    ast_sorcery_register_int(websocket_client, ast_websocket_client, write_timeout, write_timeout, INT_MAX);


    ast_sorcery_load(sorcery);


    return 0;

}


static int reload_module(void)

{

    ast_debug(2, "Reloading Websocket Client Configuration\n");

    ast_sorcery_reload(sorcery);


    return 0;

}


int ast_websocket_client_reload(void)

{

    ast_debug(2, "Reloading Websocket Client Configuration\n");

    if (sorcery) {

        ast_sorcery_reload(sorcery);

    }


    return 0;

}


static int unload_module(void)

{

    ast_debug(2, "Unloading Websocket Client Configuration\n");

    if (sorcery) {

        ast_sorcery_unref(sorcery);

        sorcery = NULL;

    }

    return 0;

}


AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_GLOBAL_SYMBOLS | AST_MODFLAG_LOAD_ORDER, "WebSocket Client Support",

    .support_level = AST_MODULE_SUPPORT_CORE,

    .load = load_module,

    .unload = unload_module,

    .reload = reload_module,

    .load_pri = AST_MODPRI_CHANNEL_DEPEND,

    .requires = "res_http_websocket",

);

var
#define var
Definition ast_expr2f.c:605

asterisk.h
Asterisk main include file. File version handling, generic pbx functions.

ast_alloca
#define ast_alloca(size)
call __builtin_alloca to ensure we get gcc builtin semantics
Definition astmm.h:288

ast_strdup
#define ast_strdup(str)
A wrapper for strdup()
Definition astmm.h:241

ast_strdupa
#define ast_strdupa(s)
duplicate a string in memory from the stack
Definition astmm.h:298

ast_calloc
#define ast_calloc(num, len)
A wrapper for calloc()
Definition astmm.h:202

ast_log
#define ast_log
Definition astobj2.c:42

astobj2.h

ao2_cleanup
#define ao2_cleanup(obj)
Definition astobj2.h:1934

ao2_unlock
#define ao2_unlock(a)
Definition astobj2.h:729

ao2_lock
#define ao2_lock(a)
Definition astobj2.h:717

result
static PGresult * result
Definition cel_pgsql.c:84

OPT_NOOP_T
@ OPT_NOOP_T
Type for a default handler that should do nothing.
Definition config_options.h:399

buf
char buf[BUFSIZE]
Definition eagi_proxy.c:66

ast_websocket_result
ast_websocket_result
Result code for a websocket client.
Definition http_websocket.h:448

WS_OK
@ WS_OK
Definition http_websocket.h:449

ast_websocket_client_create_with_options
struct ast_websocket *AST_OPTIONAL_API_NAME() ast_websocket_client_create_with_options(struct ast_websocket_client_options *options, enum ast_websocket_result *result)
Create, and connect, a websocket client using given options.
Definition res_http_websocket.c:2008

AST_DEFAULT_WEBSOCKET_WRITE_TIMEOUT
#define AST_DEFAULT_WEBSOCKET_WRITE_TIMEOUT
Default websocket write timeout, in ms.
Definition http_websocket.h:28

AST_WS_TYPE_CLIENT_PER_CALL_CONFIG
@ AST_WS_TYPE_CLIENT_PER_CALL_CONFIG
Definition http_websocket.h:59

AST_WS_TYPE_CLIENT_PERSISTENT
@ AST_WS_TYPE_CLIENT_PERSISTENT
Definition http_websocket.h:58

ast_websocket_result_to_str
const char *AST_OPTIONAL_API_NAME() ast_websocket_result_to_str(enum ast_websocket_result result)
Convert a websocket result code to a string.
Definition res_http_websocket.c:2131

PARSE_PORT_REQUIRE
@ PARSE_PORT_REQUIRE
Definition include/asterisk/config.h:1219

ast_variables_destroy
void ast_variables_destroy(struct ast_variable *var)
Free variable list.
Definition extconf.c:1260

ast_debug
#define ast_debug(level,...)
Log a DEBUG message.
Definition include/asterisk/logger.h:456

LOG_ERROR
#define LOG_ERROR
Definition include/asterisk/logger.h:291

LOG_WARNING
#define LOG_WARNING
Definition include/asterisk/logger.h:280

errno
int errno

module.h
Asterisk module definitions.

AST_MODFLAG_LOAD_ORDER
@ AST_MODFLAG_LOAD_ORDER
Definition module.h:331

AST_MODFLAG_GLOBAL_SYMBOLS
@ AST_MODFLAG_GLOBAL_SYMBOLS
Definition module.h:330

AST_MODULE_INFO
#define AST_MODULE_INFO(keystr, flags_to_set, desc, fields...)
Definition module.h:557

AST_MODPRI_CHANNEL_DEPEND
@ AST_MODPRI_CHANNEL_DEPEND
Definition module.h:340

AST_MODULE_SUPPORT_CORE
@ AST_MODULE_SUPPORT_CORE
Definition module.h:121

ASTERISK_GPL_KEY
#define ASTERISK_GPL_KEY
The text the key() function should return.
Definition module.h:46

ast_sockaddr_split_hostport
int ast_sockaddr_split_hostport(char *str, char **host, char **port, int flags)
Splits a string into its host and port components.
Definition netsock2.c:164

reload
static int reload(void)
Definition res_config_mysql.c:1186

callbacks
struct @510 callbacks

args
static struct @523 args

websocket_client_connection_type_to_str
static int websocket_client_connection_type_to_str(const void *obj, const intptr_t *args, char **buf)
Definition res_websocket_client.c:608

ast_websocket_client_add_uri_params
void ast_websocket_client_add_uri_params(struct ast_websocket_client *wc, const char *uri_params)
Add additional parameters to the URI.
Definition res_websocket_client.c:412

ast_websocket_client_retrieve_all
struct ao2_container * ast_websocket_client_retrieve_all(void)
Retrieve a container of all websocket client objects.
Definition res_websocket_client.c:689

ast_websocket_client_reload
int ast_websocket_client_reload(void)
Force res_websocket_client to reload its configuration.
Definition res_websocket_client.c:884

wc_alloc
static void * wc_alloc(const char *id)
Definition res_websocket_client.c:554

ast_websocket_client_get_field_diff
enum ast_ws_client_fields ast_websocket_client_get_field_diff(struct ast_websocket_client *old_wc, struct ast_websocket_client *new_wc)
Detect changes between two websocket client configurations.
Definition res_websocket_client.c:708

wc_apply
static int wc_apply(const struct ast_sorcery *sorcery, void *obj)
Definition res_websocket_client.c:630

ast_websocket_client_retrieve_by_id
struct ast_websocket_client * ast_websocket_client_retrieve_by_id(const char *id)
Retrieve a websocket client object by ID.
Definition res_websocket_client.c:699

reload_module
static int reload_module(void)
Definition res_websocket_client.c:876

sorcery
static struct ast_sorcery * sorcery
Definition res_websocket_client.c:410

websocket_client_connection_type_from_str
static int websocket_client_connection_type_from_str(const struct aco_option *opt, struct ast_variable *var, void *obj)
Definition res_websocket_client.c:592

load_module
static int load_module(void)
Definition res_websocket_client.c:819

DEFAULT_RECONNECT_ATTEMPTS
#define DEFAULT_RECONNECT_ATTEMPTS
Definition res_websocket_client.c:628

ast_websocket_client_observer_remove
void ast_websocket_client_observer_remove(const struct ast_sorcery_observer *callbacks)
Remove sorcery observers for websocket client events.
Definition res_websocket_client.c:809

ast_websocket_client_observer_add
int ast_websocket_client_observer_add(const struct ast_sorcery_observer *callbacks)
Add sorcery observers for websocket client events.
Definition res_websocket_client.c:795

unload_module
static int unload_module(void)
Definition res_websocket_client.c:894

wc_dtor
static void wc_dtor(void *obj)
Definition res_websocket_client.c:545

ast_websocket_client_connect
struct ast_websocket * ast_websocket_client_connect(struct ast_websocket_client *wc, void *lock_obj, const char *display_name, enum ast_websocket_result *result)
Connect to a websocket server using the configured authentication, retry and TLS options.
Definition res_websocket_client.c:418

NULL
#define NULL
Definition resample.c:96

ast_sorcery_unref
#define ast_sorcery_unref(sorcery)
Decrease the reference count of a sorcery structure.
Definition sorcery.h:1500

ast_sorcery_object_get_id
const char * ast_sorcery_object_get_id(const void *object)
Get the unique identifier of a sorcery object.
Definition sorcery.c:2381

ast_sorcery_observer_remove
void ast_sorcery_observer_remove(const struct ast_sorcery *sorcery, const char *type, const struct ast_sorcery_observer *callbacks)
Remove an observer from a specific object type.
Definition sorcery.c:2487

ast_sorcery_register_cust
#define ast_sorcery_register_cust(object, option, def_value)
Register a custom field within an object.
Definition sorcery.h:1767

AST_RETRIEVE_FLAG_MULTIPLE
@ AST_RETRIEVE_FLAG_MULTIPLE
Return all matching objects.
Definition sorcery.h:120

AST_RETRIEVE_FLAG_ALL
@ AST_RETRIEVE_FLAG_ALL
Perform no matching, return all objects.
Definition sorcery.h:123

ast_sorcery_load
void ast_sorcery_load(const struct ast_sorcery *sorcery)
Inform any wizards to load persistent objects.
Definition sorcery.c:1441

ast_sorcery_register_uint
#define ast_sorcery_register_uint(object, structure, option, field, def_value)
Register an unsigned int field as type OPT_UINT_T within an object.
Definition sorcery.h:1728

ast_sorcery_diff
int ast_sorcery_diff(const struct ast_sorcery *sorcery, const void *original, const void *modified, struct ast_variable **changes)
Create a changeset of two objects.
Definition sorcery.c:1869

ast_sorcery_retrieve_by_id
void * ast_sorcery_retrieve_by_id(const struct ast_sorcery *sorcery, const char *type, const char *id)
Retrieve an object using its unique identifier.
Definition sorcery.c:1917

ast_sorcery_object_register
#define ast_sorcery_object_register(sorcery, type, alloc, transform, apply)
Register an object type.
Definition sorcery.h:837

ast_sorcery_reload
void ast_sorcery_reload(const struct ast_sorcery *sorcery)
Inform any wizards to reload persistent objects.
Definition sorcery.c:1472

ast_sorcery_observer_add
int ast_sorcery_observer_add(const struct ast_sorcery *sorcery, const char *type, const struct ast_sorcery_observer *callbacks)
Add an observer to a specific object type.
Definition sorcery.c:2455

ast_sorcery_generic_alloc
void * ast_sorcery_generic_alloc(size_t size, ao2_destructor_fn destructor)
Allocate a generic sorcery capable object.
Definition sorcery.c:1792

ast_sorcery_register_int
#define ast_sorcery_register_int(object, structure, option, field, def_value)
Register an int field as type OPT_INT_T within an object.
Definition sorcery.h:1710

ast_sorcery_object_field_register
#define ast_sorcery_object_field_register(sorcery, type, name, default_val, opt_type, flags,...)
Register a field within an object.
Definition sorcery.h:955

ast_sorcery_apply_default
#define ast_sorcery_apply_default(sorcery, type, name, data)
Definition sorcery.h:476

ast_sorcery_register_bool
#define ast_sorcery_register_bool(object, structure, option, field, def_value)
Register a boolean field as type OPT_YESNO_T within an object.
Definition sorcery.h:1684

ast_sorcery_open
#define ast_sorcery_open()
Open a new sorcery structure.
Definition sorcery.h:406

ast_sorcery_retrieve_by_fields
void * ast_sorcery_retrieve_by_fields(const struct ast_sorcery *sorcery, const char *type, unsigned int flags, struct ast_variable *fields)
Retrieve an object or multiple objects using specific fields.
Definition sorcery.c:1961

ast_sorcery_register_sf
#define ast_sorcery_register_sf(object, structure, option, field, def_value)
Register a stringfield field as type OPT_STRINGFIELD_T within an object.
Definition sorcery.h:1746

ast_string_field_set
#define ast_string_field_set(x, field, data)
Set a field to a simple string value.
Definition stringfields.h:521

ast_string_field_init
#define ast_string_field_init(x, size)
Initialize a field pool and fields.
Definition stringfields.h:359

ast_string_field_init_extended
#define ast_string_field_init_extended(x, field)
Initialize an extended string field.
Definition stringfields.h:401

ast_string_field_free_memory
#define ast_string_field_free_memory(x)
free all memory - to be called before destroying the object
Definition stringfields.h:374

strings.h
String manipulation functions.

ast_strings_equal
int ast_strings_equal(const char *str1, const char *str2)
Compare strings for equality checking for NULL.
Definition strings.c:238

S_OR
#define S_OR(a, b)
returns the equivalent of logic or for strings: first one if not empty, otherwise second one.
Definition strings.h:80

ast_strlen_zero
static force_inline int attribute_pure ast_strlen_zero(const char *s)
Definition strings.h:65

aco_option
Definition config_options.c:62

ao2_container
Generic container type.
Definition astobj2_container_private.h:270

ast_sorcery_observer
Interface for a sorcery object type observer.
Definition sorcery.h:332

ast_sorcery
Full structure for sorcery.
Definition sorcery.c:231

ast_variable
Structure for variables, used for configurations and for channel variables.
Definition include/asterisk/config.h:83

ast_variable::value
const char * value
Definition include/asterisk/config.h:87

ast_variable::name
const char * name
Definition include/asterisk/config.h:85

ast_variable::next
struct ast_variable * next
Definition include/asterisk/config.h:90

ast_websocket_client_options
Options used for a websocket client.
Definition http_websocket.h:503

ast_websocket_client_options::uri
const char * uri
Definition http_websocket.h:513

ast_websocket_client
Definition websocket_client.h:77

ast_websocket_client::pingpong_interval
unsigned int pingpong_interval
Definition websocket_client.h:107

ast_websocket_client::verify_server_cert
int verify_server_cert
Definition websocket_client.h:96

ast_websocket_client::reconnect_interval
unsigned int reconnect_interval
Definition websocket_client.h:94

ast_websocket_client::write_timeout
int write_timeout
Definition websocket_client.h:109

ast_websocket_client::uri
const ast_string_field uri
Definition websocket_client.h:88

ast_websocket_client::pingpong_probes
unsigned int pingpong_probes
Definition websocket_client.h:108

ast_websocket_client::connection_type
enum ast_websocket_type connection_type
Definition websocket_client.h:91

ast_websocket_client::ca_list_path
const ast_string_field ca_list_path
Definition websocket_client.h:88

ast_websocket_client::cert_file
const ast_string_field cert_file
Definition websocket_client.h:88

ast_websocket_client::password
const ast_string_field password
Definition websocket_client.h:88

ast_websocket_client::username
const ast_string_field username
Definition websocket_client.h:88

ast_websocket_client::ca_list_file
const ast_string_field ca_list_file
Definition websocket_client.h:88

ast_websocket_client::verify_server_hostname
int verify_server_hostname
Definition websocket_client.h:97

ast_websocket_client::pingpongs
int pingpongs
Definition websocket_client.h:106

ast_websocket_client::tcp_keepalive_time
unsigned int tcp_keepalive_time
Definition websocket_client.h:103

ast_websocket_client::protocols
const ast_string_field protocols
Definition websocket_client.h:88

ast_websocket_client::tls_enabled
int tls_enabled
Definition websocket_client.h:95

ast_websocket_client::tcp_keepalive_interval
unsigned int tcp_keepalive_interval
Definition websocket_client.h:104

ast_websocket_client::connect_timeout
int connect_timeout
Definition websocket_client.h:92

ast_websocket_client::tcp_keepalive_probes
unsigned int tcp_keepalive_probes
Definition websocket_client.h:105

ast_websocket_client::priv_key_file
const ast_string_field priv_key_file
Definition websocket_client.h:88

ast_websocket_client::reconnect_attempts
unsigned int reconnect_attempts
Definition websocket_client.h:93

ast_websocket_client::tcp_keepalives
int tcp_keepalives
Definition websocket_client.h:102

ast_websocket
Structure definition for session.
Definition res_http_websocket.c:130

websocket_client
Definition res_http_websocket.c:98

AST_SSL_DONT_VERIFY_SERVER
@ AST_SSL_DONT_VERIFY_SERVER
Definition tcptls.h:69

AST_SSL_IGNORE_COMMON_NAME
@ AST_SSL_IGNORE_COMMON_NAME
Definition tcptls.h:71

options
static struct test_options options
Definition test_http_media_cache.c:63

RAII_VAR
#define RAII_VAR(vartype, varname, initval, dtor)
Declare a variable that will call a destructor function when it goes out of scope.
Definition utils.h:981

ast_set2_flag
#define ast_set2_flag(p, value, flag)
Definition utils.h:95

vector.h
Vector container support.

websocket_client.h

ast_ws_client_fields
ast_ws_client_fields
Definition websocket_client.h:28

AST_WS_CLIENT_FIELD_RECONNECT_INTERVAL
@ AST_WS_CLIENT_FIELD_RECONNECT_INTERVAL
Definition websocket_client.h:40

AST_WS_CLIENT_FIELD_NONE
@ AST_WS_CLIENT_FIELD_NONE
Definition websocket_client.h:29

AST_WS_CLIENT_FIELD_URI
@ AST_WS_CLIENT_FIELD_URI
Definition websocket_client.h:30

AST_WS_CLIENT_FIELD_PROTOCOLS
@ AST_WS_CLIENT_FIELD_PROTOCOLS
Definition websocket_client.h:31

AST_WS_CLIENT_FIELD_TCP_KEEPALIVES
@ AST_WS_CLIENT_FIELD_TCP_KEEPALIVES
Definition websocket_client.h:48

AST_WS_CLIENT_FIELD_CA_LIST_PATH
@ AST_WS_CLIENT_FIELD_CA_LIST_PATH
Definition websocket_client.h:36

AST_WS_CLIENT_FIELD_TLS_ENABLED
@ AST_WS_CLIENT_FIELD_TLS_ENABLED
Definition websocket_client.h:34

AST_WS_CLIENT_FIELD_PROXY_PASSWORD
@ AST_WS_CLIENT_FIELD_PROXY_PASSWORD
Definition websocket_client.h:47

AST_WS_CLIENT_FIELD_TCP_KEEPALIVE_TIME
@ AST_WS_CLIENT_FIELD_TCP_KEEPALIVE_TIME
Definition websocket_client.h:49

AST_WS_CLIENT_FIELD_CA_LIST_FILE
@ AST_WS_CLIENT_FIELD_CA_LIST_FILE
Definition websocket_client.h:35

AST_WS_CLIENT_FIELD_PINGPONG_PROBES
@ AST_WS_CLIENT_FIELD_PINGPONG_PROBES
Definition websocket_client.h:54

AST_WS_CLIENT_FIELD_USERNAME
@ AST_WS_CLIENT_FIELD_USERNAME
Definition websocket_client.h:32

AST_WS_CLIENT_FIELD_VERIFY_SERVER_CERT
@ AST_WS_CLIENT_FIELD_VERIFY_SERVER_CERT
Definition websocket_client.h:43

AST_WS_CLIENT_FIELD_PASSWORD
@ AST_WS_CLIENT_FIELD_PASSWORD
Definition websocket_client.h:33

AST_WS_CLIENT_FIELD_PROXY_USERNAME
@ AST_WS_CLIENT_FIELD_PROXY_USERNAME
Definition websocket_client.h:46

AST_WS_CLIENT_FIELD_CONNECTION_TIMEOUT
@ AST_WS_CLIENT_FIELD_CONNECTION_TIMEOUT
Definition websocket_client.h:42

AST_WS_CLIENT_FIELD_PINGPONG_INTERVAL
@ AST_WS_CLIENT_FIELD_PINGPONG_INTERVAL
Definition websocket_client.h:53

AST_WS_CLIENT_FIELD_RECONNECT_ATTEMPTS
@ AST_WS_CLIENT_FIELD_RECONNECT_ATTEMPTS
Definition websocket_client.h:41

AST_WS_CLIENT_FIELD_WRITE_TIMEOUT
@ AST_WS_CLIENT_FIELD_WRITE_TIMEOUT
Definition websocket_client.h:55

AST_WS_CLIENT_FIELD_CONNECTION_TYPE
@ AST_WS_CLIENT_FIELD_CONNECTION_TYPE
Definition websocket_client.h:39

AST_WS_CLIENT_FIELD_TCP_KEEPALIVE_PROBES
@ AST_WS_CLIENT_FIELD_TCP_KEEPALIVE_PROBES
Definition websocket_client.h:51

AST_WS_CLIENT_FIELD_VERIFY_SERVER_HOSTNAME
@ AST_WS_CLIENT_FIELD_VERIFY_SERVER_HOSTNAME
Definition websocket_client.h:44

AST_WS_CLIENT_FIELD_PINGPONGS
@ AST_WS_CLIENT_FIELD_PINGPONGS
Definition websocket_client.h:52

AST_WS_CLIENT_FIELD_TCP_KEEPALIVE_INTERVAL
@ AST_WS_CLIENT_FIELD_TCP_KEEPALIVE_INTERVAL
Definition websocket_client.h:50

AST_WS_CLIENT_FIELD_CERT_FILE
@ AST_WS_CLIENT_FIELD_CERT_FILE
Definition websocket_client.h:37

AST_WS_CLIENT_FIELD_PRIV_KEY_FILE
@ AST_WS_CLIENT_FIELD_PRIV_KEY_FILE
Definition websocket_client.h:38

AST_WS_CLIENT_FIELD_PROXY_HOST
@ AST_WS_CLIENT_FIELD_PROXY_HOST
Definition websocket_client.h:45