Asterisk - The Open Source Telephony Project GIT-master-7921072
Data Structures | Macros | Functions | Variables
stasis.c File Reference

Stasis Message Bus API. More...

#include "asterisk.h"
#include "asterisk/astobj2.h"
#include "asterisk/stasis_internal.h"
#include "asterisk/stasis.h"
#include "asterisk/taskprocessor.h"
#include "asterisk/threadpool.h"
#include "asterisk/utils.h"
#include "asterisk/uuid.h"
#include "asterisk/vector.h"
#include "asterisk/stasis_channels.h"
#include "asterisk/stasis_bridges.h"
#include "asterisk/stasis_endpoints.h"
#include "asterisk/config_options.h"
#include "asterisk/cli.h"
Include dependency graph for stasis.c:

Go to the source code of this file.

Data Structures

struct  ast_multi_object_blob
 A multi object blob data structure to carry user event stasis messages. More...
 
struct  stasis_config
 
struct  stasis_declined_config
 A structure to hold global configuration-related options. More...
 
struct  stasis_forward
 Forwarding information. More...
 
struct  stasis_subscription
 
struct  stasis_threadpool_conf
 Threadpool configuration options. More...
 
struct  stasis_topic
 
struct  stasis_topic_pool
 
struct  sync_task_data
 
struct  topic_pool_entry
 
struct  topic_proxy
 

Macros

#define FMT_FIELDS   "%-64s %-64s\n"
 
#define FMT_HEADERS   "%-64s %-64s\n"
 
#define INITIAL_SUBSCRIBERS_MAX   4
 
#define TOPIC_ALL_BUCKETS   997
 
#define topic_lock_both(topic1, topic2)
 Lock two topics. More...
 
#define TOPIC_POOL_BUCKETS   57
 

Functions

struct stasis_subscription__stasis_subscribe (struct stasis_topic *topic, stasis_subscription_cb callback, void *data, const char *file, int lineno, const char *func)
 Create a subscription. More...
 
struct stasis_subscription__stasis_subscribe_pool (struct stasis_topic *topic, stasis_subscription_cb callback, void *data, const char *file, int lineno, const char *func)
 Create a subscription whose callbacks occur on a thread pool. More...
 
static AO2_GLOBAL_OBJ_STATIC (globals)
 A global object container that will contain the stasis_config that gets swapped out on reloads. More...
 
 AO2_STRING_FIELD_CASE_SORT_FN (topic_proxy, name)
 
 AO2_STRING_FIELD_CMP_FN (topic_proxy, name)
 
 AO2_STRING_FIELD_HASH_FN (topic_proxy, name)
 
void ast_multi_object_blob_add (struct ast_multi_object_blob *multi, enum stasis_user_multi_object_snapshot_type type, void *object)
 Add an object (snapshot) to the blob. More...
 
struct ast_multi_object_blobast_multi_object_blob_create (struct ast_json *blob)
 Create a stasis user event multi object blob. More...
 
void ast_multi_object_blob_single_channel_publish (struct ast_channel *chan, struct stasis_message_type *type, struct ast_json *blob)
 Publish single channel user event (for app_userevent compatibility) More...
 
 CONFIG_INFO_CORE ("stasis", cfg_info, globals, stasis_config_alloc,.files=ACO_FILES(&stasis_conf),)
 Register information about the configs being processed by this module. More...
 
static int declined_handler (const struct aco_option *opt, struct ast_variable *var, void *obj)
 
static int dispatch_exec_async (struct ast_taskprocessor_local *local)
 
static int dispatch_exec_sync (struct ast_taskprocessor_local *local)
 
static unsigned int dispatch_message (struct stasis_subscription *sub, struct stasis_message *message, int synchronous)
 
static void forward_dtor (void *obj)
 
struct stasis_subscriptioninternal_stasis_subscribe (struct stasis_topic *topic, stasis_subscription_cb callback, void *data, int needs_mailbox, int use_thread_pool, const char *file, int lineno, const char *func)
 Create a subscription. More...
 
static int link_topic_proxy (struct stasis_topic *topic, const char *name, const char *detail)
 
static void multi_object_blob_dtor (void *obj)
 
static struct ast_strmulti_object_blob_to_ami (void *obj)
 
static struct ast_manager_event_blobmulti_user_event_to_ami (struct stasis_message *message)
 
static struct ast_jsonmulti_user_event_to_json (struct stasis_message *message, const struct stasis_message_sanitizer *sanitize)
 
static void proxy_dtor (void *weakproxy, void *container)
 
static void publish_msg (struct stasis_topic *topic, struct stasis_message *message, struct stasis_subscription *sync_sub)
 
static void send_subscription_subscribe (struct stasis_topic *topic, struct stasis_subscription *sub)
 
static void send_subscription_unsubscribe (struct stasis_topic *topic, struct stasis_subscription *sub)
 
static void stasis_cleanup (void)
 Cleanup function for graceful shutdowns. More...
 
static void * stasis_config_alloc (void)
 
static void stasis_config_destructor (void *obj)
 
static void stasis_declined_config_destructor (void *obj)
 
struct stasis_forwardstasis_forward_all (struct stasis_topic *from_topic, struct stasis_topic *to_topic)
 Create a subscription which forwards all messages from one topic to another. More...
 
struct stasis_forwardstasis_forward_cancel (struct stasis_forward *forward)
 
int stasis_init (void)
 Initialize the Stasis subsystem. More...
 
void stasis_log_bad_type_access (const char *name)
 
int stasis_message_type_declined (const char *name)
 Check whether a message type is declined. More...
 
 STASIS_MESSAGE_TYPE_DEFN (stasis_subscription_change_type)
 
void stasis_publish (struct stasis_topic *topic, struct stasis_message *message)
 Publish a message to a topic's subscribers. More...
 
void stasis_publish_sync (struct stasis_subscription *sub, struct stasis_message *message)
 Publish a message to a topic's subscribers, synchronizing on the specified subscriber. More...
 
static char * stasis_show_topic (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
 
static char * stasis_show_topics (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
 
void stasis_subscription_accept_formatters (struct stasis_subscription *subscription, enum stasis_subscription_message_formatters formatters)
 Indicate to a subscription that we are interested in messages with one or more formatters. More...
 
int stasis_subscription_accept_message_type (struct stasis_subscription *subscription, const struct stasis_message_type *type)
 Indicate to a subscription that we are interested in a message type. More...
 
void stasis_subscription_cb_noop (void *data, struct stasis_subscription *sub, struct stasis_message *message)
 Stasis subscription callback function that does nothing. More...
 
int stasis_subscription_decline_message_type (struct stasis_subscription *subscription, const struct stasis_message_type *type)
 Indicate to a subscription that we are not interested in a message type. More...
 
int stasis_subscription_final_message (struct stasis_subscription *sub, struct stasis_message *msg)
 Determine whether a message is the final message to be received on a subscription. More...
 
int stasis_subscription_is_done (struct stasis_subscription *subscription)
 Returns whether subscription has received its final message. More...
 
int stasis_subscription_is_subscribed (const struct stasis_subscription *sub)
 Returns whether a subscription is currently subscribed. More...
 
void stasis_subscription_join (struct stasis_subscription *subscription)
 Block until the last message is processed on a subscription. More...
 
int stasis_subscription_set_congestion_limits (struct stasis_subscription *subscription, long low_water, long high_water)
 Set the high and low alert water marks of the stasis subscription. More...
 
int stasis_subscription_set_filter (struct stasis_subscription *subscription, enum stasis_subscription_message_filter filter)
 Set the message type filtering level on a subscription. More...
 
const char * stasis_subscription_uniqueid (const struct stasis_subscription *sub)
 Get the unique ID for the subscription. More...
 
struct stasis_topicstasis_topic_create (const char *name)
 Create a new topic. More...
 
struct stasis_topicstasis_topic_create_with_detail (const char *name, const char *detail)
 Create a new topic with given detail. More...
 
const char * stasis_topic_detail (const struct stasis_topic *topic)
 Return the detail of a topic. More...
 
struct stasis_topicstasis_topic_get (const char *name)
 Get a topic of the given name. More...
 
const char * stasis_topic_name (const struct stasis_topic *topic)
 Return the name of a topic. More...
 
struct stasis_topic_poolstasis_topic_pool_create (struct stasis_topic *pooled_topic)
 Create a topic pool that routes messages from dynamically generated topics to the given topic. More...
 
void stasis_topic_pool_delete_topic (struct stasis_topic_pool *pool, const char *topic_name)
 Delete a topic from the topic pool. More...
 
struct stasis_topicstasis_topic_pool_get_topic (struct stasis_topic_pool *pool, const char *topic_name)
 Find or create a topic in the pool. More...
 
int stasis_topic_pool_topic_exists (const struct stasis_topic_pool *pool, const char *topic_name)
 Check if a topic exists in a pool. More...
 
size_t stasis_topic_subscribers (const struct stasis_topic *topic)
 Return the number of subscribers of a topic. More...
 
struct stasis_subscriptionstasis_unsubscribe (struct stasis_subscription *sub)
 Cancel a subscription. More...
 
struct stasis_subscriptionstasis_unsubscribe_and_join (struct stasis_subscription *subscription)
 Cancel a subscription, blocking until the last message is processed. More...
 
static int sub_cleanup (void *data)
 
static struct stasis_subscription_changesubscription_change_alloc (struct stasis_topic *topic, const char *uniqueid, const char *description)
 
static void subscription_change_dtor (void *obj)
 
static void subscription_dtor (void *obj)
 
static void subscription_invoke (struct stasis_subscription *sub, struct stasis_message *message)
 Invoke the subscription's callback. More...
 
static int topic_add_subscription (struct stasis_topic *topic, struct stasis_subscription *sub)
 Add a subscriber to a topic. More...
 
static char * topic_complete_name (const char *word)
 
static void topic_dtor (void *obj)
 
static void topic_pool_dtor (void *obj)
 
static struct topic_pool_entrytopic_pool_entry_alloc (const char *topic_name)
 
static int topic_pool_entry_cmp (void *obj, void *arg, int flags)
 
static void topic_pool_entry_dtor (void *obj)
 
static int topic_pool_entry_hash (const void *obj, const int flags)
 
static int topic_remove_subscription (struct stasis_topic *topic, struct stasis_subscription *sub)
 
static int userevent_exclusion_cb (const char *key)
 
 STASIS_MESSAGE_TYPE_DEFN (ast_multi_user_event_type,.to_json=multi_user_event_to_json,.to_ami=multi_user_event_to_ami,)
 Define multi user event message type(s). More...
 

Variables

static struct ast_cli_entry cli_stasis []
 
static struct aco_type declined_option
 An aco_type structure to link the "declined_message_types" category to the stasis_declined_config type. More...
 
struct aco_typedeclined_options [] = ACO_TYPES(&declined_option)
 
struct aco_file stasis_conf
 
static struct ast_threadpoolthreadpool
 
static struct aco_type threadpool_option
 
static struct aco_typethreadpool_options [] = ACO_TYPES(&threadpool_option)
 
struct ao2_containertopic_all
 

Detailed Description

Stasis Message Bus API.

Author
David M. Lee, II dlee@.nosp@m.digi.nosp@m.um.co.nosp@m.m

Definition in file stasis.c.

Macro Definition Documentation

◆ FMT_FIELDS

#define FMT_FIELDS   "%-64s %-64s\n"

◆ FMT_HEADERS

#define FMT_HEADERS   "%-64s %-64s\n"

◆ INITIAL_SUBSCRIBERS_MAX

#define INITIAL_SUBSCRIBERS_MAX   4

Initial size of the subscribers list.

Definition at line 301 of file stasis.c.

◆ TOPIC_ALL_BUCKETS

#define TOPIC_ALL_BUCKETS   997

Definition at line 317 of file stasis.c.

◆ topic_lock_both

#define topic_lock_both (   topic1,
  topic2 
)

Lock two topics.

Definition at line 425 of file stasis.c.

◆ TOPIC_POOL_BUCKETS

#define TOPIC_POOL_BUCKETS   57

The number of buckets to use for topic pools

Definition at line 304 of file stasis.c.

Function Documentation

◆ __stasis_subscribe()

struct stasis_subscription * __stasis_subscribe ( struct stasis_topic topic,
stasis_subscription_cb  callback,
void *  data,
const char *  file,
int  lineno,
const char *  func 
)

Create a subscription.

In addition to being AO2 managed memory (requiring an ao2_cleanup() to free up this reference), the subscription must be explicitly unsubscribed from its topic using stasis_unsubscribe().

The invocations of the callback are serialized, but may not always occur on the same thread. The invocation order of different subscriptions is unspecified.

Parameters
topicTopic to subscribe to.
callbackCallback function for subscription messages.
dataData to be passed to the callback, in addition to the message.
file,lineno,func
Returns
New stasis_subscription object.
Return values
NULLon error.
Since
12
Note
This callback will receive a callback with a message indicating it has been subscribed. This occurs immediately before accepted message types can be set and the callback must expect to receive it.

Definition at line 942 of file stasis.c.

949{
950 return internal_stasis_subscribe(topic, callback, data, 1, 0, file, lineno, func);
951}
struct stasis_subscription * internal_stasis_subscribe(struct stasis_topic *topic, stasis_subscription_cb callback, void *data, int needs_mailbox, int use_thread_pool, const char *file, int lineno, const char *func)
Create a subscription.
Definition: stasis.c:856

References stasis_subscription::callback, stasis_subscription::data, make_ari_stubs::file, internal_stasis_subscribe(), and stasis_subscription::topic.

Referenced by stasis_message_router_create_internal().

◆ __stasis_subscribe_pool()

struct stasis_subscription * __stasis_subscribe_pool ( struct stasis_topic topic,
stasis_subscription_cb  callback,
void *  data,
const char *  file,
int  lineno,
const char *  func 
)

Create a subscription whose callbacks occur on a thread pool.

In addition to being AO2 managed memory (requiring an ao2_cleanup() to free up this reference), the subscription must be explicitly unsubscribed from its topic using stasis_unsubscribe().

The invocations of the callback are serialized, but will almost certainly not always happen on the same thread. The invocation order of different subscriptions is unspecified.

Unlike stasis_subscribe, this function will explicitly use a threadpool to dispatch items to its callback. This form of subscription should be used when many subscriptions may be made to the specified topic.

Parameters
topicTopic to subscribe to.
callbackCallback function for subscription messages.
dataData to be passed to the callback, in addition to the message.
file,lineno,func
Returns
New stasis_subscription object.
Return values
NULLon error.
Since
12.8.0
Note
This callback will receive a callback with a message indicating it has been subscribed. This occurs immediately before accepted message types can be set and the callback must expect to receive it.

Definition at line 953 of file stasis.c.

960{
961 return internal_stasis_subscribe(topic, callback, data, 1, 1, file, lineno, func);
962}

References stasis_subscription::callback, stasis_subscription::data, make_ari_stubs::file, internal_stasis_subscribe(), and stasis_subscription::topic.

Referenced by stasis_message_router_create_internal().

◆ AO2_GLOBAL_OBJ_STATIC()

static AO2_GLOBAL_OBJ_STATIC ( globals  )
static

A global object container that will contain the stasis_config that gets swapped out on reloads.

◆ AO2_STRING_FIELD_CASE_SORT_FN()

AO2_STRING_FIELD_CASE_SORT_FN ( topic_proxy  ,
name   
)

◆ AO2_STRING_FIELD_CMP_FN()

AO2_STRING_FIELD_CMP_FN ( topic_proxy  ,
name   
)

◆ AO2_STRING_FIELD_HASH_FN()

AO2_STRING_FIELD_HASH_FN ( topic_proxy  ,
name   
)

◆ CONFIG_INFO_CORE()

CONFIG_INFO_CORE ( "stasis"  ,
cfg_info  ,
globals  ,
stasis_config_alloc  ,
files = ACO_FILES(&stasis_conf) 
)

Register information about the configs being processed by this module.

◆ declined_handler()

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

Definition at line 2304 of file stasis.c.

2305{
2306 struct stasis_declined_config *declined = obj;
2307
2308 if (ast_strlen_zero(var->value)) {
2309 return 0;
2310 }
2311
2312 if (ast_str_container_add(declined->declined, var->value)) {
2313 return -1;
2314 }
2315
2316 return 0;
2317}
#define var
Definition: ast_expr2f.c:605
static force_inline int attribute_pure ast_strlen_zero(const char *s)
Definition: strings.h:65
int ast_str_container_add(struct ao2_container *str_container, const char *add)
Adds a string to a string container allocated by ast_str_container_alloc.
Definition: strings.c:205
A structure to hold global configuration-related options.
Definition: stasis.c:2180
struct ao2_container * declined
Definition: stasis.c:2182

References ast_str_container_add(), ast_strlen_zero(), stasis_declined_config::declined, and var.

Referenced by stasis_init().

◆ dispatch_exec_async()

static int dispatch_exec_async ( struct ast_taskprocessor_local local)
static

Definition at line 1259 of file stasis.c.

1260{
1261 struct stasis_subscription *sub = local->local_data;
1262 struct stasis_message *message = local->data;
1263
1266
1267 return 0;
1268}
#define ao2_cleanup(obj)
Definition: astobj2.h:1934
struct stasis_forward * sub
Definition: res_corosync.c:240
static void subscription_invoke(struct stasis_subscription *sub, struct stasis_message *message)
Invoke the subscription's callback.
Definition: stasis.c:754

References ao2_cleanup, ast_taskprocessor_local::data, ast_taskprocessor_local::local_data, sub, and subscription_invoke().

Referenced by dispatch_message().

◆ dispatch_exec_sync()

static int dispatch_exec_sync ( struct ast_taskprocessor_local local)
static

Definition at line 1286 of file stasis.c.

1287{
1288 struct stasis_subscription *sub = local->local_data;
1289 struct sync_task_data *std = local->data;
1290 struct stasis_message *message = std->task_data;
1291
1294
1295 ast_mutex_lock(&std->lock);
1296 std->complete = 1;
1297 ast_cond_signal(&std->cond);
1298 ast_mutex_unlock(&std->lock);
1299
1300 return 0;
1301}
#define ast_mutex_unlock(a)
Definition: lock.h:190
#define ast_mutex_lock(a)
Definition: lock.h:189
#define ast_cond_signal(cond)
Definition: lock.h:203
ast_cond_t cond
Definition: stasis.c:1276
void * task_data
Definition: stasis.c:1278
ast_mutex_t lock
Definition: stasis.c:1275

References ao2_cleanup, ast_cond_signal, ast_mutex_lock, ast_mutex_unlock, sync_task_data::complete, sync_task_data::cond, ast_taskprocessor_local::data, ast_taskprocessor_local::local_data, sync_task_data::lock, sub, subscription_invoke(), and sync_task_data::task_data.

Referenced by dispatch_message().

◆ dispatch_message()

static unsigned int dispatch_message ( struct stasis_subscription sub,
struct stasis_message message,
int  synchronous 
)
static

Definition at line 1312 of file stasis.c.

1315{
1317
1318 /*
1319 * The 'do while' gives us an easy way to skip remaining logic once
1320 * we determine the message should be accepted.
1321 * The code looks more verbose than it needs to be but it optimizes
1322 * down very nicely. It's just easier to understand and debug this way.
1323 */
1324 do {
1325 struct stasis_message_type *message_type = stasis_message_type(message);
1326 int type_id = stasis_message_type_id(message_type);
1327 int type_filter_specified = 0;
1328 int formatter_filter_specified = 0;
1329 int type_filter_passed = 0;
1330 int formatter_filter_passed = 0;
1331
1332 /* We always accept final messages so only run the filter logic if not final */
1333 if (is_final) {
1334 break;
1335 }
1336
1337 type_filter_specified = sub->filter & STASIS_SUBSCRIPTION_FILTER_SELECTIVE;
1338 formatter_filter_specified = sub->accepted_formatters != STASIS_SUBSCRIPTION_FORMATTER_NONE;
1339
1340 /* Accept if no filters of either type were specified */
1341 if (!type_filter_specified && !formatter_filter_specified) {
1342 break;
1343 }
1344
1345 type_filter_passed = type_filter_specified
1346 && type_id < AST_VECTOR_SIZE(&sub->accepted_message_types)
1347 && AST_VECTOR_GET(&sub->accepted_message_types, type_id);
1348
1349 /*
1350 * Since the type and formatter filters are OR'd, we can skip
1351 * the formatter check if the type check passes.
1352 */
1353 if (type_filter_passed) {
1354 break;
1355 }
1356
1357 formatter_filter_passed = formatter_filter_specified
1358 && (sub->accepted_formatters & stasis_message_type_available_formatters(message_type));
1359
1360 if (formatter_filter_passed) {
1361 break;
1362 }
1363
1364#ifdef AST_DEVMODE
1365 ast_atomic_fetchadd_int(&sub->statistics->messages_dropped, +1);
1366#endif
1367
1368 return 0;
1369
1370 } while (0);
1371
1372#ifdef AST_DEVMODE
1373 ast_atomic_fetchadd_int(&sub->statistics->messages_passed, +1);
1374#endif
1375
1376 if (!sub->mailbox) {
1377 /* Dispatch directly */
1379 return 1;
1380 }
1381
1382 /* Bump the message for the taskprocessor push. This will get de-ref'd
1383 * by the task processor callback.
1384 */
1386 if (!synchronous) {
1388 /* Push failed; ugh. */
1389 ast_log(LOG_ERROR, "Dropping async dispatch\n");
1391 return 0;
1392 }
1393 } else {
1394 struct sync_task_data std;
1395
1396 ast_mutex_init(&std.lock);
1397 ast_cond_init(&std.cond, NULL);
1398 std.complete = 0;
1399 std.task_data = message;
1400
1402 /* Push failed; ugh. */
1403 ast_log(LOG_ERROR, "Dropping sync dispatch\n");
1405 ast_mutex_destroy(&std.lock);
1406 ast_cond_destroy(&std.cond);
1407 return 0;
1408 }
1409
1410 ast_mutex_lock(&std.lock);
1411 while (!std.complete) {
1412 ast_cond_wait(&std.cond, &std.lock);
1413 }
1414 ast_mutex_unlock(&std.lock);
1415
1416 ast_mutex_destroy(&std.lock);
1417 ast_cond_destroy(&std.cond);
1418 }
1419
1420 return 1;
1421}
#define ast_log
Definition: astobj2.c:42
#define ao2_bump(obj)
Bump refcount on an AO2 object by one, returning the object.
Definition: astobj2.h:480
#define LOG_ERROR
#define ast_cond_destroy(cond)
Definition: lock.h:202
#define ast_cond_wait(cond, mutex)
Definition: lock.h:205
#define ast_cond_init(cond, attr)
Definition: lock.h:201
#define ast_mutex_init(pmutex)
Definition: lock.h:186
int ast_atomic_fetchadd_int(volatile int *p, int v)
Atomically add v to *p and return the previous value of *p.
Definition: lock.h:757
#define ast_mutex_destroy(a)
Definition: lock.h:188
#define NULL
Definition: resample.c:96
static int dispatch_exec_sync(struct ast_taskprocessor_local *local)
Definition: stasis.c:1286
int stasis_subscription_final_message(struct stasis_subscription *sub, struct stasis_message *msg)
Determine whether a message is the final message to be received on a subscription.
Definition: stasis.c:1174
static int dispatch_exec_async(struct ast_taskprocessor_local *local)
Definition: stasis.c:1259
struct stasis_message_type * stasis_message_type(const struct stasis_message *msg)
Get the message type for a stasis_message.
@ STASIS_SUBSCRIPTION_FILTER_SELECTIVE
Definition: stasis.h:297
@ STASIS_SUBSCRIPTION_FORMATTER_NONE
Definition: stasis.h:309
int stasis_message_type_id(const struct stasis_message_type *type)
Gets the id of a given message type.
enum stasis_subscription_message_formatters stasis_message_type_available_formatters(const struct stasis_message_type *message_type)
Get a bitmap of available formatters for a message type.
int ast_taskprocessor_push_local(struct ast_taskprocessor *tps, int(*task_exe)(struct ast_taskprocessor_local *local), void *datap) attribute_warn_unused_result
Push a task into the specified taskprocessor queue and signal the taskprocessor thread.
#define AST_VECTOR_SIZE(vec)
Get the number of elements in a vector.
Definition: vector.h:609
#define AST_VECTOR_GET(vec, idx)
Get an element from a vector.
Definition: vector.h:680

