#include "asterisk.h"
#include "asterisk/module.h"
#include "asterisk/astobj2.h"
#include "asterisk/strings.h"
#include "asterisk/vector.h"
#include "asterisk/websocket_client.h"

Include dependency graph for res_websocket_client.c:

Macros
#define	DEFAULT_RECONNECT_ATTEMPTS -2147483648

Functions
static void	__reg_module (void)

static void	__unreg_module (void)

struct ast_module *	AST_MODULE_SELF_SYM (void)

void	ast_websocket_client_add_uri_params (struct ast_websocket_client wc, const char uri_params)
	Add additional parameters to the URI.

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.

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.

int	ast_websocket_client_observer_add (const struct ast_sorcery_observer *callbacks)
	Add sorcery observers for websocket client events.

void	ast_websocket_client_observer_remove (const struct ast_sorcery_observer *callbacks)
	Remove sorcery observers for websocket client events.

int	ast_websocket_client_reload (void)
	Force res_websocket_client to reload its configuration.

struct ao2_container *	ast_websocket_client_retrieve_all (void)
	Retrieve a container of all websocket client objects.

struct ast_websocket_client *	ast_websocket_client_retrieve_by_id (const char *id)
	Retrieve a websocket client object by ID.

static int	load_module (void)

static int	reload_module (void)

static int	unload_module (void)

static void *	wc_alloc (const char *id)

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

static void	wc_dtor (void *obj)

static int	websocket_client_connection_type_from_str (const struct aco_option opt, struct ast_variable var, void *obj)

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

Variables
static struct ast_module_info	__mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_GLOBAL_SYMBOLS \| AST_MODFLAG_LOAD_ORDER , .description = "WebSocket Client Support" , .key = ASTERISK_GPL_KEY , .buildopt_sum = AST_BUILDOPT_SUM, .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", }

static const struct ast_module_info *	ast_module_info = &__mod_info

static struct ast_sorcery *	sorcery = NULL

Macro Definition Documentation

◆ DEFAULT_RECONNECT_ATTEMPTS

#define DEFAULT_RECONNECT_ATTEMPTS -2147483648

Definition at line 628 of file res_websocket_client.c.

Function Documentation

◆ __reg_module()

static void __reg_module ( void )

static

Definition at line 911 of file res_websocket_client.c.

◆ __unreg_module()

static void __unreg_module ( void )

static

Definition at line 911 of file res_websocket_client.c.

◆ AST_MODULE_SELF_SYM()

struct ast_module * AST_MODULE_SELF_SYM ( void )

Definition at line 911 of file res_websocket_client.c.

◆ 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.

Parameters

wc	A pointer to the ast_websocket_structure
uri_params	A string containing URLENCODED parameters to append to the URI.

Definition at line 412 of file res_websocket_client.c.

{
    ast_string_field_set(wc, uri_params, uri_params);
}

References ast_string_field_set.

Referenced by webchan_call().

◆ 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.

Parameters

wc	A pointer to the ast_websocket_structure
lock_obj	A pointer to an ao2 object to lock while the connection is being attempted or NULL if no locking is needed.
display_name	An id string to use for logging messages. If NULL or empty the connection's ID will be used.
result	A pointer to an enum ast_websocket_result to store the result of the connection attempt.

Returns: A pointer to the ast_websocket structure on success, or NULL on failure.

Warning: The returned websocket must be closed with ast_websocket_close and its reference count decremented with ast_websocket_unref when it's no longer needed.

Definition at line 418 of file res_websocket_client.c.

{
    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;
}

Referenced by outbound_session_handler_thread(), and webchan_call().

◆ 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.

Parameters

old_ow	The old websocket configuration.
new_ow	The new websocket configuration.

Returns: A bitmask of changed fields.

Definition at line 708 of file res_websocket_client.c.

{
    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;
 
}

Referenced by ari_conf_owc_detect_changes().

◆ ast_websocket_client_observer_add()

int ast_websocket_client_observer_add ( const struct ast_sorcery_observer * callbacks )

Add sorcery observers for websocket client events.

Parameters

callbacks The observer callbacks to add.

Returns: 0 on success, -1 on failure.

Definition at line 795 of file res_websocket_client.c.

{
    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;
}

References ast_log, ast_sorcery_observer_add(), callbacks, LOG_ERROR, and sorcery.

Referenced by ari_conf_init().

◆ ast_websocket_client_observer_remove()

void ast_websocket_client_observer_remove ( const struct ast_sorcery_observer * callbacks )

Remove sorcery observers for websocket client events.

Parameters

callbacks The observer callbacks to remove.

Definition at line 809 of file res_websocket_client.c.

{
    if (!sorcery || !callbacks) {
        return;
    }
 
    ast_sorcery_observer_remove(sorcery, "websocket_client", callbacks);
}

References ast_sorcery_observer_remove(), callbacks, and sorcery.

Referenced by ari_conf_destroy().

◆ ast_websocket_client_reload()

int ast_websocket_client_reload ( void )

Force res_websocket_client to reload its configuration.

Returns: 0 on success, -1 on failure.

Definition at line 884 of file res_websocket_client.c.

{
    ast_debug(2, "Reloading Websocket Client Configuration\n");
    if (sorcery) {
        ast_sorcery_reload(sorcery);
    }
 
    return 0;
}

References ast_debug, ast_sorcery_reload(), and sorcery.

Referenced by ari_conf_load().

◆ ast_websocket_client_retrieve_all()

struct ao2_container * ast_websocket_client_retrieve_all ( void )

Retrieve a container of all websocket client objects.

Returns: The container. It may be empty but must always be cleaned up by the caller.

