2b56b53f81283514d91cd0615b5ec737735f5c7d
[asterisk/asterisk.git] / include / asterisk / stasis.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2013, Digium, Inc.
5  *
6  * David M. Lee, II <dlee@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 #ifndef _ASTERISK_STASIS_H
20 #define _ASTERISK_STASIS_H
21
22 /*! \file
23  *
24  * \brief Stasis Message Bus API. See \ref stasis "Stasis Message Bus API" for
25  * detailed documentation.
26  *
27  * \author David M. Lee, II <dlee@digium.com>
28  * \since 12
29  *
30  * \page stasis Stasis Message Bus API
31  *
32  * \par Intro
33  *
34  * The Stasis Message Bus is a loosely typed mechanism for distributing messages
35  * within Asterisk. It is designed to be:
36  *  - Loosely coupled; new message types can be added in seperate modules.
37  *  - Easy to use; publishing and subscribing are straightforward operations.
38  *
39  * There are three main concepts for using the Stasis Message Bus:
40  *  - \ref stasis_message
41  *  - \ref stasis_topic
42  *  - \ref stasis_subscription
43  *
44  * \par stasis_message
45  *
46  * Central to the Stasis Message Bus is the \ref stasis_message, the messages
47  * that are sent on the bus. These messages have:
48  *  - a type (as defined by a \ref stasis_message_type)
49  *  - a value - a \c void pointer to an AO2 object
50  *  - a timestamp when it was created
51  *
52  * Once a \ref stasis_message has been created, it is immutable and cannot
53  * change. The same goes for the value of the message (although this cannot be
54  * enforced in code). Messages themselves are reference-counted, AO2 objects,
55  * along with their values. By being both reference counted and immutable,
56  * messages can be shared throughout the system without any concerns for
57  * threading.
58  *
59  * The type of a message is defined by an instance of \ref stasis_message_type,
60  * which can be created by calling stasis_message_type_create(). Message types
61  * are named, which is useful in debugging. It is recommended that the string
62  * name for a message type match the name of the struct that's stored in the
63  * message. For example, name for \ref stasis_cache_update's message type is \c
64  * "stasis_cache_update".
65  *
66  * \par stasis_topic
67  *
68  * A \ref stasis_topic is an object to which \ref stasis_subscriber's may be
69  * subscribed, and \ref stasis_message's may be published. Any message published
70  * to the topic is dispatched to all of its subscribers. The topic itself may be
71  * named, which is useful in debugging.
72  *
73  * Topics themselves are reference counted objects. Since topics are referred to
74  * by their subscibers, they will not be freed until all of their subscribers
75  * have unsubscribed. Topics are also thread safe, so no worries about
76  * publishing/subscribing/unsubscribing to a topic concurrently from multiple
77  * threads. It's also designed to handle the case of unsubscribing from a topic
78  * from within the subscription handler.
79  *
80  * \par Forwarding
81  *
82  * There is one special case of topics that's worth noting: forwarding
83  * messages. It's a fairly common use case to want to forward all the messages
84  * published on one topic to another one (for example, an aggregator topic that
85  * publishes all the events from a set of other topics). This can be
86  * accomplished easily using stasis_forward_all(). This sets up the forwarding
87  * between the two topics, and returns a \ref stasis_subscription, which can be
88  * unsubscribed to stop the forwarding.
89  *
90  * \par Caching
91  *
92  * Another common use case is to want to cache certain messages that are
93  * published on the bus. Usually these events are snapshots of the current state
94  * in the system, and it's desirable to query that state from the cache without
95  * locking the original object. It's also desirable for subscribers of the
96  * caching topic to receive messages that have both the old cache value and the
97  * new value being put into the cache. For this, we have stasis_cache_create()
98  * and stasis_caching_topic_create(), providing them with the topic which
99  * publishes the messages that you wish to cache, and a function that can
100  * identify cacheable messages.
101  *
102  * The \ref stasis_cache is designed so that it may be shared amongst several
103  * \ref stasis_caching_topic objects. This allows you to have individual caching
104  * topics per-object (i.e. so you can subscribe to updates for a single object),
105  * and still have a single cache to query for the state of all objects. While a
106  * cache may be shared amongst different message types, such a usage is probably
107  * not a good idea.
108  *
109  * The \ref stasis_cache can only be written to by \ref stasis_caching_topics.
110  * It's a thread safe container, so freely use the stasis_cache_get() and
111  * stasis_cache_dump() to query the cache.
112  *
113  * The \ref stasis_caching_topic discards non-cacheable messages. A cacheable
114  * message is wrapped in a \ref stasis_cache_update message which provides the
115  * old snapshot (or \c NULL if this is a new cache entry), and the new snapshot
116  * (or \c NULL if the entry was removed from the cache). A
117  * stasis_cache_clear_create() message must be sent to the topic in order to
118  * remove entries from the cache.
119  *
120  * In order to unsubscribe a \ref stasis_caching_topic from the upstream topic,
121  * call stasis_caching_unsubscribe(). Due to cyclic references, the \ref
122  * stasis_caching_topic will not be freed until after it has been unsubscribed,
123  * and all other ao2_ref()'s have been cleaned up.
124  *
125  * The \ref stasis_cache object is a normal AO2 managed object, which can be
126  * release with ao2_cleanup().
127  *
128  * \par stasis_subscriber
129  *
130  * Any topic may be subscribed to by simply providing stasis_subscribe() the
131  * \ref stasis_topic to subscribe to, a handler function and \c void pointer to
132  * data that is passed back to the handler. Invocations on the subscription's
133  * handler are serialized, but different invocations may occur on different
134  * threads (this usually isn't important unless you use thread locals or
135  * something similar).
136  *
137  * In order to stop receiving messages, call stasis_unsubscribe() with your \ref
138  * stasis_subscription. Due to cyclic references, the \ref
139  * stasis_subscription will not be freed until after it has been unsubscribed,
140  * and all other ao2_ref()'s have been cleaned up.
141  *
142  * \par Shutdown
143  *
144  * Subscriptions have two options for unsubscribing, depending upon the context
145  * in which you need to unsubscribe.
146  *
147  * If your subscription is owned by a module, and you must unsubscribe from the
148  * module_unload() function, then you'll want to use the
149  * stasis_unsubscribe_and_join() function. This will block until the final
150  * message has been received on the subscription. Otherwise, there's the danger
151  * of invoking the callback function after it has been unloaded.
152  *
153  * If your subscription is owned by an object, then your object should have an
154  * explicit shutdown() function, which calls stasis_unsubscribe(). In your
155  * subscription handler, when the stasis_subscription_final_message() has been
156  * received, decrement the refcount on your object. In your object's destructor,
157  * you may assert that stasis_subscription_is_done() to validate that the
158  * subscription's callback will no longer be invoked.
159  *
160  * \b Note: You may be tempted to simply call stasis_unsubscribe_and_join() from
161  * an object's destructor. While code that does this may work most of the time,
162  * it's got one big downside. There's a general assumption that object
163  * destruction is non-blocking. If you block the destruction waiting for the
164  * subscription to complete, there's the danger that the subscription may
165  * process a message which will bump the refcount up by one. Then it does
166  * whatever it does, decrements the refcount, which then proceeds to re-destroy
167  * the object. Now you've got hard to reproduce bugs that only show up under
168  * certain loads.
169  */
170
171 #include "asterisk/json.h"
172 #include "asterisk/manager.h"
173 #include "asterisk/utils.h"
174 #include "asterisk/event.h"
175
176 /*!
177  * \brief Metadata about a \ref stasis_message.
178  * \since 12
179  */
180 struct stasis_message_type;
181
182 /*!
183  * \brief Opaque type for a Stasis message.
184  * \since 12
185  */
186 struct stasis_message;
187
188 /*!
189  * \brief Opaque type for a Stasis subscription.
190  * \since 12
191  */
192 struct stasis_subscription;
193
194 /*!
195  * \brief Structure containing callbacks for Stasis message sanitization
196  *
197  * \note If either callback is implemented, both should be implemented since
198  * not all callers may have access to the full snapshot.
199  */
200 struct stasis_message_sanitizer {
201         /*!
202          * \brief Callback which determines whether a channel should be sanitized from
203          * a message based on the channel's unique ID
204          *
205          * \param channel_id The unique ID of the channel
206          *
207          * \retval non-zero if the channel should be left out of the message
208          * \retval zero if the channel should remain in the message
209          */
210         int (*channel_id)(const char *channel_id);
211
212         /*!
213          * \brief Callback which determines whether a channel should be sanitized from
214          * a message based on the channel's snapshot
215          *
216          * \param snapshot A snapshot generated from the channel
217          *
218          * \retval non-zero if the channel should be left out of the message
219          * \retval zero if the channel should remain in the message
220          */
221         int (*channel_snapshot)(const struct ast_channel_snapshot *snapshot);
222
223         /*!
224          * \brief Callback which determines whether a channel should be sanitized from
225          * a message based on the channel
226          *
227          * \param chan The channel to be checked
228          *
229          * \retval non-zero if the channel should be left out of the message
230          * \retval zero if the channel should remain in the message
231          */
232         int (*channel)(const struct ast_channel *chan);
233 };
234
235 /*!
236  * \brief Virtual table providing methods for messages.
237  * \since 12
238  */
239 struct stasis_message_vtable {
240         /*!
241          * \brief Build the JSON representation of the message.
242          *
243          * May be \c NULL, or may return \c NULL, to indicate no representation.
244          * The returned object should be ast_json_unref()'ed.
245          *
246          * \param message Message to convert to JSON string.
247          * \param sanitize Snapshot sanitization callback.
248          *
249          * \return Newly allocated JSON message.
250          * \return \c NULL on error.
251          * \return \c NULL if JSON format is not supported.
252          */
253         struct ast_json *(*to_json)(struct stasis_message *message, const struct stasis_message_sanitizer *sanitize);
254
255         /*!
256          * \brief Build the AMI representation of the message.
257          *
258          * May be \c NULL, or may return \c NULL, to indicate no representation.
259          * The returned object should be ao2_cleanup()'ed.
260          *
261          * \param message Message to convert to AMI string.
262          * \return Newly allocated \ref ast_manager_event_blob.
263          * \return \c NULL on error.
264          * \return \c NULL if AMI format is not supported.
265          */
266         struct ast_manager_event_blob *(*to_ami)(
267                 struct stasis_message *message);
268
269         /*!
270          * \since 12.3.0
271          * \brief Build the \ref ast_event representation of the message.
272          *
273          * May be \c NULL, or may return \c NULL, to indicate no representation.
274          * The returned object should be free'd.
275          *
276          * \param message Message to convert to an \ref ast_event.
277          * \return Newly allocated \ref ast_event.
278          * \return \c NULL on error.
279          * \return \c NULL if AMI format is not supported.
280          */
281         struct ast_event *(*to_event)(
282                 struct stasis_message *message);
283 };
284
285 /*!
286  * \brief Return code for Stasis message type creation attempts
287  */
288 enum stasis_message_type_result {
289         STASIS_MESSAGE_TYPE_ERROR = -1, /*!< Message type was not created due to allocation failure */
290         STASIS_MESSAGE_TYPE_SUCCESS,    /*!< Message type was created successfully */
291         STASIS_MESSAGE_TYPE_DECLINED,   /*!< Message type was not created due to configuration */
292 };
293
294 /*!
295  * \brief Create a new message type.
296  *
297  * \ref stasis_message_type is an AO2 object, so ao2_cleanup() when you're done
298  * with it.
299  *
300  * \param name Name of the new type.
301  * \param vtable Virtual table of message methods. May be \c NULL.
302  * \param[out] result The location where the new message type will be placed
303  *
304  * \note Stasis message type creation may be declined if the message type is disabled
305  *
306  * \returns A stasis_message_type_result enum
307  * \since 12
308  */
309 enum stasis_message_type_result stasis_message_type_create(const char *name,
310         struct stasis_message_vtable *vtable, struct stasis_message_type **result);
311
312 /*!
313  * \brief Gets the name of a given message type
314  * \param type The type to get.
315  * \return Name of the type.
316  * \return \c NULL if \a type is \c NULL.
317  * \since 12
318  */
319 const char *stasis_message_type_name(const struct stasis_message_type *type);
320
321 /*!
322  * \brief Gets the hash of a given message type
323  * \param type The type to get the hash of.
324  * \return The hash
325  * \since 13.24.0
326  */
327 unsigned int stasis_message_type_hash(const struct stasis_message_type *type);
328
329 /*!
330  * \brief Check whether a message type is declined
331  *
332  * \param name The name of the message type to check
333  *
334  * \retval zero The message type is not declined
335  * \retval non-zero The message type is declined
336  */
337 int stasis_message_type_declined(const char *name);
338
339 /*!
340  * \brief Create a new message.
341  *
342  * This message is an \c ao2 object, and must be ao2_cleanup()'ed when you are done
343  * with it. Messages are also immutable, and must not be modified after they
344  * are initialized. Especially the \a data in the message.
345  *
346  * \param type Type of the message
347  * \param data Immutable data that is the actual contents of the message
348  *
349  * \return New message
350  * \return \c NULL on error
351  *
352  * \since 12
353  */
354 struct stasis_message *stasis_message_create(struct stasis_message_type *type, void *data);
355
356 /*!
357  * \brief Create a new message for an entity.
358  *
359  * This message is an \c ao2 object, and must be ao2_cleanup()'ed when you are done
360  * with it. Messages are also immutable, and must not be modified after they
361  * are initialized. Especially the \a data in the message.
362  *
363  * \param type Type of the message
364  * \param data Immutable data that is the actual contents of the message
365  * \param eid What entity originated this message. (NULL for aggregate)
366  *
367  * \note An aggregate message is a combined representation of the local
368  * and remote entities publishing the message data.  e.g., An aggregate
369  * device state represents the combined device state from the local and
370  * any remote entities publishing state for a device.  e.g., An aggregate
371  * MWI message is the old/new MWI counts accumulated from the local and
372  * any remote entities publishing to a mailbox.
373  *
374  * \retval New message
375  * \retval \c NULL on error
376  *
377  * \since 12.2.0
378  */
379 struct stasis_message *stasis_message_create_full(struct stasis_message_type *type, void *data, const struct ast_eid *eid);
380
381 /*!
382  * \brief Get the entity id for a \ref stasis_message.
383  * \since 12.2.0
384  *
385  * \param msg Message to get eid.
386  *
387  * \retval Entity id of \a msg
388  * \retval \c NULL if \a msg is an aggregate or \a msg is \c NULL.
389  */
390 const struct ast_eid *stasis_message_eid(const struct stasis_message *msg);
391
392 /*!
393  * \brief Get the message type for a \ref stasis_message.
394  * \param msg Message to type
395  * \return Type of \a msg
396  * \return \c NULL if \a msg is \c NULL.
397  * \since 12
398  */
399 struct stasis_message_type *stasis_message_type(const struct stasis_message *msg);
400
401 /*!
402  * \brief Get the data contained in a message.
403  * \param msg Message.
404  * \return Immutable data pointer
405  * \return \c NULL if msg is \c NULL.
406  * \since 12
407  */
408 void *stasis_message_data(const struct stasis_message *msg);
409
410 /*!
411  * \brief Get the time when a message was created.
412  * \param msg Message.
413  * \return Pointer to the \a timeval when the message was created.
414  * \return \c NULL if msg is \c NULL.
415  * \since 12
416  */
417 const struct timeval *stasis_message_timestamp(const struct stasis_message *msg);
418
419 /*!
420  * \brief Build the JSON representation of the message.
421  *
422  * May return \c NULL, to indicate no representation. The returned object should
423  * be ast_json_unref()'ed.
424  *
425  * \param msg Message to convert to JSON string.
426  * \param sanitize Snapshot sanitization callback.
427  *
428  * \return Newly allocated string with JSON message.
429  * \return \c NULL on error.
430  * \return \c NULL if JSON format is not supported.
431  */
432 struct ast_json *stasis_message_to_json(struct stasis_message *msg, struct stasis_message_sanitizer *sanitize);
433
434 /*!
435  * \brief Build the AMI representation of the message.
436  *
437  * May return \c NULL, to indicate no representation. The returned object should
438  * be ao2_cleanup()'ed.
439  *
440  * \param msg Message to convert to AMI.
441  * \return \c NULL on error.
442  * \return \c NULL if AMI format is not supported.
443  */
444 struct ast_manager_event_blob *stasis_message_to_ami(struct stasis_message *msg);
445
446 /*!
447  * \brief Determine if the given message can be converted to AMI.
448  *
449  * \param msg Message to see if can be converted to AMI.
450  *
451  * \retval 0 Cannot be converted
452  * \retval non-zero Can be converted
453  */
454 int stasis_message_can_be_ami(struct stasis_message *msg);
455
456 /*!
457  * \brief Build the \ref AstGenericEvents representation of the message.
458  *
459  * May return \c NULL, to indicate no representation. The returned object should
460  * be disposed of via \ref ast_event_destroy.
461  *
462  * \param msg Message to convert to AMI.
463  * \return \c NULL on error.
464  * \return \c NULL if AMI format is not supported.
465  */
466 struct ast_event *stasis_message_to_event(struct stasis_message *msg);
467
468 /*!
469  * \brief A topic to which messages may be posted, and subscribers, well, subscribe
470  * \since 12
471  */
472 struct stasis_topic;
473
474 /*!
475  * \brief Create a new topic.
476  * \param name Name of the new topic.
477  * \return New topic instance.
478  * \return \c NULL on error.
479  * \since 12
480  *
481  * \note There is no explicit ability to unsubscribe all subscribers
482  * from a topic and destroy it. As a result the topic can persist until
483  * the last subscriber unsubscribes itself even if there is no
484  * publisher.
485  */
486 struct stasis_topic *stasis_topic_create(const char *name);
487
488 /*!
489  * \brief Return the name of a topic.
490  * \param topic Topic.
491  * \return Name of the topic.
492  * \return \c NULL if topic is \c NULL.
493  * \since 12
494  */
495 const char *stasis_topic_name(const struct stasis_topic *topic);
496
497 /*!
498  * \brief Publish a message to a topic's subscribers.
499  * \param topic Topic.
500  * \param message Message to publish.
501  *
502  * This call is asynchronous and will return immediately upon queueing
503  * the message for delivery to the topic's subscribers.
504  *
505  * \since 12
506  */
507 void stasis_publish(struct stasis_topic *topic, struct stasis_message *message);
508
509 /*!
510  * \brief Publish a message to a topic's subscribers, synchronizing
511  * on the specified subscriber
512  * \param sub Subscription to synchronize on.
513  * \param message Message to publish.
514  *
515  * The caller of stasis_publish_sync will block until the specified
516  * subscriber completes handling of the message.
517  *
518  * All other subscribers to the topic the \ref stasis_subpscription
519  * is subscribed to are also delivered the message; this delivery however
520  * happens asynchronously.
521  *
522  * \since 12.1.0
523  */
524 void stasis_publish_sync(struct stasis_subscription *sub, struct stasis_message *message);
525
526 /*!
527  * \brief Callback function type for Stasis subscriptions.
528  * \param data Data field provided with subscription.
529  * \param message Published message.
530  * \since 12
531  */
532 typedef void (*stasis_subscription_cb)(void *data, struct stasis_subscription *sub, struct stasis_message *message);
533
534 /*!
535  * \brief Stasis subscription callback function that does nothing.
536  *
537  * \note This callback should be used for events are not directly processed, but need
538  * to be generated so data can be retrieved from cache later.  Subscriptions with this
539  * callback can be released with \ref stasis_unsubscribe, even during module unload.
540  *
541  * \since 13.5
542  */
543 void stasis_subscription_cb_noop(void *data, struct stasis_subscription *sub, struct stasis_message *message);
544
545 /*!
546  * \brief Create a subscription.
547  *
548  * In addition to being AO2 managed memory (requiring an ao2_cleanup() to free
549  * up this reference), the subscription must be explicitly unsubscribed from its
550  * topic using stasis_unsubscribe().
551  *
552  * The invocations of the callback are serialized, but may not always occur on
553  * the same thread. The invocation order of different subscriptions is
554  * unspecified.
555  *
556  * \param topic Topic to subscribe to.
557  * \param callback Callback function for subscription messages.
558  * \param data Data to be passed to the callback, in addition to the message.
559  * \return New \ref stasis_subscription object.
560  * \return \c NULL on error.
561  * \since 12
562  */
563 struct stasis_subscription *stasis_subscribe(struct stasis_topic *topic,
564         stasis_subscription_cb callback, void *data);
565
566 /*!
567  * \brief Create a subscription whose callbacks occur on a thread pool
568  *
569  * In addition to being AO2 managed memory (requiring an ao2_cleanup() to free
570  * up this reference), the subscription must be explicitly unsubscribed from its
571  * topic using stasis_unsubscribe().
572  *
573  * The invocations of the callback are serialized, but will almost certainly not
574  * always happen on the same thread. The invocation order of different subscriptions
575  * is unspecified.
576  *
577  * Unlike \ref stasis_subscribe, this function will explicitly use a threadpool to
578  * dispatch items to its \c callback. This form of subscription should be used
579  * when many subscriptions may be made to the specified \c topic.
580  *
581  * \param topic Topic to subscribe to.
582  * \param callback Callback function for subscription messages.
583  * \param data Data to be passed to the callback, in addition to the message.
584  * \return New \ref stasis_subscription object.
585  * \return \c NULL on error.
586  * \since 12.8.0
587  */
588 struct stasis_subscription *stasis_subscribe_pool(struct stasis_topic *topic,
589         stasis_subscription_cb callback, void *data);
590
591 /*!
592  * \brief Cancel a subscription.
593  *
594  * Note that in an asynchronous system, there may still be messages queued or
595  * in transit to the subscription's callback. These will still be delivered.
596  * There will be a final 'SubscriptionCancelled' message, indicating the
597  * delivery of the final message.
598  *
599  * \param subscription Subscription to cancel.
600  * \return \c NULL for convenience
601  * \since 12
602  */
603 struct stasis_subscription *stasis_unsubscribe(
604         struct stasis_subscription *subscription);
605
606 /*!
607  * \brief Set the high and low alert water marks of the stasis subscription.
608  * \since 13.10.0
609  *
610  * \param subscription Pointer to a stasis subscription
611  * \param low_water New queue low water mark. (-1 to set as 90% of high_water)
612  * \param high_water New queue high water mark.
613  *
614  * \retval 0 on success.
615  * \retval -1 on error (water marks not changed).
616  */
617 int stasis_subscription_set_congestion_limits(struct stasis_subscription *subscription,
618         long low_water, long high_water);
619
620 /*!
621  * \brief Block until the last message is processed on a subscription.
622  *
623  * This function will not return until the \a subscription's callback for the
624  * stasis_subscription_final_message() completes. This allows cleanup routines
625  * to run before unblocking the joining thread.
626  *
627  * \param subscription Subscription to block on.
628  * \since 12
629  */
630 void stasis_subscription_join(struct stasis_subscription *subscription);
631
632 /*!
633  * \brief Returns whether \a subscription has received its final message.
634  *
635  * Note that a subscription is considered done even while the
636  * stasis_subscription_final_message() is being processed. This allows cleanup
637  * routines to check the status of the subscription.
638  *
639  * \param subscription Subscription.
640  * \return True (non-zero) if stasis_subscription_final_message() has been
641  *         received.
642  * \return False (zero) if waiting for the end.
643  */
644 int stasis_subscription_is_done(struct stasis_subscription *subscription);
645
646 /*!
647  * \brief Cancel a subscription, blocking until the last message is processed.
648  *
649  * While normally it's recommended to stasis_unsubscribe() and wait for
650  * stasis_subscription_final_message(), there are times (like during a module
651  * unload) where you have to wait for the final message (otherwise you'll call
652  * a function in a shared module that no longer exists).
653  *
654  * \param subscription Subscription to cancel.
655  * \return \c NULL for convenience
656  * \since 12
657  */
658 struct stasis_subscription *stasis_unsubscribe_and_join(
659         struct stasis_subscription *subscription);
660
661 struct stasis_forward;
662
663 /*!
664  * \brief Create a subscription which forwards all messages from one topic to
665  * another.
666  *
667  * Note that the \a topic parameter of the invoked callback will the be the
668  * \a topic the message was sent to, not the topic the subscriber subscribed to.
669  *
670  * \param from_topic Topic to forward.
671  * \param to_topic Destination topic of forwarded messages.
672  * \return New forwarding subscription.
673  * \return \c NULL on error.
674  * \since 12
675  */
676 struct stasis_forward *stasis_forward_all(struct stasis_topic *from_topic,
677         struct stasis_topic *to_topic);
678
679 struct stasis_forward *stasis_forward_cancel(struct stasis_forward *forward);
680
681 /*!
682  * \brief Get the unique ID for the subscription.
683  *
684  * \param sub Subscription for which to get the unique ID.
685  * \return Unique ID for the subscription.
686  * \since 12
687  */
688 const char *stasis_subscription_uniqueid(const struct stasis_subscription *sub);
689
690 /*!
691  * \brief Returns whether a subscription is currently subscribed.
692  *
693  * Note that there may still be messages queued up to be dispatched to this
694  * subscription, but the stasis_subscription_final_message() has been enqueued.
695  *
696  * \param sub Subscription to check
697  * \return False (zero) if subscription is not subscribed.
698  * \return True (non-zero) if still subscribed.
699  */
700 int stasis_subscription_is_subscribed(const struct stasis_subscription *sub);
701
702 /*!
703  * \brief Determine whether a message is the final message to be received on a subscription.
704  *
705  * \param sub Subscription on which the message was received.
706  * \param msg Message to check.
707  * \return zero if the provided message is not the final message.
708  * \return non-zero if the provided message is the final message.
709  * \since 12
710  */
711 int stasis_subscription_final_message(struct stasis_subscription *sub, struct stasis_message *msg);
712
713 /*! \addtogroup StasisTopicsAndMessages
714  * @{
715  */
716
717 /*!
718  * \brief Holds details about changes to subscriptions for the specified topic
719  * \since 12
720  */
721 struct stasis_subscription_change {
722         AST_DECLARE_STRING_FIELDS(
723                 AST_STRING_FIELD(uniqueid);     /*!< The unique ID associated with this subscription */
724                 AST_STRING_FIELD(description);  /*!< The description of the change to the subscription associated with the uniqueid */
725         );
726         struct stasis_topic *topic;             /*!< The topic the subscription is/was subscribing to */
727 };
728
729 /*!
730  * \brief Gets the message type for subscription change notices
731  * \return The stasis_message_type for subscription change notices
732  * \since 12
733  */
734 struct stasis_message_type *stasis_subscription_change_type(void);
735
736 /*! @} */
737
738 /*!
739  * \brief Pool for topic aggregation
740  */
741 struct stasis_topic_pool;
742
743 /*!
744  * \brief Create a topic pool that routes messages from dynamically generated topics to the given topic
745  * \param pooled_topic Topic to which messages will be routed
746  * \return the new stasis_topic_pool
747  * \return \c NULL on failure
748  */
749 struct stasis_topic_pool *stasis_topic_pool_create(struct stasis_topic *pooled_topic);
750
751 /*!
752  * \brief Find or create a topic in the pool
753  * \param pool Pool for which to get the topic
754  * \param topic_name Name of the topic to get
755  * \return The already stored or newly allocated topic
756  * \return \c NULL if the topic was not found and could not be allocated
757  */
758 struct stasis_topic *stasis_topic_pool_get_topic(struct stasis_topic_pool *pool, const char *topic_name);
759
760 /*!
761  * \brief Delete a topic from the topic pool
762  *
763  * \param pool Pool from which to delete the topic
764  * \param topic_name Name of the topic to delete
765  *
766  * \since 13.24
767  * \since 15.6
768  * \since 16.1
769  */
770 void stasis_topic_pool_delete_topic(struct stasis_topic_pool *pool, const char *topic_name);
771
772 /*!
773  * \brief Check if a topic exists in a pool
774  * \param pool Pool to check
775  * \param topic_name Name of the topic to check
776  * \retval 1 exists
777  * \retval 0 does not exist
778  * \since 13.23.0
779  */
780 int stasis_topic_pool_topic_exists(const struct stasis_topic_pool *pool, const char *topic_name);
781
782 /*! \addtogroup StasisTopicsAndMessages
783  * @{
784  */
785
786 /*!
787  * \brief Message type for cache update messages.
788  * \return Message type for cache update messages.
789  * \since 12
790  */
791 struct stasis_message_type *stasis_cache_update_type(void);
792
793 /*!
794  * \brief Cache update message
795  * \since 12
796  */
797 struct stasis_cache_update {
798         /*! \brief Convenience reference to snapshot type */
799         struct stasis_message_type *type;
800         /*! \brief Old value from the cache */
801         struct stasis_message *old_snapshot;
802         /*! \brief New value */
803         struct stasis_message *new_snapshot;
804 };
805
806 /*!
807  * \brief Message type for clearing a message from a stasis cache.
808  * \since 12
809  */
810 struct stasis_message_type *stasis_cache_clear_type(void);
811
812 /*! @} */
813
814 /*!
815  * \brief A message cache, for use with \ref stasis_caching_topic.
816  * \since 12
817  */
818 struct stasis_cache;
819
820 /*! Cache entry used for calculating the aggregate snapshot. */
821 struct stasis_cache_entry;
822
823 /*!
824  * \brief A topic wrapper, which caches certain messages.
825  * \since 12
826  */
827 struct stasis_caching_topic;
828
829
830 /*!
831  * \brief Callback extract a unique identity from a snapshot message.
832  *
833  * This identity is unique to the underlying object of the snapshot, such as the
834  * UniqueId field of a channel.
835  *
836  * \param message Message to extract id from.
837  * \return String representing the snapshot's id.
838  * \return \c NULL if the message_type of the message isn't a handled snapshot.
839  * \since 12
840  */
841 typedef const char *(*snapshot_get_id)(struct stasis_message *message);
842
843 /*!
844  * \brief Callback to calculate the aggregate cache entry.
845  * \since 12.2.0
846  *
847  * \param entry Cache entry to calculate a new aggregate snapshot.
848  * \param new_snapshot The shapshot that is being updated.
849  *
850  * \note Return a ref bumped pointer from stasis_cache_entry_get_aggregate()
851  * if a new aggregate could not be calculated because of error.
852  *
853  * \note An aggregate message is a combined representation of the local
854  * and remote entities publishing the message data.  e.g., An aggregate
855  * device state represents the combined device state from the local and
856  * any remote entities publishing state for a device.  e.g., An aggregate
857  * MWI message is the old/new MWI counts accumulated from the local and
858  * any remote entities publishing to a mailbox.
859  *
860  * \return New aggregate-snapshot calculated on success.
861  * Caller has a reference on return.
862  */
863 typedef struct stasis_message *(*cache_aggregate_calc_fn)(struct stasis_cache_entry *entry, struct stasis_message *new_snapshot);
864
865 /*!
866  * \brief Callback to publish the aggregate cache entry message.
867  * \since 12.2.0
868  *
869  * \details
870  * Once an aggregate message is calculated.  This callback publishes the
871  * message so subscribers will know the new value of an aggregated state.
872  *
873  * \param topic The aggregate message may be published to this topic.
874  *        It is the topic to which the cache itself is subscribed.
875  * \param aggregate The aggregate shapshot message to publish.
876  *
877  * \note It is up to the function to determine if there is a better topic
878  * the aggregate message should be published over.
879  *
880  * \note An aggregate message is a combined representation of the local
881  * and remote entities publishing the message data.  e.g., An aggregate
882  * device state represents the combined device state from the local and
883  * any remote entities publishing state for a device.  e.g., An aggregate
884  * MWI message is the old/new MWI counts accumulated from the local and
885  * any remote entities publishing to a mailbox.
886  *
887  * \return Nothing
888  */
889 typedef void (*cache_aggregate_publish_fn)(struct stasis_topic *topic, struct stasis_message *aggregate);
890
891 /*!
892  * \brief Get the aggregate cache entry snapshot.
893  * \since 12.2.0
894  *
895  * \param entry Cache entry to get the aggregate snapshot.
896  *
897  * \note A reference is not given to the returned pointer so don't unref it.
898  *
899  * \note An aggregate message is a combined representation of the local
900  * and remote entities publishing the message data.  e.g., An aggregate
901  * device state represents the combined device state from the local and
902  * any remote entities publishing state for a device.  e.g., An aggregate
903  * MWI message is the old/new MWI counts accumulated from the local and
904  * any remote entities publishing to a mailbox.
905  *
906  * \retval Aggregate-snapshot in cache.
907  * \retval NULL if not present.
908  */
909 struct stasis_message *stasis_cache_entry_get_aggregate(struct stasis_cache_entry *entry);
910
911 /*!
912  * \brief Get the local entity's cache entry snapshot.
913  * \since 12.2.0
914  *
915  * \param entry Cache entry to get the local entity's snapshot.
916  *
917  * \note A reference is not given to the returned pointer so don't unref it.
918  *
919  * \retval Internal-snapshot in cache.
920  * \retval NULL if not present.
921  */
922 struct stasis_message *stasis_cache_entry_get_local(struct stasis_cache_entry *entry);
923
924 /*!
925  * \brief Get a remote entity's cache entry snapshot by index.
926  * \since 12.2.0
927  *
928  * \param entry Cache entry to get a remote entity's snapshot.
929  * \param idx Which remote entity's snapshot to get.
930  *
931  * \note A reference is not given to the returned pointer so don't unref it.
932  *
933  * \retval Remote-entity-snapshot in cache.
934  * \retval NULL if not present.
935  */
936 struct stasis_message *stasis_cache_entry_get_remote(struct stasis_cache_entry *entry, int idx);
937
938 /*!
939  * \brief Create a cache.
940  *
941  * This is the backend store for a \ref stasis_caching_topic. The cache is
942  * thread safe, allowing concurrent reads and writes.
943  *
944  * The returned object is AO2 managed, so ao2_cleanup() when you're done.
945  *
946  * \param id_fn Callback to extract the id from a snapshot message.
947  *
948  * \retval New cache indexed by \a id_fn.
949  * \retval \c NULL on error
950  *
951  * \since 12
952  */
953 struct stasis_cache *stasis_cache_create(snapshot_get_id id_fn);
954
955 /*!
956  * \brief Create a cache.
957  *
958  * This is the backend store for a \ref stasis_caching_topic. The cache is
959  * thread safe, allowing concurrent reads and writes.
960  *
961  * The returned object is AO2 managed, so ao2_cleanup() when you're done.
962  *
963  * \param id_fn Callback to extract the id from a snapshot message.
964  * \param aggregate_calc_fn Callback to calculate the aggregate cache entry.
965  * \param aggregate_publish_fn Callback to publish the aggregate cache entry.
966  *
967  * \note An aggregate message is a combined representation of the local
968  * and remote entities publishing the message data.  e.g., An aggregate
969  * device state represents the combined device state from the local and
970  * any remote entities publishing state for a device.  e.g., An aggregate
971  * MWI message is the old/new MWI counts accumulated from the local and
972  * any remote entities publishing to a mailbox.
973  *
974  * \retval New cache indexed by \a id_fn.
975  * \retval \c NULL on error
976  *
977  * \since 12.2.0
978  */
979 struct stasis_cache *stasis_cache_create_full(snapshot_get_id id_fn, cache_aggregate_calc_fn aggregate_calc_fn, cache_aggregate_publish_fn aggregate_publish_fn);
980
981 /*!
982  * \brief Create a topic which monitors and caches messages from another topic.
983  *
984  * The idea is that some topics publish 'snapshots' of some other object's state
985  * that should be cached. When these snapshot messages are received, the cache
986  * is updated, and a stasis_cache_update() message is forwarded, which has both
987  * the original snapshot message and the new message.
988  *
989  * The returned object is AO2 managed, so ao2_cleanup() when done with it.
990  *
991  * \param original_topic Topic publishing snapshot messages.
992  * \param cache Backend cache in which to keep snapshots.
993  * \return New topic which changes snapshot messages to stasis_cache_update()
994  *         messages, and forwards all other messages from the original topic.
995  * \return \c NULL on error
996  * \since 12
997  */
998 struct stasis_caching_topic *stasis_caching_topic_create(
999         struct stasis_topic *original_topic, struct stasis_cache *cache);
1000
1001 /*!
1002  * \brief Unsubscribes a caching topic from its upstream topic.
1003  *
1004  * This function returns immediately, so be sure to cleanup when
1005  * stasis_subscription_final_message() is received.
1006  *
1007  * \param caching_topic Caching topic to unsubscribe
1008  * \return \c NULL for convenience
1009  * \since 12
1010  */
1011 struct stasis_caching_topic *stasis_caching_unsubscribe(
1012         struct stasis_caching_topic *caching_topic);
1013
1014 /*!
1015  * \brief Unsubscribes a caching topic from its upstream topic, blocking until
1016  * all messages have been forwarded.
1017  *
1018  * See stasis_unsubscriben_and_join() for more info on when to use this as
1019  * opposed to stasis_caching_unsubscribe().
1020  *
1021  * \param caching_topic Caching topic to unsubscribe
1022  * \return \c NULL for convenience
1023  * \since 12
1024  */
1025 struct stasis_caching_topic *stasis_caching_unsubscribe_and_join(
1026         struct stasis_caching_topic *caching_topic);
1027
1028 /*!
1029  * \brief Returns the topic of cached events from a caching topics.
1030  * \param caching_topic The caching topic.
1031  * \return The topic that publishes cache update events, along with passthrough
1032  *         events from the underlying topic.
1033  * \return \c NULL if \a caching_topic is \c NULL.
1034  * \since 12
1035  */
1036 struct stasis_topic *stasis_caching_get_topic(
1037         struct stasis_caching_topic *caching_topic);
1038
1039 /*!
1040  * \brief A message which instructs the caching topic to remove an entry from
1041  * its cache.
1042  *
1043  * \param message Message representative of the cache entry that should be
1044  *                cleared. This will become the data held in the
1045  *                stasis_cache_clear message.
1046  *
1047  * \return Message which, when sent to a \ref stasis_caching_topic, will clear
1048  *         the item from the cache.
1049  * \return \c NULL on error.
1050  * \since 12
1051  */
1052 struct stasis_message *stasis_cache_clear_create(struct stasis_message *message);
1053
1054 /*!
1055  * \brief Retrieve an item from the cache for the ast_eid_default entity.
1056  *
1057  * The returned item is AO2 managed, so ao2_cleanup() when you're done with it.
1058  *
1059  * \param cache The cache to query.
1060  * \param type Type of message to retrieve.
1061  * \param id Identity of the snapshot to retrieve.
1062  *
1063  * \retval Message from the cache.
1064  * \retval \c NULL if message is not found.
1065  *
1066  * \since 12
1067  */
1068 struct stasis_message *stasis_cache_get(struct stasis_cache *cache, struct stasis_message_type *type, const char *id);
1069
1070 /*!
1071  * \brief Retrieve an item from the cache for a specific entity.
1072  *
1073  * The returned item is AO2 managed, so ao2_cleanup() when you're done with it.
1074  *
1075  * \param cache The cache to query.
1076  * \param type Type of message to retrieve.
1077  * \param id Identity of the snapshot to retrieve.
1078  * \param eid Specific entity id to retrieve.  NULL for aggregate.
1079  *
1080  * \note An aggregate message is a combined representation of the local
1081  * and remote entities publishing the message data.  e.g., An aggregate
1082  * device state represents the combined device state from the local and
1083  * any remote entities publishing state for a device.  e.g., An aggregate
1084  * MWI message is the old/new MWI counts accumulated from the local and
1085  * any remote entities publishing to a mailbox.
1086  *
1087  * \retval Message from the cache.
1088  * \retval \c NULL if message is not found.
1089  *
1090  * \since 12.2.0
1091  */
1092 struct stasis_message *stasis_cache_get_by_eid(struct stasis_cache *cache, struct stasis_message_type *type, const char *id, const struct ast_eid *eid);
1093
1094 /*!
1095  * \brief Retrieve all matching entity items from the cache.
1096  * \since 12.2.0
1097  *
1098  * \param cache The cache to query.
1099  * \param type Type of message to retrieve.
1100  * \param id Identity of the snapshot to retrieve.
1101  *
1102  * \retval Container of matching items found.
1103  * \retval \c NULL if error.
1104  */
1105 struct ao2_container *stasis_cache_get_all(struct stasis_cache *cache, struct stasis_message_type *type, const char *id);
1106
1107 /*!
1108  * \brief Dump cached items to a subscription for the ast_eid_default entity.
1109  *
1110  * \param cache The cache to query.
1111  * \param type Type of message to dump (any type if \c NULL).
1112  *
1113  * \retval ao2_container containing all matches (must be unreffed by caller)
1114  * \retval \c NULL on allocation error
1115  *
1116  * \since 12
1117  */
1118 struct ao2_container *stasis_cache_dump(struct stasis_cache *cache, struct stasis_message_type *type);
1119
1120 /*!
1121  * \brief Dump cached items to a subscription for a specific entity.
1122  * \since 12.2.0
1123  *
1124  * \param cache The cache to query.
1125  * \param type Type of message to dump (any type if \c NULL).
1126  * \param eid Specific entity id to retrieve.  NULL for aggregate.
1127  *
1128  * \retval ao2_container containing all matches (must be unreffed by caller)
1129  * \retval \c NULL on allocation error
1130  */
1131 struct ao2_container *stasis_cache_dump_by_eid(struct stasis_cache *cache, struct stasis_message_type *type, const struct ast_eid *eid);
1132
1133 /*!
1134  * \brief Dump all entity items from the cache to a subscription.
1135  * \since 12.2.0
1136  *
1137  * \param cache The cache to query.
1138  * \param type Type of message to dump (any type if \c NULL).
1139  *
1140  * \retval ao2_container containing all matches (must be unreffed by caller)
1141  * \retval \c NULL on allocation error
1142  */
1143 struct ao2_container *stasis_cache_dump_all(struct stasis_cache *cache, struct stasis_message_type *type);
1144
1145 /*! \addtogroup StasisTopicsAndMessages
1146  * @{
1147  */
1148
1149 /*!
1150  * \brief Object type code for multi user object snapshots
1151  */
1152 enum stasis_user_multi_object_snapshot_type {
1153         STASIS_UMOS_CHANNEL = 0,     /*!< Channel Snapshots */
1154         STASIS_UMOS_BRIDGE,          /*!< Bridge Snapshots */
1155         STASIS_UMOS_ENDPOINT,        /*!< Endpoint Snapshots */
1156 };
1157
1158 /*! \brief Number of snapshot types */
1159 #define STASIS_UMOS_MAX (STASIS_UMOS_ENDPOINT + 1)
1160
1161 /*!
1162  * \brief Message type for custom user defined events with multi object blobs
1163  * \return The stasis_message_type for user event
1164  * \since 12.3.0
1165  */
1166 struct stasis_message_type *ast_multi_user_event_type(void);
1167
1168 /*!
1169  * \brief Create a stasis multi object blob
1170  * \since 12.3.0
1171  *
1172  * \details
1173  * Multi object blob can store a combination of arbitrary json values
1174  * (the blob) and also snapshots of various other system objects (such
1175  * as channels, bridges, etc) for delivery through a stasis message.
1176  * The multi object blob is first created, then optionally objects
1177  * are added to it, before being attached to a message and delivered
1178  * to stasis topic.
1179  *
1180  * \param blob Json blob
1181  *
1182  * \note When used for an ast_multi_user_event_type message, the
1183  * json blob should contain at minimum {eventname: name}.
1184  *
1185  * \retval ast_multi_object_blob* if succeeded
1186  * \retval NULL if creation failed
1187  */
1188 struct ast_multi_object_blob *ast_multi_object_blob_create(struct ast_json *blob);
1189
1190 /*!
1191  * \brief Add an object to a multi object blob previously created
1192  * \since 12.3.0
1193  *
1194  * \param multi The multi object blob previously created
1195  * \param type Type code for the object such as channel, bridge, etc.
1196  * \param object Snapshot object of the type supplied to typename
1197  *
1198  * \return Nothing
1199  */
1200 void ast_multi_object_blob_add(struct ast_multi_object_blob *multi, enum stasis_user_multi_object_snapshot_type type, void *object);
1201
1202 /*!
1203  * \brief Create and publish a stasis message blob on a channel with it's snapshot
1204  * \since 12.3.0
1205  *
1206  * \details
1207  * For compatibility with app_userevent, this creates a multi object
1208  * blob message, attaches the channel snapshot to it, and publishes it
1209  * to the channel's topic.
1210  *
1211  * \param chan The channel to snapshot and publish event to
1212  * \param type The message type
1213  * \param blob A json blob to publish with the snapshot
1214  *
1215  * \return Nothing
1216  */
1217 void ast_multi_object_blob_single_channel_publish(struct ast_channel *chan, struct stasis_message_type *type, struct ast_json *blob);
1218
1219
1220 /*! @} */
1221
1222 /*!
1223  * \internal
1224  * \brief Log a message about invalid attempt to access a type.
1225  */
1226 void stasis_log_bad_type_access(const char *name);
1227
1228 /*!
1229  * \brief Boiler-plate messaging macro for defining public message types.
1230  *
1231  * \code
1232  *      STASIS_MESSAGE_TYPE_DEFN(ast_foo_type,
1233  *              .to_ami = foo_to_ami,
1234  *              .to_json = foo_to_json,
1235  *              .to_event = foo_to_event,
1236  *              );
1237  * \endcode
1238  *
1239  * \param name Name of message type.
1240  * \param ... Virtual table methods for messages of this type.
1241  * \since 12
1242  */
1243 #define STASIS_MESSAGE_TYPE_DEFN(name, ...)                             \
1244         static struct stasis_message_vtable _priv_ ## name ## _v = {    \
1245                 __VA_ARGS__                                             \
1246         };                                                              \
1247         static struct stasis_message_type *_priv_ ## name;              \
1248         struct stasis_message_type *name(void) {                        \
1249                 if (_priv_ ## name == NULL) {                           \
1250                         stasis_log_bad_type_access(#name);              \
1251                 }                                                       \
1252                 return _priv_ ## name;                                  \
1253         }
1254
1255 /*!
1256  * \brief Boiler-plate messaging macro for defining local message types.
1257  *
1258  * \code
1259  *      STASIS_MESSAGE_TYPE_DEFN_LOCAL(ast_foo_type,
1260  *              .to_ami = foo_to_ami,
1261  *              .to_json = foo_to_json,
1262  *              .to_event = foo_to_event,
1263  *              );
1264  * \endcode
1265  *
1266  * \param name Name of message type.
1267  * \param ... Virtual table methods for messages of this type.
1268  * \since 12
1269  */
1270 #define STASIS_MESSAGE_TYPE_DEFN_LOCAL(name, ...)                       \
1271         static struct stasis_message_vtable _priv_ ## name ## _v = {    \
1272                 __VA_ARGS__                                             \
1273         };                                                              \
1274         static struct stasis_message_type *_priv_ ## name;              \
1275         static struct stasis_message_type *name(void) {                 \
1276                 if (_priv_ ## name == NULL) {                           \
1277                         stasis_log_bad_type_access(#name);              \
1278                 }                                                       \
1279                 return _priv_ ## name;                                  \
1280         }
1281
1282 /*!
1283 * \brief Boiler-plate messaging macro for initializing message types.
1284  *
1285  * \code
1286  *      if (STASIS_MESSAGE_TYPE_INIT(ast_foo_type) != 0) {
1287  *              return -1;
1288  *      }
1289  * \endcode
1290  *
1291  * \param name Name of message type.
1292  * \return 0 if initialization is successful.
1293  * \return Non-zero on failure.
1294  * \since 12
1295  */
1296 #define STASIS_MESSAGE_TYPE_INIT(name)                                  \
1297         ({                                                              \
1298                 ast_assert(_priv_ ## name == NULL);                     \
1299                 stasis_message_type_create(#name,       \
1300                         &_priv_ ## name ## _v, &_priv_ ## name) == STASIS_MESSAGE_TYPE_ERROR ? 1 : 0;   \
1301         })
1302
1303 /*!
1304  * \brief Boiler-plate messaging macro for cleaning up message types.
1305  *
1306  * Note that if your type is defined in core instead of a loadable module, you
1307  * should call message type cleanup from an ast_register_cleanup() handler
1308  * instead of an ast_register_atexit() handler.
1309  *
1310  * The reason is that during an immediate shutdown, loadable modules (which may
1311  * refer to core message types) are not unloaded. While the atexit handlers are
1312  * run, there's a window of time where a module subscription might reference a
1313  * core message type after it's been cleaned up. Which is bad.
1314  *
1315  * \param name Name of message type.
1316  * \since 12
1317  */
1318 #define STASIS_MESSAGE_TYPE_CLEANUP(name)       \
1319         ({                                      \
1320                 ao2_cleanup(_priv_ ## name);    \
1321                 _priv_ ## name = NULL;          \
1322         })
1323
1324 /*!
1325  * \brief Initialize the Stasis subsystem.
1326  * \return 0 on success.
1327  * \return Non-zero on error.
1328  * \since 12
1329  */
1330 int stasis_init(void);
1331
1332 /*!
1333  * \internal
1334  * \brief called by stasis_init() for cache initialization.
1335  * \return 0 on success.
1336  * \return Non-zero on error.
1337  * \since 12
1338  */
1339 int stasis_cache_init(void);
1340
1341 /*!
1342  * \internal
1343  * \brief called by stasis_init() for config initialization.
1344  * \return 0 on success.
1345  * \return Non-zero on error.
1346  * \since 12
1347  */
1348 int stasis_config_init(void);
1349
1350 /*!
1351  * \defgroup StasisTopicsAndMessages Stasis topics, and their messages.
1352  *
1353  * \brief This group contains the topics, messages and corresponding message types
1354  * found within Asterisk.
1355  */
1356
1357 #endif /* _ASTERISK_STASIS_H */