References ao2_bump, ao2_cleanup, ast_atomic_fetchadd_int(), ast_cond_destroy, ast_cond_init, ast_cond_wait, ast_log, ast_mutex_destroy, ast_mutex_init, ast_mutex_lock, ast_mutex_unlock, ast_taskprocessor_push_local(), AST_VECTOR_GET, AST_VECTOR_SIZE, sync_task_data::complete, sync_task_data::cond, dispatch_exec_async(), dispatch_exec_sync(), sync_task_data::lock, LOG_ERROR, NULL, stasis_message_type(), stasis_message_type_available_formatters(), stasis_message_type_id(), STASIS_SUBSCRIPTION_FILTER_SELECTIVE, stasis_subscription_final_message(), STASIS_SUBSCRIPTION_FORMATTER_NONE, sub, subscription_invoke(), and sync_task_data::task_data.

Referenced by publish_msg(), and send_subscription_unsubscribe().

◆ forward_dtor()

static void forward_dtor ( void *  obj)
static

Definition at line 1538 of file stasis.c.

1539{
1540 struct stasis_forward *forward = obj;
1541
1542 ao2_cleanup(forward->from_topic);
1543 forward->from_topic = NULL;
1544 ao2_cleanup(forward->to_topic);
1545 forward->to_topic = NULL;
1546}
Forwarding information.
Definition: stasis.c:1531
struct stasis_topic * from_topic
Definition: stasis.c:1533
struct stasis_topic * to_topic
Definition: stasis.c:1535

References ao2_cleanup, stasis_forward::from_topic, NULL, and stasis_forward::to_topic.

Referenced by stasis_forward_all().

◆ internal_stasis_subscribe()

struct stasis_subscription * internal_stasis_subscribe ( struct stasis_topic topic,
stasis_subscription_cb  callback,
void *  data,
int  needs_mailbox,
int  use_thread_pool,
const char *  file,
int  lineno,
const char *  func 
)

Create a subscription.

In addition to being AO2 managed memory (requiring an ao2_cleanup() to free up this reference), the subscription must be explicitly unsubscribed from its topic using stasis_unsubscribe().

The invocations of the callback are serialized, but may not always occur on the same thread. The invocation order of different subscriptions is unspecified.

Note: modules outside of Stasis should use stasis_subscribe.

Parameters
topicTopic to subscribe to.
callbackCallback function for subscription messages.
dataData to be passed to the callback, in addition to the message.
needs_mailboxDetermines whether or not the subscription requires a mailbox. Subscriptions with mailboxes will be delivered on some non-publisher thread; subscriptions without mailboxes will be delivered on the publisher thread.
use_thread_poolUse the thread pool for the subscription. This is only relevant if needs_mailbox is non-zero.
file,lineno,func
Returns
New stasis_subscription object.
Return values
NULLon error.
Since
12

Definition at line 856 of file stasis.c.

865{
866 struct stasis_subscription *sub;
867 int ret;
868
869 if (!topic) {
870 return NULL;
871 }
872
873 /* The ao2 lock is used for join_cond. */
875 if (!sub) {
876 return NULL;
877 }
878
879#ifdef AST_DEVMODE
881 sub->statistics = stasis_subscription_statistics_create(sub, needs_mailbox, use_thread_pool, file, lineno, func);
882 if (ret < 0 || !sub->statistics) {
883 ao2_ref(sub, -1);
884 return NULL;
885 }
886#else
888 if (ret < 0) {
889 ao2_ref(sub, -1);
890 return NULL;
891 }
892#endif
893
894 if (needs_mailbox) {
895 char tps_name[AST_TASKPROCESSOR_MAX_NAME + 1];
896
897 /* Create name with seq number appended. */
898 ast_taskprocessor_build_name(tps_name, sizeof(tps_name), "stasis/%c:%s",
899 use_thread_pool ? 'p' : 'm',
901
902 /*
903 * With a small number of subscribers, a thread-per-sub is
904 * acceptable. For a large number of subscribers, a thread
905 * pool should be used.
906 */
907 if (use_thread_pool) {
908 sub->mailbox = ast_threadpool_serializer(tps_name, threadpool);
909 } else {
910 sub->mailbox = ast_taskprocessor_get(tps_name, TPS_REF_DEFAULT);
911 }
912 if (!sub->mailbox) {
913 ao2_ref(sub, -1);
914
915 return NULL;
916 }
918 /* Taskprocessor has a reference */
919 ao2_ref(sub, +1);
920 }
921
922 ao2_ref(topic, +1);
923 sub->topic = topic;
924 sub->callback = callback;
925 sub->data = data;
926 ast_cond_init(&sub->join_cond, NULL);
928 AST_VECTOR_INIT(&sub->accepted_message_types, 0);
929 sub->accepted_formatters = STASIS_SUBSCRIPTION_FORMATTER_NONE;
930
931 if (topic_add_subscription(topic, sub) != 0) {
932 ao2_ref(sub, -1);
933 ao2_ref(topic, -1);
934
935 return NULL;
936 }
938
939 return sub;
940}
#define ast_asprintf(ret, fmt,...)
A wrapper for asprintf()
Definition: astmm.h:267
#define ao2_ref(o, delta)
Reference/unreference an object and return the old refcount.
Definition: astobj2.h:459
#define ao2_t_alloc(data_size, destructor_fn, debug_msg)
Definition: astobj2.h:407
const char * stasis_topic_name(const struct stasis_topic *topic)
Return the name of a topic.
Definition: stasis.c:627
static struct ast_threadpool * threadpool
Definition: stasis.c:307
static int topic_add_subscription(struct stasis_topic *topic, struct stasis_subscription *sub)
Add a subscriber to a topic.
Definition: stasis.c:1201
static void subscription_dtor(void *obj)
Definition: stasis.c:714
static void send_subscription_subscribe(struct stasis_topic *topic, struct stasis_subscription *sub)
Definition: stasis.c:1648
@ STASIS_SUBSCRIPTION_FILTER_NONE
Definition: stasis.h:295
struct stasis_topic * topic
Definition: stasis.c:684
stasis_subscription_cb callback
Definition: stasis.c:688
int subscriber_id
Definition: stasis.c:383
struct ast_taskprocessor * ast_taskprocessor_get(const char *name, enum ast_tps_options create)
Get a reference to a taskprocessor with the specified name and create the taskprocessor if necessary.
void ast_taskprocessor_set_local(struct ast_taskprocessor *tps, void *local_data)
Sets the local data associated with a taskprocessor.
@ TPS_REF_DEFAULT
return a reference to a taskprocessor, create one if it does not exist
Definition: taskprocessor.h:76
void ast_taskprocessor_build_name(char *buf, unsigned int size, const char *format,...)
Build a taskprocessor name with a sequence number on the end.
#define AST_TASKPROCESSOR_MAX_NAME
Suggested maximum taskprocessor name length (less null terminator).
Definition: taskprocessor.h:61
struct ast_taskprocessor * ast_threadpool_serializer(const char *name, struct ast_threadpool *pool)
Serialized execution of tasks within a ast_threadpool.
Definition: threadpool.c:1428
static void statistics(void)
Definition: utils/frame.c:287
#define AST_VECTOR_INIT(vec, size)
Initialize a vector.
Definition: vector.h:113

References ao2_ref, ao2_t_alloc, ast_asprintf, ast_atomic_fetchadd_int(), ast_cond_init, ast_taskprocessor_build_name(), ast_taskprocessor_get(), AST_TASKPROCESSOR_MAX_NAME, ast_taskprocessor_set_local(), ast_threadpool_serializer(), AST_VECTOR_INIT, stasis_subscription::callback, stasis_subscription::data, make_ari_stubs::file, NULL, send_subscription_subscribe(), STASIS_SUBSCRIPTION_FILTER_NONE, STASIS_SUBSCRIPTION_FORMATTER_NONE, stasis_topic_name(), statistics(), sub, stasis_topic::subscriber_id, subscription_dtor(), threadpool, stasis_subscription::topic, topic_add_subscription(), and TPS_REF_DEFAULT.

Referenced by __stasis_subscribe(), __stasis_subscribe_pool(), and stasis_caching_topic_create().

◆ link_topic_proxy()

static int link_topic_proxy ( struct stasis_topic topic,
const char *  name,
const char *  detail 
)
static

Definition at line 500 of file stasis.c.

501{
502 struct topic_proxy *proxy;
503 struct stasis_topic* topic_tmp;
504 size_t detail_len;
505
506 if (!topic || !name || !strlen(name) || !detail) {
507 return -1;
508 }
509
511
512 topic_tmp = stasis_topic_get(name);
513 if (topic_tmp) {
514 ast_log(LOG_ERROR, "The same topic is already exist. name: %s\n", name);
515 ao2_ref(topic_tmp, -1);
517
518 return -1;
519 }
520
521 detail_len = strlen(detail) + 1;
522
523 proxy = ao2_t_weakproxy_alloc(
524 sizeof(*proxy) + strlen(name) + 1 + detail_len, NULL, name);
525 if (!proxy) {
527
528 return -1;
529 }
530
531 /* set the proxy info */
532 proxy->name = proxy->buf;
533 proxy->detail = proxy->name + strlen(name) + 1;
534
535 strcpy(proxy->name, name); /* SAFE */
536 ast_copy_string(proxy->detail, detail, detail_len); /* SAFE */
537 proxy->creationtime = ast_tvnow();
538
539 /* We have exclusive access to proxy, no need for locking here. */
540 if (ao2_t_weakproxy_set_object(proxy, topic, OBJ_NOLOCK, "weakproxy link")) {
541 ao2_cleanup(proxy);
543
544 return -1;
545 }
546
548 ao2_cleanup(proxy);
551
552 return -1;
553 }
554
555 /* setting the topic point to the proxy */
556 topic->name = proxy->name;
557 topic->detail = proxy->detail;
558 topic->creationtime = &(proxy->creationtime);
559
561 ao2_ref(proxy, -1);
562
564
565 return 0;
566}
int ao2_weakproxy_subscribe(void *weakproxy, ao2_weakproxy_notification_cb cb, void *data, int flags)
Request notification when weakproxy points to NULL.
Definition: astobj2.c:934
#define ao2_wrlock(a)
Definition: astobj2.h:719
#define ao2_link_flags(container, obj, flags)
Add an object to a container.
Definition: astobj2.h:1554
#define ao2_t_weakproxy_alloc(data_size, destructor_fn, tag)
Definition: astobj2.h:553
#define ao2_unlock(a)
Definition: astobj2.h:729
@ OBJ_NOLOCK
Assume that the ao2_container is already locked.
Definition: astobj2.h:1063
#define ao2_t_weakproxy_set_object(weakproxy, obj, flags, tag)
Definition: astobj2.h:582
static const char name[]
Definition: format_mp3.c:68
struct stasis_topic * stasis_topic_get(const char *name)
Get a topic of the given name.
Definition: stasis.c:622
static void proxy_dtor(void *weakproxy, void *container)
Definition: stasis.c:412
struct ao2_container * topic_all
Definition: stasis.c:395
void ast_copy_string(char *dst, const char *src, size_t size)
Size-limited null-terminating string copy.
Definition: strings.h:425
char * name
Definition: stasis.c:386
char * detail
Definition: stasis.c:389
struct timeval * creationtime
Definition: stasis.c:392
char buf[0]
Definition: stasis.c:405
struct timeval creationtime
Definition: stasis.c:403
char * name
Definition: stasis.c:400
char * detail
Definition: stasis.c:401
struct timeval ast_tvnow(void)
Returns current timeval. Meant to replace calls to gettimeofday().
Definition: time.h:159