Definition at line 689 of file res_websocket_client.c.

{
    if (!sorcery) {
        return NULL;
    }
 
    return ast_sorcery_retrieve_by_fields(sorcery, "websocket_client",
        AST_RETRIEVE_FLAG_MULTIPLE | AST_RETRIEVE_FLAG_ALL, NULL);
}

References AST_RETRIEVE_FLAG_ALL, AST_RETRIEVE_FLAG_MULTIPLE, ast_sorcery_retrieve_by_fields(), NULL, and sorcery.

◆ 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.

Parameters

id	The ID of the websocket client object.

Returns: The websocket client ao2 object or NULL if not found. The reference must be cleaned up by the caller.

Definition at line 699 of file res_websocket_client.c.

{
    if (!sorcery) {
        return NULL;
    }
 
    return ast_sorcery_retrieve_by_id(sorcery, "websocket_client", id);
}

References ast_sorcery_retrieve_by_id(), NULL, and sorcery.

Referenced by ast_ari_channels_external_media(), outbound_websocket_websocket_client_id_from_str(), and websocket_new().

◆ load_module()

static int load_module ( void )

static

Definition at line 819 of file res_websocket_client.c.

{
    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;
}

References ast_debug, ast_log, ast_sorcery_apply_default, ast_sorcery_load(), ast_sorcery_object_field_register, ast_sorcery_object_register, ast_sorcery_open, ast_sorcery_register_bool, ast_sorcery_register_cust, ast_sorcery_register_int, ast_sorcery_register_sf, ast_sorcery_register_uint, ast_sorcery_unref, LOG_ERROR, NULL, OPT_NOOP_T, sorcery, wc_alloc(), and wc_apply().

◆ reload_module()

static int reload_module ( void )

static

Definition at line 876 of file res_websocket_client.c.

{
    ast_debug(2, "Reloading Websocket Client Configuration\n");
    ast_sorcery_reload(sorcery);
 
    return 0;
}

References ast_debug, ast_sorcery_reload(), and sorcery.

◆ unload_module()

static int unload_module ( void )

static

Definition at line 894 of file res_websocket_client.c.

{
    ast_debug(2, "Unloading Websocket Client Configuration\n");
    if (sorcery) {
        ast_sorcery_unref(sorcery);
        sorcery = NULL;
    }
    return 0;
}

References ast_debug, ast_sorcery_unref, NULL, and sorcery.

◆ wc_alloc()

static void * wc_alloc ( const char * id )

static

Definition at line 554 of file res_websocket_client.c.

{
    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;
}

References ao2_cleanup, ast_debug, ast_sorcery_generic_alloc(), ast_string_field_init, ast_string_field_init_extended, NULL, and wc_dtor().

Referenced by load_module().

◆ wc_apply()

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

static

Definition at line 630 of file res_websocket_client.c.

{
    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;
}

Referenced by load_module().

◆ wc_dtor()

static void wc_dtor ( void * obj )

static

Definition at line 545 of file res_websocket_client.c.

{
    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);
}

References ast_debug, ast_sorcery_object_get_id(), and ast_string_field_free_memory.

Referenced by wc_alloc().

◆ 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
	)

static

Definition at line 592 of file res_websocket_client.c.

{
    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;
}

References AST_WS_TYPE_CLIENT_PER_CALL_CONFIG, AST_WS_TYPE_CLIENT_PERSISTENT, ast_websocket_client::connection_type, and var.

◆ websocket_client_connection_type_to_str()

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

static

Definition at line 608 of file res_websocket_client.c.

{
    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;
}

References ast_strdup, AST_WS_TYPE_CLIENT_PER_CALL_CONFIG, AST_WS_TYPE_CLIENT_PERSISTENT, buf, and ast_websocket_client::connection_type.

Variable Documentation

◆ __mod_info

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_GLOBAL_SYMBOLS | AST_MODFLAG_LOAD_ORDER , .description = "WebSocket Client Support" , .key = ASTERISK_GPL_KEY , .buildopt_sum = AST_BUILDOPT_SUM, .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", }

static

Definition at line 911 of file res_websocket_client.c.

◆ ast_module_info

const struct ast_module_info* ast_module_info = &__mod_info

static

Definition at line 911 of file res_websocket_client.c.

◆ sorcery

struct ast_sorcery* sorcery = NULL

static

Definition at line 410 of file res_websocket_client.c.

Referenced by ast_websocket_client_get_field_diff(), ast_websocket_client_observer_add(), ast_websocket_client_observer_remove(), ast_websocket_client_reload(), ast_websocket_client_retrieve_all(), ast_websocket_client_retrieve_by_id(), load_module(), reload_module(), and unload_module().

Macros

Functions

Variables

Macro Definition Documentation

◆ DEFAULT_RECONNECT_ATTEMPTS

Function Documentation

◆ __reg_module()

◆ __unreg_module()

◆ AST_MODULE_SELF_SYM()

◆ ast_websocket_client_add_uri_params()

◆ ast_websocket_client_connect()

◆ ast_websocket_client_get_field_diff()

◆ ast_websocket_client_observer_add()

◆ ast_websocket_client_observer_remove()

◆ ast_websocket_client_reload()

◆ ast_websocket_client_retrieve_all()

◆ ast_websocket_client_retrieve_by_id()

◆ load_module()

◆ reload_module()

◆ unload_module()

◆ wc_alloc()

◆ wc_apply()

◆ wc_dtor()

◆ websocket_client_connection_type_from_str()

◆ websocket_client_connection_type_to_str()

Variable Documentation

◆ __mod_info

◆ ast_module_info

◆ sorcery