References ao2_bump, ao2_cleanup, ao2_link_flags, ao2_ref, ao2_t_weakproxy_alloc, ao2_t_weakproxy_set_object, ao2_unlock, ao2_weakproxy_subscribe(), ao2_wrlock, ast_copy_string(), ast_log, ast_tvnow(), topic_proxy::buf, stasis_topic::creationtime, topic_proxy::creationtime, stasis_topic::detail, topic_proxy::detail, LOG_ERROR, name, stasis_topic::name, topic_proxy::name, NULL, OBJ_NOLOCK, proxy_dtor(), stasis_topic_get(), and topic_all.

Referenced by stasis_topic_create_with_detail().

◆ multi_object_blob_dtor()

static void multi_object_blob_dtor ( void *  obj)
static

Definition at line 1959 of file stasis.c.

1960{
1961 struct ast_multi_object_blob *multi = obj;
1962 int type;
1963 int i;
1964
1965 for (type = 0; type < STASIS_UMOS_MAX; ++type) {
1966 for (i = 0; i < AST_VECTOR_SIZE(&multi->snapshots[type]); ++i) {
1968 }
1969 AST_VECTOR_FREE(&multi->snapshots[type]);
1970 }
1971 ast_json_unref(multi->blob);
1972}
static const char type[]
Definition: chan_ooh323.c:109
#define STASIS_UMOS_MAX
Number of snapshot types.
Definition: stasis.h:1360
void ast_json_unref(struct ast_json *value)
Decrease refcount on value. If refcount reaches zero, value is freed.
Definition: json.c:73
A multi object blob data structure to carry user event stasis messages.
Definition: stasis.c:1950
struct ast_multi_object_blob::@395 snapshots[STASIS_UMOS_MAX]
struct ast_json * blob
Definition: stasis.c:1951
#define AST_VECTOR_FREE(vec)
Deallocates this vector.
Definition: vector.h:174

References ao2_cleanup, ast_json_unref(), AST_VECTOR_FREE, AST_VECTOR_GET, AST_VECTOR_SIZE, ast_multi_object_blob::blob, ast_multi_object_blob::snapshots, STASIS_UMOS_MAX, and type.

Referenced by ast_multi_object_blob_create().

◆ multi_object_blob_to_ami()

static struct ast_str * multi_object_blob_to_ami ( void *  obj)
static

Definition at line 2096 of file stasis.c.

2097{
2098 struct ast_str *ami_str=ast_str_create(1024);
2099 struct ast_str *ami_snapshot;
2100 const struct ast_multi_object_blob *multi = obj;
2102 int i;
2103
2104 if (!ami_str) {
2105 return NULL;
2106 }
2107 if (!multi) {
2108 ast_free(ami_str);
2109 return NULL;
2110 }
2111
2112 for (type = 0; type < STASIS_UMOS_MAX; ++type) {
2113 for (i = 0; i < AST_VECTOR_SIZE(&multi->snapshots[type]); ++i) {
2114 char *name = NULL;
2115 void *snapshot = AST_VECTOR_GET(&multi->snapshots[type], i);
2116 ami_snapshot = NULL;
2117
2118 if (i > 0) {
2119 ast_asprintf(&name, "%d", i + 1);
2120 }
2121
2122 switch (type) {
2124 ami_snapshot = ast_manager_build_channel_state_string_prefix(snapshot, name ?: "");
2125 break;
2126
2127 case STASIS_UMOS_BRIDGE:
2128 ami_snapshot = ast_manager_build_bridge_state_string_prefix(snapshot, name ?: "");
2129 break;
2130
2132 /* currently not sending endpoint snapshots to AMI */
2133 break;
2134 }
2135 if (ami_snapshot) {
2136 ast_str_append(&ami_str, 0, "%s", ast_str_buffer(ami_snapshot));
2137 ast_free(ami_snapshot);
2138 }
2139 ast_free(name);
2140 }
2141 }
2142
2143 return ami_str;
2144}
#define ast_free(a)
Definition: astmm.h:180
stasis_user_multi_object_snapshot_type
Object type code for multi user object snapshots.
Definition: stasis.h:1353
@ STASIS_UMOS_ENDPOINT
Definition: stasis.h:1356
@ STASIS_UMOS_BRIDGE
Definition: stasis.h:1355
@ STASIS_UMOS_CHANNEL
Definition: stasis.h:1354
struct ast_str * ast_manager_build_bridge_state_string_prefix(const struct ast_bridge_snapshot *snapshot, const char *prefix)
Generate the AMI message body from a bridge snapshot.
struct ast_str * ast_manager_build_channel_state_string_prefix(const struct ast_channel_snapshot *snapshot, const char *prefix)
Generate the AMI message body from a channel snapshot.
int ast_str_append(struct ast_str **buf, ssize_t max_len, const char *fmt,...)
Append to a thread local dynamic string.
Definition: strings.h:1139
char * ast_str_buffer(const struct ast_str *buf)
Returns the string buffer within the ast_str buf.
Definition: strings.h:761
#define ast_str_create(init_len)
Create a malloc'ed dynamic length string.
Definition: strings.h:659
Support for dynamic strings.
Definition: strings.h:623

References ast_asprintf, ast_free, ast_manager_build_bridge_state_string_prefix(), ast_manager_build_channel_state_string_prefix(), ast_str_append(), ast_str_buffer(), ast_str_create, AST_VECTOR_GET, AST_VECTOR_SIZE, name, NULL, ast_multi_object_blob::snapshots, STASIS_UMOS_BRIDGE, STASIS_UMOS_CHANNEL, STASIS_UMOS_ENDPOINT, STASIS_UMOS_MAX, and type.

Referenced by multi_user_event_to_ami().

◆ multi_user_event_to_ami()

static struct ast_manager_event_blob * multi_user_event_to_ami ( struct stasis_message message)
static

Definition at line 2155 of file stasis.c.

2157{
2158 RAII_VAR(struct ast_str *, object_string, NULL, ast_free);
2159 RAII_VAR(struct ast_str *, body, NULL, ast_free);
2161 const char *eventname;
2162
2163 eventname = ast_json_string_get(ast_json_object_get(multi->blob, "eventname"));
2165 object_string = multi_object_blob_to_ami(multi);
2166 if (!object_string || !body) {
2167 return NULL;
2168 }
2169
2171 "%s"
2172 "UserEvent: %s\r\n"
2173 "%s",
2174 ast_str_buffer(object_string),
2175 eventname,
2176 ast_str_buffer(body));
2177}
struct ast_str * ast_manager_str_from_json_object(struct ast_json *blob, key_exclusion_cb exclusion_cb)
Convert a JSON object into an AMI compatible string.
Definition: manager.c:1973
const char * ast_json_string_get(const struct ast_json *string)
Get the value of a JSON string.
Definition: json.c:283
struct ast_json * ast_json_object_get(struct ast_json *object, const char *key)
Get a field from a JSON object.
Definition: json.c:407
struct ast_manager_event_blob * ast_manager_event_blob_create(int event_flags, const char *manager_event, const char *extra_fields_fmt,...)
Construct a ast_manager_event_blob.
Definition: manager.c:10548
#define EVENT_FLAG_USER
Definition: manager.h:81
static struct ast_str * multi_object_blob_to_ami(void *obj)
Definition: stasis.c:2096
static int userevent_exclusion_cb(const char *key)
Definition: stasis.c:2147
void * stasis_message_data(const struct stasis_message *msg)
Get the data contained in a message.
#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:941

References ast_free, ast_json_object_get(), ast_json_string_get(), ast_manager_event_blob_create(), ast_manager_str_from_json_object(), ast_str_buffer(), ast_multi_object_blob::blob, EVENT_FLAG_USER, multi_object_blob_to_ami(), NULL, RAII_VAR, stasis_message_data(), and userevent_exclusion_cb().

◆ multi_user_event_to_json()

static struct ast_json * multi_user_event_to_json ( struct stasis_message message,
const struct stasis_message_sanitizer sanitize 
)
static

Definition at line 2045 of file stasis.c.

2048{
2049 struct ast_json *out;
2051 struct ast_json *blob = multi->blob;
2052 const struct timeval *tv = stasis_message_timestamp(message);
2054 int i;
2055
2057 if (!out) {
2058 return NULL;
2059 }
2060
2061 ast_json_object_set(out, "type", ast_json_string_create("ChannelUserevent"));
2062 ast_json_object_set(out, "timestamp", ast_json_timeval(*tv, NULL));
2063 ast_json_object_set(out, "eventname", ast_json_ref(ast_json_object_get(blob, "eventname")));
2064 ast_json_object_set(out, "userevent", ast_json_ref(blob));
2065
2066 for (type = 0; type < STASIS_UMOS_MAX; ++type) {
2067 for (i = 0; i < AST_VECTOR_SIZE(&multi->snapshots[type]); ++i) {
2068 struct ast_json *json_object = NULL;
2069 char *name = NULL;
2070 void *snapshot = AST_VECTOR_GET(&multi->snapshots[type], i);
2071
2072 switch (type) {
2074 json_object = ast_channel_snapshot_to_json(snapshot, sanitize);
2075 name = "channel";
2076 break;
2077 case STASIS_UMOS_BRIDGE:
2078 json_object = ast_bridge_snapshot_to_json(snapshot, sanitize);
2079 name = "bridge";
2080 break;
2082 json_object = ast_endpoint_snapshot_to_json(snapshot, sanitize);
2083 name = "endpoint";
2084 break;
2085 }
2086 if (json_object) {
2087 ast_json_object_set(out, name, json_object);
2088 }
2089 }
2090 }
2091
2092 return out;
2093}
struct ast_json * ast_json_string_create(const char *value)
Construct a JSON string from value.
Definition: json.c:278
struct ast_json * ast_json_object_create(void)
Create a new JSON object.
Definition: json.c:399
struct ast_json * ast_json_timeval(const struct timeval tv, const char *zone)
Construct a timeval as JSON.
Definition: json.c:670
struct ast_json * ast_json_ref(struct ast_json *value)
Increase refcount on value.
Definition: json.c:67
int ast_json_object_set(struct ast_json *object, const char *key, struct ast_json *value)
Set a field in a JSON object.
Definition: json.c:414
const struct timeval * stasis_message_timestamp(const struct stasis_message *msg)
Get the time when a message was created.
struct ast_json * ast_bridge_snapshot_to_json(const struct ast_bridge_snapshot *snapshot, const struct stasis_message_sanitizer *sanitize)
Build a JSON object from a ast_bridge_snapshot.
struct ast_json * ast_channel_snapshot_to_json(const struct ast_channel_snapshot *snapshot, const struct stasis_message_sanitizer *sanitize)
Build a JSON object from a ast_channel_snapshot.
struct ast_json * ast_endpoint_snapshot_to_json(const struct ast_endpoint_snapshot *snapshot, const struct stasis_message_sanitizer *sanitize)
Build a JSON object from a ast_endpoint_snapshot.
Abstract JSON element (object, array, string, int, ...).
FILE * out
Definition: utils/frame.c:33

References ast_bridge_snapshot_to_json(), ast_channel_snapshot_to_json(), ast_endpoint_snapshot_to_json(), ast_json_object_create(), ast_json_object_get(), ast_json_object_set(), ast_json_ref(), ast_json_string_create(), ast_json_timeval(), AST_VECTOR_GET, AST_VECTOR_SIZE, ast_multi_object_blob::blob, name, NULL, out, ast_multi_object_blob::snapshots, stasis_message_data(), stasis_message_timestamp(), STASIS_UMOS_BRIDGE, STASIS_UMOS_CHANNEL, STASIS_UMOS_ENDPOINT, STASIS_UMOS_MAX, and type.

◆ proxy_dtor()

static void proxy_dtor ( void *  weakproxy,
void *  container 
)
static

Definition at line 412 of file stasis.c.

413{
414 ao2_unlink(container, weakproxy);
416}
#define ao2_unlink(container, obj)
Remove an object from a container.
Definition: astobj2.h:1578
struct ao2_container * container
Definition: res_fax.c:501

References ao2_cleanup, ao2_unlink, and container.

Referenced by link_topic_proxy().

◆ publish_msg()

static void publish_msg ( struct stasis_topic topic,
struct stasis_message message,
struct stasis_subscription sync_sub 
)
static

Definition at line 1430 of file stasis.c.

1432{
1433 size_t i;
1434#ifdef AST_DEVMODE
1435 unsigned int dispatched = 0;
1437 struct stasis_message_type_statistics *statistics;
1438 struct timeval start;
1439 long elapsed;
1440#endif
1441
1442 ast_assert(topic != NULL);
1444
1445#ifdef AST_DEVMODE
1446 ast_mutex_lock(&message_type_statistics_lock);
1447 if (message_type_id >= AST_VECTOR_SIZE(&message_type_statistics)) {
1448 struct stasis_message_type_statistics new_statistics = {
1449 .published = 0,
1450 };
1451 if (AST_VECTOR_REPLACE(&message_type_statistics, message_type_id, new_statistics)) {
1452 ast_mutex_unlock(&message_type_statistics_lock);
1453 return;
1454 }
1455 }
1456 statistics = AST_VECTOR_GET_ADDR(&message_type_statistics, message_type_id);
1457 statistics->message_type = stasis_message_type(message);
1458 ast_mutex_unlock(&message_type_statistics_lock);
1459
1460 ast_atomic_fetchadd_int(&statistics->published, +1);
1461#endif
1462
1463 /* If there are no subscribers don't bother */
1464 if (!stasis_topic_subscribers(topic)) {
1465#ifdef AST_DEVMODE
1466 ast_atomic_fetchadd_int(&statistics->unused, +1);
1467 ast_atomic_fetchadd_int(&topic->statistics->messages_not_dispatched, +1);
1468#endif
1469 return;
1470 }
1471
1472 /*
1473 * The topic may be unref'ed by the subscription invocation.
1474 * Make sure we hold onto a reference while dispatching.
1475 */
1476 ao2_ref(topic, +1);
1477#ifdef AST_DEVMODE
1478 start = ast_tvnow();
1479#endif
1480 ao2_lock(topic);
1481 for (i = 0; i < AST_VECTOR_SIZE(&topic->subscribers); ++i) {
1483
1484 ast_assert(sub != NULL);
1485#ifdef AST_DEVMODE
1486 dispatched +=
1487#endif
1488 dispatch_message(sub, message, (sub == sync_sub));
1489 }
1491
1492#ifdef AST_DEVMODE
1493 elapsed = ast_tvdiff_ms(ast_tvnow(), start);
1494 if (elapsed > topic->statistics->highest_time_dispatched) {
1495 topic->statistics->highest_time_dispatched = elapsed;
1496 }
1497 if (elapsed < topic->statistics->lowest_time_dispatched) {
1498 topic->statistics->lowest_time_dispatched = elapsed;
1499 }
1500 if (dispatched) {
1501 ast_atomic_fetchadd_int(&topic->statistics->messages_dispatched, +1);
1502 } else {
1503 ast_atomic_fetchadd_int(&statistics->unused, +1);
1504 ast_atomic_fetchadd_int(&topic->statistics->messages_not_dispatched, +1);
1505 }
1506#endif
1507
1508 ao2_ref(topic, -1);
1509}
#define ao2_lock(a)
Definition: astobj2.h:717
size_t stasis_topic_subscribers(const struct stasis_topic *topic)
Return the number of subscribers of a topic.
Definition: stasis.c:643
static unsigned int dispatch_message(struct stasis_subscription *sub, struct stasis_message *message, int synchronous)
Definition: stasis.c:1312
static int message_type_id
struct stasis_topic::@392 subscribers
int64_t ast_tvdiff_ms(struct timeval end, struct timeval start)
Computes the difference (in milliseconds) between two struct timeval instances.
Definition: time.h:107
#define ast_assert(a)
Definition: utils.h:739
#define AST_VECTOR_REPLACE(vec, idx, elem)
Replace an element at a specific position in a vector, growing the vector if needed.
Definition: vector.h:284
#define AST_VECTOR_GET_ADDR(vec, idx)
Get an address of element in a vector.
Definition: vector.h:668

References ao2_lock, ao2_ref, ao2_unlock, ast_assert, ast_atomic_fetchadd_int(), ast_mutex_lock, ast_mutex_unlock, ast_tvdiff_ms(), ast_tvnow(), AST_VECTOR_GET, AST_VECTOR_GET_ADDR, AST_VECTOR_REPLACE, AST_VECTOR_SIZE, dispatch_message(), message_type_id, NULL, stasis_message_type(), stasis_message_type_id(), stasis_topic_subscribers(), statistics(), sub, stasis_topic::subscribers, and stasis_subscription::topic.

Referenced by stasis_publish(), and stasis_publish_sync().

◆ send_subscription_subscribe()

static void send_subscription_subscribe ( struct stasis_topic topic,
struct stasis_subscription sub 
)
static

Definition at line 1648 of file stasis.c.

1649{
1650 struct stasis_subscription_change *change;
1651 struct stasis_message *msg;
1652
1653 /* This assumes that we have already unsubscribed */
1655
1657 return;
1658 }
1659
1660 change = subscription_change_alloc(topic, sub->uniqueid, "Subscribe");
1661 if (!change) {
1662 return;
1663 }
1664
1666 if (!msg) {
1667 ao2_cleanup(change);
1668 return;
1669 }
1670
1671 stasis_publish(topic, msg);
1672 ao2_cleanup(msg);
1673 ao2_cleanup(change);
1674}
struct stasis_message_type * stasis_subscription_change_type(void)
Gets the message type for subscription change notices.
static struct stasis_subscription_change * subscription_change_alloc(struct stasis_topic *topic, const char *uniqueid, const char *description)
Definition: stasis.c:1627
void stasis_publish(struct stasis_topic *topic, struct stasis_message *message)
Publish a message to a topic's subscribers.
Definition: stasis.c:1511
int stasis_subscription_is_subscribed(const struct stasis_subscription *sub)
Returns whether a subscription is currently subscribed.
Definition: stasis.c:1150
struct stasis_message * stasis_message_create(struct stasis_message_type *type, void *data)
Create a new message.
Holds details about changes to subscriptions for the specified topic.
Definition: stasis.h:890

References ao2_cleanup, ast_assert, stasis_message_create(), stasis_publish(), stasis_subscription_change_type(), stasis_subscription_is_subscribed(), sub, and subscription_change_alloc().

Referenced by internal_stasis_subscribe().

◆ send_subscription_unsubscribe()

static void send_subscription_unsubscribe ( struct stasis_topic topic,
struct stasis_subscription sub 
)
static

Definition at line 1676 of file stasis.c.

1678{
1679 struct stasis_subscription_change *change;
1680 struct stasis_message *msg;
1681
1682 /* This assumes that we have already unsubscribed */
1684
1686 return;
1687 }
1688
1689 change = subscription_change_alloc(topic, sub->uniqueid, "Unsubscribe");
1690 if (!change) {
1691 return;
1692 }
1693
1695 if (!msg) {
1696 ao2_cleanup(change);
1697 return;
1698 }
1699
1700 stasis_publish(topic, msg);
1701
1702 /* Now we have to dispatch to the subscription itself */
1703 dispatch_message(sub, msg, 0);
1704
1705 ao2_cleanup(msg);
1706 ao2_cleanup(change);
1707}

References ao2_cleanup, ast_assert, dispatch_message(), stasis_message_create(), stasis_publish(), stasis_subscription_change_type(), stasis_subscription_is_subscribed(), sub, and subscription_change_alloc().

Referenced by stasis_unsubscribe().

◆ stasis_cleanup()

static void stasis_cleanup ( void  )
static

Cleanup function for graceful shutdowns.

Definition at line 3042 of file stasis.c.

3043{
3044#ifdef AST_DEVMODE
3045 ast_cli_unregister_multiple(cli_stasis_statistics, ARRAY_LEN(cli_stasis_statistics));
3046 AST_VECTOR_FREE(&message_type_statistics);
3047 ao2_global_obj_release(subscription_statistics);
3048 ao2_global_obj_release(topic_statistics);
3049#endif
3052 topic_all = NULL;
3054 threadpool = NULL;
3057 aco_info_destroy(&cfg_info);
3059}
#define ao2_global_obj_release(holder)
Release the ao2 object held in the global holder.
Definition: astobj2.h:859
static struct console_pvt globals
int ast_cli_unregister_multiple(struct ast_cli_entry *e, int len)
Unregister multiple commands.
Definition: clicompat.c:30
void aco_info_destroy(struct aco_info *info)
Destroy an initialized aco_info struct.
struct stasis_message_type * ast_multi_user_event_type(void)
Message type for custom user defined events with multi object blobs.
static struct ast_cli_entry cli_stasis[]
Definition: stasis.c:2476
#define STASIS_MESSAGE_TYPE_CLEANUP(name)
Boiler-plate messaging macro for cleaning up message types.
Definition: stasis.h:1515
void ast_threadpool_shutdown(struct ast_threadpool *pool)
Shut down a threadpool and destroy it.
Definition: threadpool.c:966
#define ARRAY_LEN(a)
Definition: utils.h:666

References aco_info_destroy(), ao2_cleanup, ao2_global_obj_release, ARRAY_LEN, ast_cli_unregister_multiple(), ast_multi_user_event_type(), ast_threadpool_shutdown(), AST_VECTOR_FREE, cli_stasis, globals, NULL, STASIS_MESSAGE_TYPE_CLEANUP, stasis_subscription_change_type(), threadpool, and topic_all.

Referenced by stasis_init().

◆ stasis_config_alloc()

static void * stasis_config_alloc ( void  )
static

Definition at line 2253 of file stasis.c.

2254{
2255 struct stasis_config *cfg;
2256
2257 if (!(cfg = ao2_alloc(sizeof(*cfg), stasis_config_destructor))) {
2258 return NULL;
2259 }
2260
2261 cfg->threadpool_options = ast_calloc(1, sizeof(*cfg->threadpool_options));
2262 if (!cfg->threadpool_options) {
2263 ao2_ref(cfg, -1);
2264 return NULL;
2265 }
2266
2269 if (!cfg->declined_message_types) {
2270 ao2_ref(cfg, -1);
2271 return NULL;
2272 }
2273
2275 if (!cfg->declined_message_types->declined) {
2276 ao2_ref(cfg, -1);
2277 return NULL;
2278 }
2279
2280 return cfg;
2281}
#define ast_calloc(num, len)
A wrapper for calloc()
Definition: astmm.h:202
#define ao2_alloc(data_size, destructor_fn)
Definition: astobj2.h:409
static void stasis_config_destructor(void *obj)
Definition: stasis.c:2245
static void stasis_declined_config_destructor(void *obj)
Definition: stasis.c:2238
#define ast_str_container_alloc(buckets)
Allocates a hash container for bare strings.
Definition: strings.h:1365
struct stasis_declined_config * declined_message_types
Definition: stasis.c:2199
struct stasis_threadpool_conf * threadpool_options
Definition: stasis.c:2197

References ao2_alloc, ao2_ref, ast_calloc, ast_str_container_alloc, stasis_declined_config::declined, stasis_config::declined_message_types, NULL, stasis_config_destructor(), stasis_declined_config_destructor(), and stasis_config::threadpool_options.

Referenced by stasis_init().

◆ stasis_config_destructor()

static void stasis_config_destructor ( void *  obj)
static

Definition at line 2245 of file stasis.c.

2246{
2247 struct stasis_config *cfg = obj;
2248
2251}

References ao2_cleanup, ast_free, stasis_config::declined_message_types, and stasis_config::threadpool_options.

Referenced by stasis_config_alloc().

◆ stasis_declined_config_destructor()

static void stasis_declined_config_destructor ( void *  obj)
static

Definition at line 2238 of file stasis.c.

2239{
2240 struct stasis_declined_config *declined = obj;
2241
2242 ao2_cleanup(declined->declined);
2243}

References ao2_cleanup, and stasis_declined_config::declined.

Referenced by stasis_config_alloc().

◆ stasis_forward_all()

struct stasis_forward * stasis_forward_all ( struct stasis_topic from_topic,
struct stasis_topic to_topic 
)

Create a subscription which forwards all messages from one topic to another.

Note that the topic parameter of the invoked callback will the be the topic the message was sent to, not the topic the subscriber subscribed to.

Parameters
from_topicTopic to forward.
to_topicDestination topic of forwarded messages.
Returns
New forwarding subscription.
Return values
NULLon error.
Since
12

Definition at line 1578 of file stasis.c.

1580{
1581 int res;
1582 size_t idx;
1583 struct stasis_forward *forward;
1584
1585 if (!from_topic || !to_topic) {
1586 return NULL;
1587 }
1588
1589 forward = ao2_alloc_options(sizeof(*forward), forward_dtor, AO2_ALLOC_OPT_LOCK_NOLOCK);
1590 if (!forward) {
1591 return NULL;
1592 }
1593
1594 /* Forwards to ourselves are implicit. */
1595 if (to_topic == from_topic) {
1596 return forward;
1597 }
1598
1599 forward->from_topic = ao2_bump(from_topic);
1600 forward->to_topic = ao2_bump(to_topic);
1601
1604 if (res != 0) {
1607 ao2_ref(forward, -1);
1608 return NULL;
1609 }
1610
1611 for (idx = 0; idx < AST_VECTOR_SIZE(&to_topic->subscribers); ++idx) {
1613 }
1616
1617 return forward;
1618}
@ AO2_ALLOC_OPT_LOCK_NOLOCK
Definition: astobj2.h:367
#define ao2_alloc_options(data_size, destructor_fn, options)
Definition: astobj2.h:404
static void forward_dtor(void *obj)
Definition: stasis.c:1538
#define topic_lock_both(topic1, topic2)
Lock two topics.
Definition: stasis.c:425
struct stasis_topic::@393 upstream_topics
#define AST_VECTOR_APPEND(vec, elem)
Append an element to a vector, growing the vector if needed.
Definition: vector.h:256

References AO2_ALLOC_OPT_LOCK_NOLOCK, ao2_alloc_options, ao2_bump, ao2_ref, ao2_unlock, AST_VECTOR_APPEND, AST_VECTOR_GET, AST_VECTOR_SIZE, forward_dtor(), stasis_forward::from_topic, NULL, stasis_topic::subscribers, stasis_forward::to_topic, topic_add_subscription(), topic_lock_both, and stasis_topic::upstream_topics.

Referenced by __init_manager(), ari_bridges_play_new(), ast_ari_bridges_record(), ast_channel_forward_endpoint(), ast_channel_internal_setup_topics(), AST_TEST_DEFINE(), create_subscriptions(), endpoint_internal_create(), forwards_create_bridge(), forwards_create_channel(), forwards_create_endpoint(), load_general_config(), load_module(), manager_bridging_init(), manager_channels_init(), manager_mwi_init(), manager_subscriptions_init(), manager_system_init(), stasis_cp_all_create(), stasis_cp_single_create(), stasis_topic_pool_get_topic(), and state_alloc().

◆ stasis_forward_cancel()

struct stasis_forward * stasis_forward_cancel ( struct stasis_forward forward)

Definition at line 1548 of file stasis.c.

1549{
1550 int idx;
1551 struct stasis_topic *from;
1552 struct stasis_topic *to;
1553
1554 if (!forward) {
1555 return NULL;
1556 }
1557
1558 from = forward->from_topic;
1559 to = forward->to_topic;
1560
1561 if (from && to) {
1562 topic_lock_both(to, from);
1565
1566 for (idx = 0; idx < AST_VECTOR_SIZE(&to->subscribers); ++idx) {
1568 }
1569 ao2_unlock(from);
1570 ao2_unlock(to);
1571 }
1572
1573 ao2_cleanup(forward);
1574
1575 return NULL;
1576}
static int topic_remove_subscription(struct stasis_topic *topic, struct stasis_subscription *sub)
Definition: stasis.c:1229
#define AST_VECTOR_ELEM_CLEANUP_NOOP(elem)
Vector element cleanup that does nothing.
Definition: vector.h:571
#define AST_VECTOR_REMOVE_ELEM_UNORDERED(vec, elem, cleanup)
Remove an element from a vector.
Definition: vector.h:583

References ao2_cleanup, ao2_unlock, AST_VECTOR_ELEM_CLEANUP_NOOP, AST_VECTOR_GET, AST_VECTOR_REMOVE_ELEM_UNORDERED, AST_VECTOR_SIZE, stasis_forward::from_topic, NULL, stasis_topic::subscribers, stasis_forward::to_topic, topic_lock_both, topic_remove_subscription(), and stasis_topic::upstream_topics.

Referenced by all_dtor(), ari_bridges_play_new(), ast_ari_bridges_record(), ast_channel_internal_cleanup(), ast_endpoint_shutdown(), AST_TEST_DEFINE(), bridge_channel_control_thread(), cleanup_module(), destroy_subscriptions(), forwards_unsubscribe(), load_general_config(), load_module(), manager_bridging_cleanup(), manager_channels_shutdown(), manager_mwi_shutdown(), manager_shutdown(), manager_system_shutdown(), stasis_cp_single_unsubscribe(), state_dtor(), topic_pool_entry_dtor(), and unload_module().

◆ stasis_init()

int stasis_init ( void  )

Initialize the Stasis subsystem.

Returns
0 on success.
Non-zero on error.
Since
12

Definition at line 3061 of file stasis.c.

3062{
3063 struct stasis_config *cfg;
3064 int cache_init;
3065 struct ast_threadpool_options threadpool_opts = { 0, };
3066#ifdef AST_DEVMODE
3067 struct ao2_container *subscription_stats;
3068 struct ao2_container *topic_stats;
3069#endif
3070
3071 /* Be sure the types are cleaned up after the message bus */
3073
3074 if (aco_info_init(&cfg_info)) {
3075 return -1;
3076 }
3077
3078 aco_option_register_custom(&cfg_info, "decline", ACO_EXACT,
3080 aco_option_register(&cfg_info, "initial_size", ACO_EXACT,
3082 FLDSET(struct stasis_threadpool_conf, initial_size), 0,
3083 INT_MAX);
3084 aco_option_register(&cfg_info, "idle_timeout_sec", ACO_EXACT,
3086 FLDSET(struct stasis_threadpool_conf, idle_timeout_sec), 0,
3087 INT_MAX);
3088 aco_option_register(&cfg_info, "max_size", ACO_EXACT,
3090 FLDSET(struct stasis_threadpool_conf, max_size), 0,
3091 INT_MAX);
3092
3093 if (aco_process_config(&cfg_info, 0) == ACO_PROCESS_ERROR) {
3094 struct stasis_config *default_cfg = stasis_config_alloc();
3095
3096 if (!default_cfg) {
3097 return -1;
3098 }
3099
3100 if (aco_set_defaults(&threadpool_option, "threadpool", default_cfg->threadpool_options)) {
3101 ast_log(LOG_ERROR, "Failed to initialize defaults on Stasis configuration object\n");
3102 ao2_ref(default_cfg, -1);
3103
3104 return -1;
3105 }
3106
3107 if (aco_set_defaults(&declined_option, "declined_message_types", default_cfg->declined_message_types)) {
3108 ast_log(LOG_ERROR, "Failed to load stasis.conf and failed to initialize defaults.\n");
3109 ao2_ref(default_cfg, -1);
3110
3111 return -1;
3112 }
3113
3114 ast_log(LOG_NOTICE, "Could not load Stasis configuration; using defaults\n");
3116 cfg = default_cfg;
3117 } else {
3119 if (!cfg) {
3120 ast_log(LOG_ERROR, "Failed to obtain Stasis configuration object\n");
3121
3122 return -1;
3123 }
3124 }
3125
3126 threadpool_opts.version = AST_THREADPOOL_OPTIONS_VERSION;
3127 threadpool_opts.initial_size = cfg->threadpool_options->initial_size;
3128 threadpool_opts.auto_increment = 1;
3129 threadpool_opts.max_size = cfg->threadpool_options->max_size;
3130 threadpool_opts.idle_timeout = cfg->threadpool_options->idle_timeout_sec;
3131 threadpool = ast_threadpool_create("stasis", NULL, &threadpool_opts);
3132 ao2_ref(cfg, -1);
3133 if (!threadpool) {
3134 ast_log(LOG_ERROR, "Failed to create 'stasis-core' threadpool\n");
3135
3136 return -1;
3137 }
3138
3139 cache_init = stasis_cache_init();
3140 if (cache_init != 0) {
3141 return -1;
3142 }
3143
3145 return -1;
3146 }
3148 return -1;
3149 }
3150
3152 topic_proxy_hash_fn, 0, topic_proxy_cmp_fn);
3153 if (!topic_all) {
3154 return -1;
3155 }
3156
3158 return -1;
3159 }
3160
3161#ifdef AST_DEVMODE
3162 /* Statistics information is stored separately so that we don't alter or interrupt the lifetime of the underlying
3163 * topic or subscripton.
3164 */
3165 subscription_stats = ao2_container_alloc_hash(AO2_ALLOC_OPT_LOCK_MUTEX, 0, SUBSCRIPTION_STATISTICS_BUCKETS,
3166 subscription_statistics_hash, 0, subscription_statistics_cmp);
3167 if (!subscription_stats) {
3168 return -1;
3169 }
3170 ao2_global_obj_replace_unref(subscription_statistics, subscription_stats);
3171 ao2_cleanup(subscription_stats);
3172
3173 topic_stats = ao2_container_alloc_hash(AO2_ALLOC_OPT_LOCK_MUTEX, 0, TOPIC_STATISTICS_BUCKETS,
3174 topic_statistics_hash, 0, topic_statistics_cmp);
3175 if (!topic_stats) {
3176 return -1;
3177 }
3178 ao2_global_obj_replace_unref(topic_statistics, topic_stats);
3179 ao2_cleanup(topic_stats);
3180 if (!topic_stats) {
3181 return -1;
3182 }
3183
3184 AST_VECTOR_INIT(&message_type_statistics, 0);
3185
3186 if (ast_cli_register_multiple(cli_stasis_statistics, ARRAY_LEN(cli_stasis_statistics))) {
3187 return -1;
3188 }
3189#endif
3190
3191 return 0;
3192}
int ast_register_cleanup(void(*func)(void))
Register a function to be executed before Asterisk gracefully exits.
Definition: clicompat.c:19
@ AO2_ALLOC_OPT_LOCK_MUTEX
Definition: astobj2.h:363
#define ao2_global_obj_replace_unref(holder, obj)
Replace an ao2 object in the global holder, throwing away any old object.
Definition: astobj2.h:901
#define ao2_global_obj_ref(holder)
Get a reference to the object stored in the global holder.
Definition: astobj2.h:918
#define ao2_container_alloc_hash(ao2_options, container_options, n_buckets, hash_fn, sort_fn, cmp_fn)
Allocate and initialize a hash container with the desired number of buckets.
Definition: astobj2.h:1303
#define ast_cli_register_multiple(e, len)
Register multiple commands.
Definition: cli.h:265
@ ACO_EXACT
int aco_set_defaults(struct aco_type *type, const char *category, void *obj)
Set all default options of obj.
@ ACO_PROCESS_ERROR
Their was an error and no changes were applied.
int aco_info_init(struct aco_info *info)
Initialize an aco_info structure.
#define FLDSET(type,...)
Convert a struct and list of fields to an argument list of field offsets.
#define aco_option_register(info, name, matchtype, types, default_val, opt_type, flags,...)
Register a config option.
@ OPT_INT_T
Type for default option handler for signed integers.
#define aco_option_register_custom(info, name, matchtype, types, default_val, handler, flags)
Register a config option.
enum aco_process_status aco_process_config(struct aco_info *info, int reload)
Process a config info via the options registered with an aco_info.
#define LOG_NOTICE
static void * stasis_config_alloc(void)
Definition: stasis.c:2253
static void stasis_cleanup(void)
Cleanup function for graceful shutdowns.
Definition: stasis.c:3042
static struct aco_type threadpool_option
Definition: stasis.c:2202
static struct aco_type * threadpool_options[]
Definition: stasis.c:2210
static int declined_handler(const struct aco_option *opt, struct ast_variable *var, void *obj)
Definition: stasis.c:2304
struct aco_type * declined_options[]
Definition: stasis.c:2221
#define TOPIC_ALL_BUCKETS
Definition: stasis.c:317
static struct aco_type declined_option
An aco_type structure to link the "declined_message_types" category to the stasis_declined_config typ...
Definition: stasis.c:2213
#define STASIS_MESSAGE_TYPE_INIT(name)
Boiler-plate messaging macro for initializing message types.
Definition: stasis.h:1493
int stasis_cache_init(void)
Generic container type.
int idle_timeout
Time limit in seconds for idle threads.
Definition: threadpool.h:79
int max_size
Maximum number of threads a pool may have.
Definition: threadpool.h:110
int auto_increment
Number of threads to increment pool by.
Definition: threadpool.h:90
int initial_size
Number of threads the pool will start with.
Definition: threadpool.h:100
Threadpool configuration options.
Definition: stasis.c:2186
struct ast_threadpool * ast_threadpool_create(const char *name, struct ast_threadpool_listener *listener, const struct ast_threadpool_options *options)
Create a new threadpool.
Definition: threadpool.c:916
#define AST_THREADPOOL_OPTIONS_VERSION
Definition: threadpool.h:71

References ACO_EXACT, aco_info_init(), aco_option_register, aco_option_register_custom, aco_process_config(), ACO_PROCESS_ERROR, aco_set_defaults(), AO2_ALLOC_OPT_LOCK_MUTEX, ao2_cleanup, ao2_container_alloc_hash, ao2_global_obj_ref, ao2_global_obj_replace_unref, ao2_ref, ARRAY_LEN, ast_cli_register_multiple, ast_log, ast_multi_user_event_type(), ast_register_cleanup(), ast_threadpool_create(), AST_THREADPOOL_OPTIONS_VERSION, AST_VECTOR_INIT, ast_threadpool_options::auto_increment, cli_stasis, declined_handler(), stasis_config::declined_message_types, declined_option, declined_options, FLDSET, globals, ast_threadpool_options::idle_timeout, stasis_threadpool_conf::idle_timeout_sec, ast_threadpool_options::initial_size, stasis_threadpool_conf::initial_size, LOG_ERROR, LOG_NOTICE, ast_threadpool_options::max_size, stasis_threadpool_conf::max_size, NULL, OPT_INT_T, PARSE_IN_RANGE, stasis_cache_init(), stasis_cleanup(), stasis_config_alloc(), STASIS_MESSAGE_TYPE_INIT, stasis_subscription_change_type(), threadpool, threadpool_option, stasis_config::threadpool_options, threadpool_options, topic_all, TOPIC_ALL_BUCKETS, and ast_threadpool_options::version.

Referenced by asterisk_daemon().

◆ stasis_log_bad_type_access()

void stasis_log_bad_type_access ( const char *  name)

Definition at line 1940 of file stasis.c.

1941{
1942#ifdef AST_DEVMODE
1944 ast_log(LOG_ERROR, "Use of %s() before init/after destruction\n", name);
1945 }
1946#endif
1947}
int stasis_message_type_declined(const char *name)
Check whether a message type is declined.
Definition: stasis.c:2283

References ast_log, LOG_ERROR, name, and stasis_message_type_declined().

◆ stasis_message_type_declined()

int stasis_message_type_declined ( const char *  name)

Check whether a message type is declined.

Parameters
nameThe name of the message type to check
Return values
zeroThe message type is not declined
non-zeroThe message type is declined

Definition at line 2283 of file stasis.c.

2284{
2286 char *name_in_declined;
2287 int res;
2288
2289 if (!cfg || !cfg->declined_message_types) {
2290 ao2_cleanup(cfg);
2291 return 0;
2292 }
2293
2294 name_in_declined = ao2_find(cfg->declined_message_types->declined, name, OBJ_SEARCH_KEY);
2295 res = name_in_declined ? 1 : 0;
2296 ao2_cleanup(name_in_declined);
2297 ao2_ref(cfg, -1);
2298 if (res) {
2299 ast_debug(4, "Declining to allocate Stasis message type '%s' due to configuration\n", name);
2300 }
2301 return res;
2302}
#define ao2_find(container, arg, flags)
Definition: astobj2.h:1736
@ OBJ_SEARCH_KEY
The arg parameter is a search key, but is not an object.
Definition: astobj2.h:1101
#define ast_debug(level,...)
Log a DEBUG message.

References ao2_cleanup, ao2_find, ao2_global_obj_ref, ao2_ref, ast_debug, stasis_declined_config::declined, stasis_config::declined_message_types, globals, name, and OBJ_SEARCH_KEY.

Referenced by stasis_log_bad_type_access(), and stasis_message_type_create().

◆ STASIS_MESSAGE_TYPE_DEFN() [1/2]

STASIS_MESSAGE_TYPE_DEFN ( ast_multi_user_event_type  ,
to_json = multi_user_event_to_json,
to_ami = multi_user_event_to_ami 
)

Define multi user event message type(s).

◆ STASIS_MESSAGE_TYPE_DEFN() [2/2]

STASIS_MESSAGE_TYPE_DEFN ( stasis_subscription_change_type  )

◆ stasis_publish()

void stasis_publish ( struct stasis_topic topic,
struct stasis_message message 
)

Publish a message to a topic's subscribers.

Parameters
topicTopic.
messageMessage to publish.

This call is asynchronous and will return immediately upon queueing the message for delivery to the topic's subscribers.

Since
12

Definition at line 1511 of file stasis.c.

1512{
1513 publish_msg(topic, message, NULL);
1514}
static void publish_msg(struct stasis_topic *topic, struct stasis_message *message, struct stasis_subscription *sync_sub)
Definition: stasis.c:1430

References NULL, publish_msg(), and stasis_subscription::topic.

Referenced by aoc_publish_blob(), app_send_end_msg(), ast_bridge_publish_attended_transfer(), ast_bridge_publish_blind_transfer(), ast_bridge_publish_enter(), ast_bridge_publish_leave(), ast_bridge_publish_merge(), ast_bridge_publish_state(), ast_cel_publish_event(), ast_channel_publish_blob(), ast_channel_publish_cached_blob(), ast_channel_publish_final_snapshot(), ast_channel_publish_snapshot(), ast_device_state_clear_cache(), ast_endpoint_blob_publish(), ast_endpoint_shutdown(), ast_manager_publish_event(), ast_multi_object_blob_single_channel_publish(), ast_publish_device_state_full(), ast_rtp_publish_rtcp_message(), ast_system_publish_registry(), AST_TEST_DEFINE(), bridge_attended_transfer_handler(), bridge_blind_transfer_handler(), bridge_merge_handler(), bridge_publish_state_from_blob(), bridge_topics_destroy(), cache_test_aggregate_publish_fn(), caching_topic_exec(), cc_publish(), clear_node_cache(), device_state_aggregate_publish(), endpoint_publish_snapshot(), endpoint_state_cb(), handle_security_event(), local_optimization_finished_cb(), local_optimization_started_cb(), manager_mute_mixmonitor(), meetme_stasis_generate_msg(), mixmonitor_exec(), moh_post_start(), moh_post_stop(), notify_new_message(), presence_state_event(), publish_acl_change(), publish_chanspy_message(), publish_cluster_discovery_to_stasis_full(), publish_corosync_ping_to_stasis(), publish_format_update(), publish_hint_change(), publish_hint_remove(), publish_load_message_type(), publish_local_bridge_message(), publish_message_for_channel_topics(), publish_parked_call(), publish_parked_call_failure(), queue_publish_member_blob(), queue_publish_multi_channel_snapshot_blob(), remove_device_states_cb(), report_fax_status(), report_receive_fax_status(), report_send_fax_status(), send_call_pickup_stasis_message(), send_conf_stasis(), send_conf_stasis_snapshots(), send_msg(), send_start_msg_snapshots(), send_subscription_subscribe(), send_subscription_unsubscribe(), stasis_app_control_publish(), stasis_app_user_event(), stasis_state_publish(), stasis_state_publish_by_id(), stasis_state_remove_publish_by_id(), stop_mixmonitor_full(), stun_monitor_request(), and talk_detect_audiohook_cb().

◆ stasis_publish_sync()

void stasis_publish_sync ( struct stasis_subscription sub,
struct stasis_message message 
)

Publish a message to a topic's subscribers, synchronizing on the specified subscriber.

Parameters
subSubscription to synchronize on.
messageMessage to publish.

The caller of stasis_publish_sync will block until the specified subscriber completes handling of the message.

All other subscribers to the topic the stasis_subscription is subscribed to are also delivered the message; this delivery however happens asynchronously.

Since
12.1.0

Definition at line 1516 of file stasis.c.

1517{
1518 ast_assert(sub != NULL);
1519
1520 publish_msg(sub->topic, message, sub);
1521}

References ast_assert, NULL, publish_msg(), and sub.

Referenced by AST_TEST_DEFINE(), and stasis_message_router_publish_sync().

◆ stasis_show_topic()

static char * stasis_show_topic ( struct ast_cli_entry e,
int  cmd,
struct ast_cli_args a 
)
static

Definition at line 2417 of file stasis.c.

2418{
2419 struct stasis_topic *topic;
2420 char print_time[32];
2421 int i;
2422
2423 switch (cmd) {
2424 case CLI_INIT:
2425 e->command = "stasis show topic";
2426 e->usage =
2427 "Usage: stasis show topic <name>\n"
2428 " Show stasis topic detail info.\n";
2429 return NULL;
2430 case CLI_GENERATE:
2431 if (a->pos == 3) {
2432 return topic_complete_name(a->word);
2433 } else {
2434 return NULL;
2435 }
2436 }
2437
2438 if (a->argc != 4) {
2439 return CLI_SHOWUSAGE;
2440 }
2441
2442 topic = stasis_topic_get(a->argv[3]);
2443 if (!topic) {
2444 ast_cli(a->fd, "Specified topic '%s' does not exist\n", a->argv[3]);
2445 return CLI_FAILURE;
2446 }
2447
2448 ast_cli(a->fd, "Name: %s\n", topic->name);
2449 ast_cli(a->fd, "Detail: %s\n", topic->detail);
2450 ast_cli(a->fd, "Subscribers count: %zu\n", AST_VECTOR_SIZE(&topic->subscribers));
2451 ast_cli(a->fd, "Forwarding topic count: %zu\n", AST_VECTOR_SIZE(&topic->upstream_topics));
2452 ast_format_duration_hh_mm_ss(ast_tvnow().tv_sec - topic->creationtime->tv_sec, print_time, sizeof(print_time));
2453 ast_cli(a->fd, "Duration time: %s\n", print_time);
2454
2455 ao2_lock(topic);
2456 ast_cli(a->fd, "\nSubscribers:\n");
2457 for (i = 0; i < AST_VECTOR_SIZE(&topic->subscribers); i++) {
2458 struct stasis_subscription *subscription_tmp = AST_VECTOR_GET(&topic->subscribers, i);
2459 ast_cli(a->fd, " UniqueID: %s, Topic: %s, Detail: %s\n",
2460 subscription_tmp->uniqueid, subscription_tmp->topic->name, subscription_tmp->topic->detail);
2461 }
2462
2463 ast_cli(a->fd, "\nForwarded topics:\n");
2464 for (i = 0; i < AST_VECTOR_SIZE(&topic->upstream_topics); i++) {
2465 struct stasis_topic *topic_tmp = AST_VECTOR_GET(&topic->upstream_topics, i);
2466 ast_cli(a->fd, " Topic: %s, Detail: %s\n", topic_tmp->name, topic_tmp->detail);
2467 }
2468 ao2_unlock(topic);
2469
2470 ao2_ref(topic, -1);
2471
2472 return CLI_SUCCESS;
2473}
#define CLI_SHOWUSAGE
Definition: cli.h:45
#define CLI_SUCCESS
Definition: cli.h:44
void ast_cli(int fd, const char *fmt,...)
Definition: clicompat.c:6
@ CLI_INIT
Definition: cli.h:152
@ CLI_GENERATE
Definition: cli.h:153
#define CLI_FAILURE
Definition: cli.h:46
static char * topic_complete_name(const char *word)
Definition: stasis.c:2391
char * command
Definition: cli.h:186
const char * usage
Definition: cli.h:177
static struct test_val a
void ast_format_duration_hh_mm_ss(int duration, char *buf, size_t length)
Formats a duration into HH:MM:SS.
Definition: utils.c:2297

References a, ao2_lock, ao2_ref, ao2_unlock, ast_cli(), ast_format_duration_hh_mm_ss(), ast_tvnow(), AST_VECTOR_GET, AST_VECTOR_SIZE, CLI_FAILURE, CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, stasis_topic::creationtime, stasis_topic::detail, stasis_topic::name, NULL, stasis_topic_get(), stasis_topic::subscribers, stasis_subscription::topic, topic_complete_name(), stasis_subscription::uniqueid, stasis_topic::upstream_topics, and ast_cli_entry::usage.

◆ stasis_show_topics()

static char * stasis_show_topics ( struct ast_cli_entry e,
int  cmd,
struct ast_cli_args a 
)
static

Definition at line 2334 of file stasis.c.

2335{
2336 struct ao2_iterator iter;
2337 struct topic_proxy *topic;
2338 struct ao2_container *tmp_container;
2339 int count = 0;
2340#define FMT_HEADERS "%-64s %-64s\n"
2341#define FMT_FIELDS "%-64s %-64s\n"
2342
2343 switch (cmd) {
2344 case CLI_INIT:
2345 e->command = "stasis show topics";
2346 e->usage =
2347 "Usage: stasis show topics\n"
2348 " Shows a list of topics\n";
2349 return NULL;
2350 case CLI_GENERATE:
2351 return NULL;
2352 }
2353
2354 if (a->argc != e->args) {
2355 return CLI_SHOWUSAGE;
2356 }
2357
2358 ast_cli(a->fd, "\n" FMT_HEADERS, "Name", "Detail");
2359
2361 topic_proxy_sort_fn, NULL);
2362
2363 if (!tmp_container || ao2_container_dup(tmp_container, topic_all, OBJ_SEARCH_OBJECT)) {
2364 ao2_cleanup(tmp_container);
2365
2366 return NULL;
2367 }
2368
2369 /* getting all topic in order */
2370 iter = ao2_iterator_init(tmp_container, AO2_ITERATOR_UNLINK);
2371 while ((topic = ao2_iterator_next(&iter))) {
2372 ast_cli(a->fd, FMT_FIELDS, topic->name, topic->detail);
2373 ao2_ref(topic, -1);
2374 ++count;
2375 }
2376 ao2_iterator_destroy(&iter);
2377 ao2_cleanup(tmp_container);
2378
2379 ast_cli(a->fd, "\n%d Total topics\n\n", count);
2380
2381#undef FMT_HEADERS
2382#undef FMT_FIELDS
2383
2384 return CLI_SUCCESS;
2385}
int ao2_container_dup(struct ao2_container *dest, struct ao2_container *src, enum search_flags flags)
Copy all object references in the src container into the dest container.
#define ao2_iterator_next(iter)
Definition: astobj2.h:1911
@ AO2_ITERATOR_UNLINK
Definition: astobj2.h:1863
struct ao2_iterator ao2_iterator_init(struct ao2_container *c, int flags) attribute_warn_unused_result
Create an iterator for a container.
void ao2_iterator_destroy(struct ao2_iterator *iter)
Destroy a container iterator.
@ OBJ_SEARCH_OBJECT
The arg parameter is an object of the same type.
Definition: astobj2.h:1087
#define ao2_container_alloc_list(ao2_options, container_options, sort_fn, cmp_fn)
Allocate and initialize a list container.
Definition: astobj2.h:1327
#define FMT_HEADERS
#define FMT_FIELDS
When we need to walk through a container, we use an ao2_iterator to keep track of the current positio...
Definition: astobj2.h:1821
int args
This gets set in ast_cli_register()
Definition: cli.h:185

References a, AO2_ALLOC_OPT_LOCK_NOLOCK, ao2_cleanup, ao2_container_alloc_list, ao2_container_dup(), ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, AO2_ITERATOR_UNLINK, ao2_ref, ast_cli_entry::args, ast_cli(), CLI_GENERATE, CLI_INIT, CLI_SHOWUSAGE, CLI_SUCCESS, ast_cli_entry::command, topic_proxy::detail, FMT_FIELDS, FMT_HEADERS, topic_proxy::name, NULL, OBJ_SEARCH_OBJECT, topic_all, and ast_cli_entry::usage.

◆ stasis_subscription_accept_formatters()

void stasis_subscription_accept_formatters ( struct stasis_subscription subscription,
enum stasis_subscription_message_formatters  formatters 
)

Indicate to a subscription that we are interested in messages with one or more formatters.

Parameters
subscriptionSubscription to alter.
formattersA bitmap of stasis_subscription_message_formatters we wish to receive.
Since
13.25.0
16.2.0

Definition at line 1093 of file stasis.c.

1095{
1096 ast_assert(subscription != NULL);
1097
1098 ao2_lock(subscription->topic);
1099 subscription->accepted_formatters = formatters;
1100 ao2_unlock(subscription->topic);
1101
1102 return;
1103}
enum stasis_subscription_message_formatters accepted_formatters
Definition: stasis.c:704

References stasis_subscription::accepted_formatters, ao2_lock, ao2_unlock, ast_assert, NULL, and stasis_subscription::topic.

Referenced by AST_TEST_DEFINE(), stasis_message_router_accept_formatters(), and stasis_message_router_set_formatters_default().

◆ stasis_subscription_accept_message_type()

int stasis_subscription_accept_message_type ( struct stasis_subscription subscription,
const struct stasis_message_type type 
)

Indicate to a subscription that we are interested in a message type.

This will cause the subscription to allow the given message type to be raised to our subscription callback. This enables internal filtering in the stasis message bus to reduce messages.

Parameters
subscriptionSubscription to add message type to.
typeThe message type we wish to receive.
Return values
0on success
-1failure
Since
17.0.0
Note
If you are wanting to use stasis_final_message you will need to accept stasis_subscription_change_type as a message type.
Until the subscription is set to selective filtering it is possible for it to receive messages of message types that would not normally be accepted.

Definition at line 1023 of file stasis.c.

1025{
1026 if (!subscription) {
1027 return -1;
1028 }
1029
1030 ast_assert(type != NULL);
1032
1034 /* Filtering is unreliable as this message type is not yet initialized
1035 * so force all messages through.
1036 */
1038 return 0;
1039 }
1040
1041 ao2_lock(subscription->topic);
1043 /* We do this for the same reason as above. The subscription can still operate, so allow
1044 * it to do so by forcing all messages through.
1045 */
1047 }
1048 ao2_unlock(subscription->topic);
1049
1050 return 0;
1051}
@ STASIS_SUBSCRIPTION_FILTER_FORCED_NONE
Definition: stasis.h:296
const char * stasis_message_type_name(const struct stasis_message_type *type)
Gets the name of a given message type.
struct stasis_subscription::@394 accepted_message_types
enum stasis_subscription_message_filter filter
Definition: stasis.c:706

References stasis_subscription::accepted_message_types, ao2_lock, ao2_unlock, ast_assert, AST_VECTOR_REPLACE, stasis_subscription::filter, NULL, stasis_message_type_id(), stasis_message_type_name(), STASIS_SUBSCRIPTION_FILTER_FORCED_NONE, stasis_subscription::topic, and type.

Referenced by acl_change_stasis_subscribe(), ast_mwi_subscribe_pool(), ast_res_pjsip_initialize_configuration(), AST_TEST_DEFINE(), asterisk_start_devicestate_publishing(), asterisk_start_mwi_publishing(), cc_generic_agent_start_monitoring(), common_config_load(), create_new_generic_list(), create_parked_subscription_full(), devstate_init(), load_module(), load_pbx(), mwi_stasis_subscription_alloc(), network_change_stasis_subscribe(), park_and_announce_app_exec(), parking_manager_enable_stasis(), refer_blind_callback(), rtp_reload(), stasis_caching_accept_message_type(), stasis_message_router_add(), stasis_message_router_add_cache_update(), stasis_message_router_create_internal(), subscribe_device_state(), and xmpp_init_event_distribution().

◆ stasis_subscription_cb_noop()

void stasis_subscription_cb_noop ( void *  data,
struct stasis_subscription sub,
struct stasis_message message 
)

Stasis subscription callback function that does nothing.

Note
This callback should be used for events are not directly processed, but need to be generated so data can be retrieved from cache later. Subscriptions with this callback can be released with stasis_unsubscribe, even during module unload.
Since
13.5

Definition at line 809 of file stasis.c.

810{
811}

Referenced by build_peer(), and mkintf().

◆ stasis_subscription_decline_message_type()

int stasis_subscription_decline_message_type ( struct stasis_subscription subscription,
const struct stasis_message_type type 
)

Indicate to a subscription that we are not interested in a message type.

Parameters
subscriptionSubscription to remove message type from.
typeThe message type we don't wish to receive.
Return values
0on success
-1failure
Since
17.0.0

Definition at line 1053 of file stasis.c.

1055{
1056 if (!subscription) {
1057 return -1;
1058 }
1059
1060 ast_assert(type != NULL);
1062
1064 return 0;
1065 }
1066
1067 ao2_lock(subscription->topic);
1069 /* The memory is already allocated so this can't fail */
1071 }
1072 ao2_unlock(subscription->topic);
1073
1074 return 0;
1075}

References stasis_subscription::accepted_message_types, ao2_lock, ao2_unlock, ast_assert, AST_VECTOR_REPLACE, AST_VECTOR_SIZE, NULL, stasis_message_type_id(), stasis_message_type_name(), stasis_subscription::topic, and type.

Referenced by AST_TEST_DEFINE().

◆ stasis_subscription_final_message()

int stasis_subscription_final_message ( struct stasis_subscription sub,
struct stasis_message msg 
)

Determine whether a message is the final message to be received on a subscription.

Parameters
subSubscription on which the message was received.
msgMessage to check.
Returns
zero if the provided message is not the final message.
non-zero if the provided message is the final message.
Since
12

Definition at line 1174 of file stasis.c.

1175{
1176 struct stasis_subscription_change *change;
1177
1179 return 0;
1180 }
1181
1182 change = stasis_message_data(msg);
1183 if (strcmp("Unsubscribe", change->description)) {
1184 return 0;
1185 }
1186
1187 if (strcmp(stasis_subscription_uniqueid(sub), change->uniqueid)) {
1188 return 0;
1189 }
1190
1191 return 1;
1192}
const char * stasis_subscription_uniqueid(const struct stasis_subscription *sub)
Get the unique ID for the subscription.
Definition: stasis.c:1169

References stasis_subscription_change::description, stasis_message_data(), stasis_message_type(), stasis_subscription_change_type(), stasis_subscription_uniqueid(), sub, and stasis_subscription_change::uniqueid.

Referenced by bridge_subscription_change_handler(), caching_topic_exec(), consumer_exec(), consumer_exec_sync(), consumer_finalize(), default_route(), device_state_cb(), dispatch_message(), endpoint_subscription_change(), generic_agent_devstate_cb(), message_sink_cb(), mwi_stasis_cb(), park_announce_update_cb(), parker_update_cb(), queue_bridge_cb(), queue_channel_cb(), refer_progress_bridge(), router_dispatch(), statsmaker(), sub_subscription_change_handler(), and subscription_invoke().

◆ stasis_subscription_is_done()

int stasis_subscription_is_done ( struct stasis_subscription subscription)

Returns whether subscription has received its final message.

Note that a subscription is considered done even while the stasis_subscription_final_message() is being processed. This allows cleanup routines to check the status of the subscription.

Parameters
subscriptionSubscription.
Returns
True (non-zero) if stasis_subscription_final_message() has been received.
False (zero) if waiting for the end.

Definition at line 1118 of file stasis.c.

1119{
1120 if (subscription) {
1121 int ret;
1122
1123 ao2_lock(subscription);
1124 ret = subscription->final_message_rxed;
1125 ao2_unlock(subscription);
1126
1127 return ret;
1128 }
1129
1130 /* Null subscription is about as done as you can get */
1131 return 1;
1132}
int final_message_rxed
Definition: stasis.c:696

References ao2_lock, ao2_unlock, and stasis_subscription::final_message_rxed.

Referenced by router_dtor(), stasis_caching_topic_dtor(), stasis_message_router_is_done(), and subscription_dtor().

◆ stasis_subscription_is_subscribed()

int stasis_subscription_is_subscribed ( const struct stasis_subscription sub)

Returns whether a subscription is currently subscribed.

Note that there may still be messages queued up to be dispatched to this subscription, but the stasis_subscription_final_message() has been enqueued.

Parameters
subSubscription to check
Returns
False (zero) if subscription is not subscribed.
True (non-zero) if still subscribed.

Definition at line 1150 of file stasis.c.

1151{
1152 if (sub) {
1153 size_t i;
1154 struct stasis_topic *topic = sub->topic;
1155
1156 ao2_lock(topic);
1157 for (i = 0; i < AST_VECTOR_SIZE(&topic->subscribers); ++i) {
1158 if (AST_VECTOR_GET(&topic->subscribers, i) == sub) {
1159 ao2_unlock(topic);
1160 return 1;
1161 }
1162 }
1163 ao2_unlock(topic);
1164 }
1165
1166 return 0;
1167}

References ao2_lock, ao2_unlock, AST_VECTOR_GET, AST_VECTOR_SIZE, sub, and stasis_topic::subscribers.

Referenced by asterisk_publisher_devstate_cb(), asterisk_publisher_mwistate_cb(), router_dtor(), send_subscription_subscribe(), send_subscription_unsubscribe(), stasis_caching_topic_dtor(), stasis_caching_unsubscribe(), subscription_dtor(), xmpp_pubsub_devstate_cb(), and xmpp_pubsub_mwi_cb().

◆ stasis_subscription_join()

void stasis_subscription_join ( struct stasis_subscription subscription)

Block until the last message is processed on a subscription.

This function will not return until the subscription's callback for the stasis_subscription_final_message() completes. This allows cleanup routines to run before unblocking the joining thread.

Parameters
subscriptionSubscription to block on.
Since
12

Definition at line 1105 of file stasis.c.

1106{
1107 if (subscription) {
1108 ao2_lock(subscription);
1109 /* Wait until the processed flag has been set */
1110 while (!subscription->final_message_processed) {
1111 ast_cond_wait(&subscription->join_cond,
1112 ao2_object_get_lockaddr(subscription));
1113 }
1114 ao2_unlock(subscription);
1115 }
1116}
void * ao2_object_get_lockaddr(void *obj)
Return the mutex lock address of an object.
Definition: astobj2.c:476
ast_cond_t join_cond
Definition: stasis.c:693
int final_message_processed
Definition: stasis.c:699

References ao2_lock, ao2_object_get_lockaddr(), ao2_unlock, ast_cond_wait, stasis_subscription::final_message_processed, and stasis_subscription::join_cond.

Referenced by stasis_caching_unsubscribe_and_join(), and stasis_unsubscribe_and_join().

◆ stasis_subscription_set_congestion_limits()

int stasis_subscription_set_congestion_limits ( struct stasis_subscription subscription,
long  low_water,
long  high_water 
)

Set the high and low alert water marks of the stasis subscription.

Since
13.10.0
Parameters
subscriptionPointer to a stasis subscription
low_waterNew queue low water mark. (-1 to set as 90% of high_water)
high_waterNew queue high water mark.
Return values
0on success.
-1on error (water marks not changed).

Definition at line 1011 of file stasis.c.

1013{
1014 int res = -1;
1015
1016 if (subscription) {
1017 res = ast_taskprocessor_alert_set_levels(subscription->mailbox,
1018 low_water, high_water);
1019 }
1020 return res;
1021}
struct ast_taskprocessor * mailbox
Definition: stasis.c:686
int ast_taskprocessor_alert_set_levels(struct ast_taskprocessor *tps, long low_water, long high_water)
Set the high and low alert water marks of the given taskprocessor queue.

References ast_taskprocessor_alert_set_levels(), and stasis_subscription::mailbox.

Referenced by stasis_message_router_set_congestion_limits().

◆ stasis_subscription_set_filter()

int stasis_subscription_set_filter ( struct stasis_subscription subscription,
enum stasis_subscription_message_filter  filter 
)

Set the message type filtering level on a subscription.

This will cause the subscription to filter messages according to the provided filter level. For example if selective is used then only messages matching those provided to stasis_subscription_accept_message_type will be raised to the subscription callback.

Parameters
subscriptionSubscription that should receive all messages.
filterWhat filter to use
Return values
0on success
-1failure
Since
17.0.0

Definition at line 1077 of file stasis.c.

1079{
1080 if (!subscription) {
1081 return -1;
1082 }
1083
1084 ao2_lock(subscription->topic);
1085 if (subscription->filter != STASIS_SUBSCRIPTION_FILTER_FORCED_NONE) {
1086 subscription->filter = filter;
1087 }
1088 ao2_unlock(subscription->topic);
1089
1090 return 0;
1091}
static int filter(struct ast_channel *chan, const char *cmd, char *parse, char *buf, size_t len)
Definition: func_strings.c:807

References ao2_lock, ao2_unlock, filter(), stasis_subscription::filter, STASIS_SUBSCRIPTION_FILTER_FORCED_NONE, and stasis_subscription::topic.

Referenced by acl_change_stasis_subscribe(), ast_mwi_subscribe_pool(), ast_res_pjsip_initialize_configuration(), AST_TEST_DEFINE(), asterisk_start_devicestate_publishing(), asterisk_start_mwi_publishing(), cc_generic_agent_start_monitoring(), create_new_generic_list(), create_parked_subscription_full(), devstate_init(), load_module(), load_pbx(), network_change_stasis_subscribe(), park_and_announce_app_exec(), parking_manager_enable_stasis(), refer_blind_callback(), rtp_reload(), stasis_caching_set_filter(), stasis_message_router_add(), stasis_message_router_add_cache_update(), stasis_message_router_set_formatters_default(), subscribe_device_state(), and xmpp_init_event_distribution().

◆ stasis_subscription_uniqueid()

const char * stasis_subscription_uniqueid ( const struct stasis_subscription sub)

Get the unique ID for the subscription.

Parameters
subSubscription for which to get the unique ID.
Returns
Unique ID for the subscription.
Since
12

Definition at line 1169 of file stasis.c.

1170{
1171 return sub->uniqueid;
1172}

References sub.

Referenced by AST_TEST_DEFINE(), stasis_subscription_final_message(), topic_add_subscription(), and topic_remove_subscription().

◆ stasis_topic_create()

struct stasis_topic * stasis_topic_create ( const char *  name)

Create a new topic.

Parameters
nameName of the new topic.
Returns
New topic instance.
Return values
NULLon error.
Since
12
Note
There is no explicit ability to unsubscribe all subscribers from a topic and destroy it. As a result the topic can persist until the last subscriber unsubscribes itself even if there is no publisher.
Topic names should be in the form of
<subsystem>:<functionality>[/<object>] 

Definition at line 617 of file stasis.c.

618{
620}
struct stasis_topic * stasis_topic_create_with_detail(const char *name, const char *detail)
Create a new topic with given detail.
Definition: stasis.c:568

References name, and stasis_topic_create_with_detail().

Referenced by __init_manager(), app_create(), app_init(), ast_channel_internal_setup_topics(), ast_parking_stasis_init(), ast_presence_state_engine_init(), ast_rtp_engine_init(), ast_security_stasis_init(), ast_stasis_bridging_init(), ast_stasis_channels_init(), ast_stasis_system_init(), AST_TEST_DEFINE(), ast_test_init(), create_cts(), create_subscriptions(), devstate_init(), load_module(), stasis_caching_topic_create(), stasis_cp_all_create(), stasis_cp_sink_create(), stasis_state_manager_create(), stasis_topic_pool_get_topic(), and state_alloc().

◆ stasis_topic_create_with_detail()

struct stasis_topic * stasis_topic_create_with_detail ( const char *  name,
const char *  detail 
)

Create a new topic with given detail.

Parameters
nameName of the new topic.
detailDetail description of the new topic. i.e. "Queue main topic for subscribing every queue event"
Returns
New topic instance.
Return values
NULLon error.
Note
There is no explicit ability to unsubscribe all subscribers from a topic and destroy it. As a result the topic can persist until the last subscriber unsubscribes itself even if there is no publisher.

Definition at line 568 of file stasis.c.

571{
572 struct stasis_topic *topic;
573 int res = 0;
574
575 if (!name|| !strlen(name) || !detail) {
576 return NULL;
577 }
578 ast_debug(2, "Creating topic. name: %s, detail: %s\n", name, detail);
579
580 topic = stasis_topic_get(name);
581 if (topic) {
582 ast_debug(2, "Topic is already exist. name: %s, detail: %s\n",
583 name, detail);
584 return topic;
585 }
586
587 topic = ao2_t_alloc(sizeof(*topic), topic_dtor, name);
588 if (!topic) {
589 return NULL;
590 }
591
593 res |= AST_VECTOR_INIT(&topic->upstream_topics, 0);
594 if (res) {
595 ao2_ref(topic, -1);
596 return NULL;
597 }
598
599 /* link to the proxy */
600 if (link_topic_proxy(topic, name, detail)) {
601 ao2_ref(topic, -1);
602 return NULL;
603 }
604
605#ifdef AST_DEVMODE
606 topic->statistics = stasis_topic_statistics_create(topic);
607 if (!topic->statistics) {
608 ao2_ref(topic, -1);
609 return NULL;
610 }
611#endif
612 ast_debug(1, "Topic '%s': %p created\n", topic->name, topic);
613
614 return topic;
615}
#define INITIAL_SUBSCRIBERS_MAX
Definition: stasis.c:301
static void topic_dtor(void *obj)
Definition: stasis.c:433
static int link_topic_proxy(struct stasis_topic *topic, const char *name, const char *detail)
Definition: stasis.c:500

References ao2_ref, ao2_t_alloc, ast_debug, AST_VECTOR_INIT, stasis_topic::detail, INITIAL_SUBSCRIBERS_MAX, link_topic_proxy(), name, stasis_topic::name, NULL, stasis_topic_get(), stasis_topic::subscribers, topic_dtor(), and stasis_topic::upstream_topics.

Referenced by stasis_topic_create().

◆ stasis_topic_detail()

const char * stasis_topic_detail ( const struct stasis_topic topic)

Return the detail of a topic.

Parameters
topicTopic.
Returns
Detail of the topic.
Return values
NULLif topic is NULL.
Since
12

Definition at line 635 of file stasis.c.

636{
637 if (!topic) {
638 return NULL;
639 }
640 return topic->detail;
641}

References stasis_topic::detail, and NULL.

◆ stasis_topic_get()

struct stasis_topic * stasis_topic_get ( const char *  name)

Get a topic of the given name.

Parameters
nameTopic's name.
Returns
Name of the topic.
Return values
NULLon error or not exist.
Note
This SHOULD NOT be used in normal operation for publishing messages.

Definition at line 622 of file stasis.c.

623{
625}
#define ao2_weakproxy_find(c, arg, flags, tag)
Perform an ao2_find on a container with ao2_weakproxy objects, returning the real object.
Definition: astobj2.h:1748

References ao2_weakproxy_find, name, OBJ_SEARCH_KEY, and topic_all.

Referenced by link_topic_proxy(), stasis_show_topic(), and stasis_topic_create_with_detail().

◆ stasis_topic_name()

const char * stasis_topic_name ( const struct stasis_topic topic)

◆ stasis_topic_pool_create()

struct stasis_topic_pool * stasis_topic_pool_create ( struct stasis_topic pooled_topic)

Create a topic pool that routes messages from dynamically generated topics to the given topic.

Parameters
pooled_topicTopic to which messages will be routed
Returns
the new stasis_topic_pool
Return values
NULLon failure

Definition at line 1833 of file stasis.c.

1834{
1835 struct stasis_topic_pool *pool;
1836
1838 if (!pool) {
1839 return NULL;
1840 }
1841
1844 if (!pool->pool_container) {
1845 ao2_cleanup(pool);
1846 return NULL;
1847 }
1848
1849#ifdef AO2_DEBUG
1850 {
1851 char *container_name =
1852 ast_alloca(strlen(stasis_topic_name(pooled_topic)) + strlen("-pool") + 1);
1853 sprintf(container_name, "%s-pool", stasis_topic_name(pooled_topic));
1854 ao2_container_register(container_name, pool->pool_container, topic_pool_prnt_obj);
1855 }
1856#endif
1857
1858 ao2_ref(pooled_topic, +1);
1859 pool->pool_topic = pooled_topic;
1860
1861 return pool;
1862}
#define ast_alloca(size)
call __builtin_alloca to ensure we get gcc builtin semantics
Definition: astmm.h:288
int ao2_container_register(const char *name, struct ao2_container *self, ao2_prnt_obj_fn *prnt_obj)
Register a container for CLI stats and integrity check.
static void topic_pool_dtor(void *obj)
Definition: stasis.c:1744
#define TOPIC_POOL_BUCKETS
Definition: stasis.c:304
static int topic_pool_entry_cmp(void *obj, void *arg, int flags)
Definition: stasis.c:1784
static int topic_pool_entry_hash(const void *obj, const int flags)
Definition: stasis.c:1763
struct ao2_container * pool_container
Definition: stasis.c:1740
struct stasis_topic * pool_topic
Definition: stasis.c:1741

References AO2_ALLOC_OPT_LOCK_MUTEX, AO2_ALLOC_OPT_LOCK_NOLOCK, ao2_alloc_options, ao2_cleanup, ao2_container_alloc_hash, ao2_container_register(), ao2_ref, ast_alloca, NULL, stasis_topic_pool::pool_container, stasis_topic_pool::pool_topic, stasis_topic_name(), TOPIC_POOL_BUCKETS, topic_pool_dtor(), topic_pool_entry_cmp(), and topic_pool_entry_hash().

Referenced by app_init(), ast_stasis_bridging_init(), and devstate_init().

◆ stasis_topic_pool_delete_topic()

void stasis_topic_pool_delete_topic ( struct stasis_topic_pool pool,
const char *  topic_name 
)

Delete a topic from the topic pool.

Parameters
poolPool from which to delete the topic
topic_nameName of the topic to delete in the form of
[<pool_topic_name>/]<topic_name> 
Since
13.24
15.6
16.1

Definition at line 1864 of file stasis.c.

1865{
1866 /*
1867 * The topic_name passed in could be a fully-qualified name like <pool_topic_name>/<topic_name>
1868 * or just <topic_name>. If it's fully qualified, we need to skip past <pool_topic_name>
1869 * name and search only on <topic_name>.
1870 */
1871 const char *pool_topic_name = stasis_topic_name(pool->pool_topic);
1872 int pool_topic_name_len = strlen(pool_topic_name);
1873 const char *search_topic_name;
1874
1875 if (strncmp(pool_topic_name, topic_name, pool_topic_name_len) == 0) {
1876 search_topic_name = topic_name + pool_topic_name_len + 1;
1877 } else {
1878 search_topic_name = topic_name;
1879 }
1880
1881 ao2_find(pool->pool_container, search_topic_name, OBJ_SEARCH_KEY | OBJ_NODATA | OBJ_UNLINK);
1882}
@ OBJ_NODATA
Definition: astobj2.h:1044
@ OBJ_UNLINK
Definition: astobj2.h:1039

References ao2_find, OBJ_NODATA, OBJ_SEARCH_KEY, OBJ_UNLINK, stasis_topic_pool::pool_container, stasis_topic_pool::pool_topic, and stasis_topic_name().

Referenced by bridge_topics_destroy().

◆ stasis_topic_pool_get_topic()

struct stasis_topic * stasis_topic_pool_get_topic ( struct stasis_topic_pool pool,
const char *  topic_name 
)

Find or create a topic in the pool.

Parameters
poolPool for which to get the topic
topic_nameName of the topic to get
Returns
The already stored or newly allocated topic
Return values
NULLif the topic was not found and could not be allocated

Definition at line 1884 of file stasis.c.

1885{
1887 SCOPED_AO2LOCK(topic_container_lock, pool->pool_container);
1888 char *new_topic_name;
1889 int ret;
1890
1892 if (topic_pool_entry) {
1893 return topic_pool_entry->topic;
1894 }
1895
1897 if (!topic_pool_entry) {
1898 return NULL;
1899 }
1900
1901 /* To provide further detail and to ensure that the topic is unique within the scope of the
1902 * system we prefix it with the pooling topic name, which should itself already be unique.
1903 */
1904 ret = ast_asprintf(&new_topic_name, "%s/%s", stasis_topic_name(pool->pool_topic), topic_name);
1905 if (ret < 0) {
1906 return NULL;
1907 }
1908
1909 topic_pool_entry->topic = stasis_topic_create(new_topic_name);
1910 ast_free(new_topic_name);
1911 if (!topic_pool_entry->topic) {
1912 return NULL;
1913 }
1914
1916 if (!topic_pool_entry->forward) {
1917 return NULL;
1918 }
1919
1921 return NULL;
1922 }
1923
1924 return topic_pool_entry->topic;
1925}
#define SCOPED_AO2LOCK(varname, obj)
scoped lock specialization for ao2 mutexes.
Definition: lock.h:604
struct stasis_topic * stasis_topic_create(const char *name)
Create a new topic.
Definition: stasis.c:617
static struct topic_pool_entry * topic_pool_entry_alloc(const char *topic_name)
Definition: stasis.c:1724
struct stasis_forward * stasis_forward_all(struct stasis_topic *from_topic, struct stasis_topic *to_topic)
Create a subscription which forwards all messages from one topic to another.
Definition: stasis.c:1578
Definition: stasis.c:1709
struct stasis_topic * topic
Definition: stasis.c:1711
struct stasis_forward * forward
Definition: stasis.c:1710

References ao2_cleanup, ao2_find, ao2_link_flags, ast_asprintf, ast_free, topic_pool_entry::forward, NULL, OBJ_NOLOCK, OBJ_SEARCH_KEY, stasis_topic_pool::pool_container, stasis_topic_pool::pool_topic, RAII_VAR, SCOPED_AO2LOCK, stasis_forward_all(), stasis_topic_create(), stasis_topic_name(), topic_pool_entry::topic, and topic_pool_entry_alloc().

Referenced by ast_device_state_topic(), ast_queue_topic(), and bridge_topics_init().

◆ stasis_topic_pool_topic_exists()

int stasis_topic_pool_topic_exists ( const struct stasis_topic_pool pool,
const char *  topic_name 
)

Check if a topic exists in a pool.

Parameters
poolPool to check
topic_nameName of the topic to check
Return values
1exists
0does not exist
Since
13.23.0

Definition at line 1927 of file stasis.c.

1928{
1930
1932 if (!topic_pool_entry) {
1933 return 0;
1934 }
1935
1937 return 1;
1938}

References ao2_find, ao2_ref, OBJ_SEARCH_KEY, and stasis_topic_pool::pool_container.

Referenced by ast_publish_device_state_full().

◆ stasis_topic_subscribers()

size_t stasis_topic_subscribers ( const struct stasis_topic topic)

Return the number of subscribers of a topic.

Parameters
topicTopic.
Returns
Number of subscribers of the topic.
Since
17.0.0

Definition at line 643 of file stasis.c.

644{
645 return AST_VECTOR_SIZE(&topic->subscribers);
646}

References AST_VECTOR_SIZE, and stasis_topic::subscribers.

Referenced by caching_topic_exec(), and publish_msg().

◆ stasis_unsubscribe()

struct stasis_subscription * stasis_unsubscribe ( struct stasis_subscription subscription)

Cancel a subscription.

Note that in an asynchronous system, there may still be messages queued or in transit to the subscription's callback. These will still be delivered. There will be a final 'SubscriptionCancelled' message, indicating the delivery of the final message.

Parameters
subscriptionSubscription to cancel.
Return values
NULLfor convenience
Since
12

Definition at line 971 of file stasis.c.

972{
973 /* The subscription may be the last ref to this topic. Hold
974 * the topic ref open until after the unlock. */
975 struct stasis_topic *topic;
976
977 if (!sub) {
978 return NULL;
979 }
980
981 topic = ao2_bump(sub->topic);
982
983 /* We have to remove the subscription first, to ensure the unsubscribe
984 * is the final message */
985 if (topic_remove_subscription(sub->topic, sub) != 0) {
987 "Internal error: subscription has invalid topic\n");
988 ao2_cleanup(topic);
989
990 return NULL;
991 }
992
993 /* Now let everyone know about the unsubscribe */
995
996 /* When all that's done, remove the ref the mailbox has on the sub */
997 if (sub->mailbox) {
998 if (ast_taskprocessor_push(sub->mailbox, sub_cleanup, sub)) {
999 /* Nothing we can do here, the conditional is just to keep
1000 * the compiler happy that we're not ignoring the result. */
1001 }
1002 }
1003
1004 /* Unsubscribing unrefs the subscription */
1006 ao2_cleanup(topic);
1007
1008 return NULL;
1009}
static int sub_cleanup(void *data)
Definition: stasis.c:964
static void send_subscription_unsubscribe(struct stasis_topic *topic, struct stasis_subscription *sub)
Definition: stasis.c:1676
int ast_taskprocessor_push(struct ast_taskprocessor *tps, int(*task_exe)(void *datap), void *datap) attribute_warn_unused_result
Push a task into the specified taskprocessor queue and signal the taskprocessor thread.

References ao2_bump, ao2_cleanup, ast_log, ast_taskprocessor_push(), LOG_ERROR, NULL, send_subscription_unsubscribe(), sub, sub_cleanup(), and topic_remove_subscription().

Referenced by AST_TEST_DEFINE(), cc_generic_agent_destructor(), common_config_unload(), destroy_cts(), generic_agent_devstate_cb(), generic_monitor_instance_list_destructor(), mwi_startup_event_cb(), park_and_announce_app_exec(), parked_subscription_datastore_destroy(), refer_progress_bridge(), refer_progress_destroy(), refer_progress_framehook_destroy(), startup_event_cb(), stasis_caching_unsubscribe(), stasis_message_router_unsubscribe(), stasis_state_unsubscribe(), stasis_unsubscribe_and_join(), subscription_persistence_event_cb(), unload_module(), and xmpp_init_event_distribution().

◆ stasis_unsubscribe_and_join()

struct stasis_subscription * stasis_unsubscribe_and_join ( struct stasis_subscription subscription)

Cancel a subscription, blocking until the last message is processed.

While normally it's recommended to stasis_unsubscribe() and wait for stasis_subscription_final_message(), there are times (like during a module unload) where you have to wait for the final message (otherwise you'll call a function in a shared module that no longer exists).

Parameters
subscriptionSubscription to cancel.
Return values
NULLfor convenience
Since
12

Definition at line 1134 of file stasis.c.

1136{
1137 if (!subscription) {
1138 return NULL;
1139 }
1140
1141 /* Bump refcount to hold it past the unsubscribe */
1142 ao2_ref(subscription, +1);
1143 stasis_unsubscribe(subscription);
1144 stasis_subscription_join(subscription);
1145 /* Now decrement the refcount back */
1146 ao2_cleanup(subscription);
1147 return NULL;
1148}
struct stasis_subscription * stasis_unsubscribe(struct stasis_subscription *sub)
Cancel a subscription.
Definition: stasis.c:971
void stasis_subscription_join(struct stasis_subscription *subscription)
Block until the last message is processed on a subscription.
Definition: stasis.c:1105

References ao2_cleanup, ao2_ref, NULL, stasis_subscription_join(), and stasis_unsubscribe().

Referenced by acl_change_stasis_unsubscribe(), ast_res_pjsip_destroy_configuration(), AST_TEST_DEFINE(), ast_xmpp_client_disconnect(), asterisk_stop_devicestate_publishing(), asterisk_stop_mwi_publishing(), devstate_cleanup(), network_change_stasis_unsubscribe(), parking_manager_disable_stasis(), remove_device_state_subscription(), rtp_reload(), stasis_message_router_unsubscribe_and_join(), stasis_state_unsubscribe_and_join(), unload_module(), and unload_pbx().

◆ sub_cleanup()

static int sub_cleanup ( void *  data)
static

Definition at line 964 of file stasis.c.

965{
966 struct stasis_subscription *sub = data;
968 return 0;
969}

References ao2_cleanup, stasis_subscription::data, and sub.

Referenced by stasis_unsubscribe().

◆ subscription_change_alloc()

static struct stasis_subscription_change * subscription_change_alloc ( struct stasis_topic topic,
const char *  uniqueid,
const char *  description 
)
static

Definition at line 1627 of file stasis.c.

1628{
1629 size_t description_len = strlen(description) + 1;
1630 size_t uniqueid_len = strlen(uniqueid) + 1;
1631 struct stasis_subscription_change *change;
1632
1633 change = ao2_alloc_options(sizeof(*change) + description_len + uniqueid_len,
1635 if (!change) {
1636 return NULL;
1637 }
1638
1639 strcpy(change->description, description); /* SAFE */
1640 change->uniqueid = change->description + description_len;
1641 ast_copy_string(change->uniqueid, uniqueid, uniqueid_len); /* SAFE */
1642 ao2_ref(topic, +1);
1643 change->topic = topic;
1644
1645 return change;
1646}
static void subscription_change_dtor(void *obj)
Definition: stasis.c:1620
struct stasis_topic * topic
Definition: stasis.h:891

References AO2_ALLOC_OPT_LOCK_NOLOCK, ao2_alloc_options, ao2_ref, ast_copy_string(), stasis_subscription_change::description, NULL, subscription_change_dtor(), stasis_subscription_change::topic, and stasis_subscription_change::uniqueid.

Referenced by send_subscription_subscribe(), and send_subscription_unsubscribe().

◆ subscription_change_dtor()

static void subscription_change_dtor ( void *  obj)
static

Definition at line 1620 of file stasis.c.

1621{
1622 struct stasis_subscription_change *change = obj;
1623
1624 ao2_cleanup(change->topic);
1625}

References ao2_cleanup, and stasis_subscription_change::topic.

Referenced by subscription_change_alloc().

◆ subscription_dtor()

static void subscription_dtor ( void *  obj)
static

Definition at line 714 of file stasis.c.

715{
716 struct stasis_subscription *sub = obj;
717#ifdef AST_DEVMODE
718 struct ao2_container *subscription_stats;
719#endif
720
721 /* Subscriptions need to be manually unsubscribed before destruction
722 * b/c there's a cyclic reference between topics and subscriptions */
724 /* If there are any messages in flight to this subscription; that would
725 * be bad. */
727
728 ast_free(sub->uniqueid);
729 ao2_cleanup(sub->topic);
730 sub->topic = NULL;
732 sub->mailbox = NULL;
733 ast_cond_destroy(&sub->join_cond);
734
735 AST_VECTOR_FREE(&sub->accepted_message_types);
736
737#ifdef AST_DEVMODE
738 if (sub->statistics) {
739 subscription_stats = ao2_global_obj_ref(subscription_statistics);
740 if (subscription_stats) {
741 ao2_unlink(subscription_stats, sub->statistics);
742 ao2_ref(subscription_stats, -1);
743 }
744 ao2_ref(sub->statistics, -1);
745 }
746#endif
747}
int stasis_subscription_is_done(struct stasis_subscription *subscription)
Returns whether subscription has received its final message.
Definition: stasis.c:1118
void * ast_taskprocessor_unreference(struct ast_taskprocessor *tps)
Unreference the specified taskprocessor and its reference count will decrement.

References ao2_cleanup, ao2_global_obj_ref, ao2_ref, ao2_unlink, ast_assert, ast_cond_destroy, ast_free, ast_taskprocessor_unreference(), AST_VECTOR_FREE, NULL, stasis_subscription_is_done(), stasis_subscription_is_subscribed(), and sub.

Referenced by internal_stasis_subscribe().

◆ subscription_invoke()

static void subscription_invoke ( struct stasis_subscription sub,
struct stasis_message message 
)
static

Invoke the subscription's callback.

Parameters
subSubscription to invoke.
messageMessage to send.

Definition at line 754 of file stasis.c.

756{
757 unsigned int final = stasis_subscription_final_message(sub, message);
759#ifdef AST_DEVMODE
760 struct timeval start;
761 long elapsed;
762
763 start = ast_tvnow();
764#endif
765
766 /* Notify that the final message has been received */
767 if (final) {
768 ao2_lock(sub);
769 sub->final_message_rxed = 1;
770 ast_cond_signal(&sub->join_cond);
772 }
773
774 /*
775 * If filtering is turned on and this is a 'final' message, we only invoke the callback
776 * if the subscriber accepts subscription_change message types.
777 */
778 if (!final || sub->filter != STASIS_SUBSCRIPTION_FILTER_SELECTIVE ||
779 (message_type_id < AST_VECTOR_SIZE(&sub->accepted_message_types) && AST_VECTOR_GET(&sub->accepted_message_types, message_type_id))) {
780 /* Since sub is mostly immutable, no need to lock sub */
781 sub->callback(sub->data, sub, message);
782 }
783
784 /* Notify that the final message has been processed */
785 if (final) {
786 ao2_lock(sub);
787 sub->final_message_processed = 1;
788 ast_cond_signal(&sub->join_cond);
790 }
791
792#ifdef AST_DEVMODE
793 elapsed = ast_tvdiff_ms(ast_tvnow(), start);
794 if (elapsed > sub->statistics->highest_time_invoked) {
795 sub->statistics->highest_time_invoked = elapsed;
796 ao2_lock(sub->statistics);
797 sub->statistics->highest_time_message_type = stasis_message_type(message);
798 ao2_unlock(sub->statistics);
799 }
800 if (elapsed < sub->statistics->lowest_time_invoked) {
801 sub->statistics->lowest_time_invoked = elapsed;
802 }
803#endif
804}

References ao2_lock, ao2_unlock, ast_cond_signal, ast_tvdiff_ms(), ast_tvnow(), AST_VECTOR_GET, AST_VECTOR_SIZE, message_type_id, stasis_message_type(), stasis_message_type_id(), stasis_subscription_change_type(), STASIS_SUBSCRIPTION_FILTER_SELECTIVE, stasis_subscription_final_message(), statistics(), and sub.

Referenced by dispatch_exec_async(), dispatch_exec_sync(), and dispatch_message().

◆ topic_add_subscription()

static int topic_add_subscription ( struct stasis_topic topic,
struct stasis_subscription sub 
)
static

Add a subscriber to a topic.

Parameters
topicTopic
subSubscriber
Returns
0 on success
Non-zero on error

Definition at line 1201 of file stasis.c.

1202{
1203 size_t idx;
1204
1205 ao2_lock(topic);
1206 /* The reference from the topic to the subscription is shared with
1207 * the owner of the subscription, which will explicitly unsubscribe
1208 * to release it.
1209 *
1210 * If we bumped the refcount here, the owner would have to unsubscribe
1211 * and cleanup, which is a bit awkward. */
1213
1214 for (idx = 0; idx < AST_VECTOR_SIZE(&topic->upstream_topics); ++idx) {
1216 AST_VECTOR_GET(&topic->upstream_topics, idx), sub);
1217 }
1218
1219#ifdef AST_DEVMODE
1221 ast_str_container_add(sub->statistics->topics, stasis_topic_name(topic));
1222#endif
1223
1224 ao2_unlock(topic);
1225
1226 return 0;
1227}

References ao2_lock, ao2_unlock, ast_str_container_add(), AST_VECTOR_APPEND, AST_VECTOR_GET, AST_VECTOR_SIZE, stasis_subscription_uniqueid(), stasis_topic_name(), sub, stasis_topic::subscribers, stasis_subscription_change::topic, topic_add_subscription(), and stasis_topic::upstream_topics.

Referenced by internal_stasis_subscribe(), stasis_forward_all(), and topic_add_subscription().

◆ topic_complete_name()

static char * topic_complete_name ( const char *  word)
static

Definition at line 2391 of file stasis.c.

2392{
2393 struct topic_proxy *topic;
2394 struct ao2_iterator it;
2395 int wordlen = strlen(word);
2396 int ret;
2397
2399 while ((topic = ao2_iterator_next(&it))) {
2400 if (!strncasecmp(word, topic->name, wordlen)) {
2401 ret = ast_cli_completion_add(ast_strdup(topic->name));
2402 if (ret) {
2403 ao2_ref(topic, -1);
2404 break;
2405 }
2406 }
2407 ao2_ref(topic, -1);
2408 }
2410 return NULL;
2411}
#define ast_strdup(str)
A wrapper for strdup()
Definition: astmm.h:241
int ast_cli_completion_add(char *value)
Add a result to a request for completion options.
Definition: main/cli.c:2756
short word

References ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_ref, ast_cli_completion_add(), ast_strdup, topic_proxy::name, NULL, and topic_all.

Referenced by stasis_show_topic().

◆ topic_dtor()

static void topic_dtor ( void *  obj)
static

Definition at line 433 of file stasis.c.

434{
435 struct stasis_topic *topic = obj;
436#ifdef AST_DEVMODE
437 struct ao2_container *topic_stats;
438#endif
439
440 ast_debug(2, "Destroying topic. name: %s, detail: %s\n",
441 topic->name, topic->detail);
442
443 /* Subscribers hold a reference to topics, so they should all be
444 * unsubscribed before we get here. */
446
449 ast_debug(1, "Topic '%s': %p destroyed\n", topic->name, topic);
450
451#ifdef AST_DEVMODE
452 if (topic->statistics) {
453 topic_stats = ao2_global_obj_ref(topic_statistics);
454 if (topic_stats) {
455 ao2_unlink(topic_stats, topic->statistics);
456 ao2_ref(topic_stats, -1);
457 }
458 ao2_ref(topic->statistics, -1);
459 }
460#endif
461}

References ao2_global_obj_ref, ao2_ref, ao2_unlink, ast_assert, ast_debug, AST_VECTOR_FREE, AST_VECTOR_SIZE, stasis_topic::detail, stasis_topic::name, stasis_topic::subscribers, and stasis_topic::upstream_topics.

Referenced by stasis_topic_create_with_detail().

◆ topic_pool_dtor()

static void topic_pool_dtor ( void *  obj)
static

Definition at line 1744 of file stasis.c.

1745{
1746 struct stasis_topic_pool *pool = obj;
1747
1748#ifdef AO2_DEBUG
1749 {
1750 char *container_name =
1751 ast_alloca(strlen(stasis_topic_name(pool->pool_topic)) + strlen("-pool") + 1);
1752 sprintf(container_name, "%s-pool", stasis_topic_name(pool->pool_topic));
1753 ao2_container_unregister(container_name);
1754 }
1755#endif
1756
1758 pool->pool_container = NULL;
1759 ao2_cleanup(pool->pool_topic);
1760 pool->pool_topic = NULL;
1761}
void ao2_container_unregister(const char *name)
Unregister a container for CLI stats and integrity check.

References ao2_cleanup, ao2_container_unregister(), ast_alloca, NULL, stasis_topic_pool::pool_container, stasis_topic_pool::pool_topic, and stasis_topic_name().

Referenced by stasis_topic_pool_create().

◆ topic_pool_entry_alloc()

static struct topic_pool_entry * topic_pool_entry_alloc ( const char *  topic_name)
static

Definition at line 1724 of file stasis.c.

1725{
1727
1728 topic_pool_entry = ao2_alloc_options(sizeof(*topic_pool_entry) + strlen(topic_name) + 1,
1730 if (!topic_pool_entry) {
1731 return NULL;
1732 }
1733
1734 strcpy(topic_pool_entry->name, topic_name); /* Safe */
1735
1736 return topic_pool_entry;
1737}
static void topic_pool_entry_dtor(void *obj)
Definition: stasis.c:1715
char name[0]
Definition: stasis.c:1712

References AO2_ALLOC_OPT_LOCK_NOLOCK, ao2_alloc_options, topic_pool_entry::name, NULL, and topic_pool_entry_dtor().

Referenced by stasis_topic_pool_get_topic().

◆ topic_pool_entry_cmp()

static int topic_pool_entry_cmp ( void *  obj,
void *  arg,
int  flags 
)
static

Definition at line 1784 of file stasis.c.

1785{
1786 const struct topic_pool_entry *object_left = obj;
1787 const struct topic_pool_entry *object_right = arg;
1788 const char *right_key = arg;
1789 int cmp;
1790
1791 switch (flags & OBJ_SEARCH_MASK) {
1792 case OBJ_SEARCH_OBJECT:
1793 right_key = object_right->name;
1794 /* Fall through */
1795 case OBJ_SEARCH_KEY:
1796 cmp = strcasecmp(object_left->name, right_key);
1797 break;
1799 /* Not supported by container */
1800 ast_assert(0);
1801 cmp = -1;
1802 break;
1803 default:
1804 /*
1805 * What arg points to is specific to this traversal callback
1806 * and has no special meaning to astobj2.
1807 */
1808 cmp = 0;
1809 break;
1810 }
1811 if (cmp) {
1812 return 0;
1813 }
1814 /*
1815 * At this point the traversal callback is identical to a sorted
1816 * container.
1817 */
1818 return CMP_MATCH;
1819}
@ CMP_MATCH
Definition: astobj2.h:1027
@ OBJ_SEARCH_PARTIAL_KEY
The arg parameter is a partial search key similar to OBJ_SEARCH_KEY.
Definition: astobj2.h:1116
@ OBJ_SEARCH_MASK
Search option field mask.
Definition: astobj2.h:1072

References ast_assert, CMP_MATCH, topic_pool_entry::name, OBJ_SEARCH_KEY, OBJ_SEARCH_MASK, OBJ_SEARCH_OBJECT, and OBJ_SEARCH_PARTIAL_KEY.

Referenced by stasis_topic_pool_create().

◆ topic_pool_entry_dtor()

static void topic_pool_entry_dtor ( void *  obj)
static

Definition at line 1715 of file stasis.c.

1716{
1717 struct topic_pool_entry *entry = obj;
1718
1719 entry->forward = stasis_forward_cancel(entry->forward);
1720 ao2_cleanup(entry->topic);
1721 entry->topic = NULL;
1722}
struct stasis_forward * stasis_forward_cancel(struct stasis_forward *forward)
Definition: stasis.c:1548
Definition: search.h:40

References ao2_cleanup, NULL, and stasis_forward_cancel().

Referenced by topic_pool_entry_alloc().

◆ topic_pool_entry_hash()

static int topic_pool_entry_hash ( const void *  obj,
const int  flags 
)
static

Definition at line 1763 of file stasis.c.

1764{
1765 const struct topic_pool_entry *object;
1766 const char *key;
1767
1768 switch (flags & OBJ_SEARCH_MASK) {
1769 case OBJ_SEARCH_KEY:
1770 key = obj;
1771 break;
1772 case OBJ_SEARCH_OBJECT:
1773 object = obj;
1774 key = object->name;
1775 break;
1776 default:
1777 /* Hash can only work on something with a full key. */
1778 ast_assert(0);
1779 return 0;
1780 }
1781 return ast_str_case_hash(key);
1782}
static force_inline int attribute_pure ast_str_case_hash(const char *str)
Compute a hash value on a case-insensitive string.
Definition: strings.h:1303

References ast_assert, ast_str_case_hash(), OBJ_SEARCH_KEY, OBJ_SEARCH_MASK, and OBJ_SEARCH_OBJECT.

Referenced by stasis_topic_pool_create().

◆ topic_remove_subscription()

static int topic_remove_subscription ( struct stasis_topic topic,
struct stasis_subscription sub 
)
static

Definition at line 1229 of file stasis.c.

1230{
1231 size_t idx;
1232 int res;
1233
1234 ao2_lock(topic);
1235 for (idx = 0; idx < AST_VECTOR_SIZE(&topic->upstream_topics); ++idx) {
1237 AST_VECTOR_GET(&topic->upstream_topics, idx), sub);
1238 }
1241
1242#ifdef AST_DEVMODE
1243 if (!res) {
1245 ast_str_container_remove(sub->statistics->topics, stasis_topic_name(topic));
1246 }
1247#endif
1248
1249 ao2_unlock(topic);
1250
1251 return res;
1252}
void ast_str_container_remove(struct ao2_container *str_container, const char *remove)
Removes a string from a string container allocated by ast_str_container_alloc.
Definition: strings.c:221

References ao2_lock, ao2_unlock, ast_str_container_remove(), AST_VECTOR_ELEM_CLEANUP_NOOP, AST_VECTOR_GET, AST_VECTOR_REMOVE_ELEM_UNORDERED, AST_VECTOR_SIZE, stasis_subscription_uniqueid(), stasis_topic_name(), sub, stasis_topic::subscribers, stasis_subscription_change::topic, topic_remove_subscription(), and stasis_topic::upstream_topics.

Referenced by stasis_forward_cancel(), stasis_unsubscribe(), and topic_remove_subscription().

◆ userevent_exclusion_cb()

static int userevent_exclusion_cb ( const char *  key)
static

Definition at line 2147 of file stasis.c.

2148{
2149 if (!strcmp("eventname", key)) {
2150 return 1;
2151 }
2152 return 0;
2153}

Referenced by multi_user_event_to_ami().

Variable Documentation

◆ cli_stasis

struct ast_cli_entry cli_stasis[]
static
Initial value:
= {
{ .handler = stasis_show_topics , .summary = "Show all topics" ,},
{ .handler = stasis_show_topic , .summary = "Show topic" ,},
}
static char * stasis_show_topics(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
Definition: stasis.c:2334
static char * stasis_show_topic(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
Definition: stasis.c:2417

Definition at line 2476 of file stasis.c.

Referenced by stasis_cleanup(), and stasis_init().

◆ declined_option

struct aco_type declined_option
static

An aco_type structure to link the "declined_message_types" category to the stasis_declined_config type.

Definition at line 2213 of file stasis.c.

Referenced by stasis_init().

◆ declined_options

struct aco_type* declined_options[] = ACO_TYPES(&declined_option)

Definition at line 2221 of file stasis.c.

Referenced by stasis_init().

◆ stasis_conf

struct aco_file stasis_conf
Initial value:
= {
.filename = "stasis.conf",
}
#define ACO_TYPES(...)
A helper macro to ensure that aco_info types always have a sentinel.

Definition at line 2223 of file stasis.c.

◆ threadpool

struct ast_threadpool* threadpool
static

Thread pool for topics that don't want a dedicated taskprocessor

Definition at line 307 of file stasis.c.

Referenced by internal_stasis_subscribe(), stasis_cleanup(), and stasis_init().

◆ threadpool_option

struct aco_type threadpool_option
static

Definition at line 2202 of file stasis.c.

Referenced by stasis_init().

◆ threadpool_options

struct aco_type* threadpool_options[] = ACO_TYPES(&threadpool_option)
static

Definition at line 2210 of file stasis.c.

Referenced by sip_get_threadpool_options(), and stasis_init().

◆ topic_all

struct ao2_container* topic_all