4c4052c144f80b1e512578f0384f897ed5891266
[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
178 /*!
179  * \brief Metadata about a \ref stasis_message.
180  * \since 12
181  */
182 struct stasis_message_type;
183
184 /*!
185  * \brief Opaque type for a Stasis message.
186  * \since 12
187  */
188 struct stasis_message;
189
190 /*!
191  * \brief Opaque type for a Stasis subscription.
192  * \since 12
193  */
194 struct stasis_subscription;
195
196 /*!
197  * \brief Structure containing callbacks for Stasis message sanitization
198  *
199  * \note If either callback is implemented, both should be implemented since
200  * not all callers may have access to the full snapshot.
201  */
202 struct stasis_message_sanitizer {
203         /*!
204          * \brief Callback which determines whether a channel should be sanitized from
205          * a message based on the channel's unique ID
206          *
207          * \param channel_id The unique ID of the channel
208          *
209          * \retval non-zero if the channel should be left out of the message
210          * \retval zero if the channel should remain in the message
211          */
212         int (*channel_id)(const char *channel_id);
213
214         /*!
215          * \brief Callback which determines whether a channel should be sanitized from
216          * a message based on the channel's snapshot
217          *
218          * \param snapshot A snapshot generated from the channel
219          *
220          * \retval non-zero if the channel should be left out of the message
221          * \retval zero if the channel should remain in the message
222          */
223         int (*channel_snapshot)(const struct ast_channel_snapshot *snapshot);
224 };
225
226 /*!
227  * \brief Virtual table providing methods for messages.
228  * \since 12
229  */
230 struct stasis_message_vtable {
231         /*!
232          * \brief Build the JSON representation of the message.
233          *
234          * May be \c NULL, or may return \c NULL, to indicate no representation.
235          * The returned object should be ast_json_unref()'ed.
236          *
237          * \param message Message to convert to JSON string.
238          * \param sanitize Snapshot sanitization callback.
239          *
240          * \return Newly allocated JSON message.
241          * \return \c NULL on error.
242          * \return \c NULL if JSON format is not supported.
243          */
244         struct ast_json *(*to_json)(struct stasis_message *message, const struct stasis_message_sanitizer *sanitize);
245
246         /*!
247          * \brief Build the AMI representation of the message.
248          *
249          * May be \c NULL, or may return \c NULL, to indicate no representation.
250          * The returned object should be ao2_cleanup()'ed.
251          *
252          * \param message Message to convert to AMI string.
253          * \return Newly allocated \ref ast_manager_event_blob.
254          * \return \c NULL on error.
255          * \return \c NULL if AMI format is not supported.
256          */
257         struct ast_manager_event_blob *(*to_ami)(
258                 struct stasis_message *message);
259
260         /*!
261          * \since 12.3.0
262          * \brief Build the \ref ast_event representation of the message.
263          *
264          * May be \c NULL, or may return \c NULL, to indicate no representation.
265          * The returned object should be free'd.
266          *
267          * \param message Message to convert to an \ref ast_event.
268          * \return Newly allocated \ref ast_event.
269          * \return \c NULL on error.
270          * \return \c NULL if AMI format is not supported.
271          */
272         struct ast_event *(*to_event)(
273                 struct stasis_message *message);
274 };
275
276 /*!
277  * \brief Create a new message type.
278  *
279  * \ref stasis_message_type is an AO2 object, so ao2_cleanup() when you're done
280  * with it.
281  *
282  * \param name Name of the new type.
283  * \param vtable Virtual table of message methods. May be \c NULL.
284  * \return Pointer to the new type.
285  * \return \c NULL on error.
286  * \since 12
287  */
288 struct stasis_message_type *stasis_message_type_create(const char *name,
289         struct stasis_message_vtable *vtable);
290
291 /*!
292  * \brief Gets the name of a given message type
293  * \param type The type to get.
294  * \return Name of the type.
295  * \return \c NULL if \a type is \c NULL.
296  * \since 12
297  */
298 const char *stasis_message_type_name(const struct stasis_message_type *type);
299
300 /*!
301  * \brief Create a new message.
302  *
303  * This message is an \c ao2 object, and must be ao2_cleanup()'ed when you are done
304  * with it. Messages are also immutable, and must not be modified after they
305  * are initialized. Especially the \a data in the message.
306  *
307  * \param type Type of the message
308  * \param data Immutable data that is the actual contents of the message
309  *
310  * \return New message
311  * \return \c NULL on error
312  *
313  * \since 12
314  */
315 struct stasis_message *stasis_message_create(struct stasis_message_type *type, void *data);
316
317 /*!
318  * \brief Create a new message for an entity.
319  *
320  * This message is an \c ao2 object, and must be ao2_cleanup()'ed when you are done
321  * with it. Messages are also immutable, and must not be modified after they
322  * are initialized. Especially the \a data in the message.
323  *
324  * \param type Type of the message
325  * \param data Immutable data that is the actual contents of the message
326  * \param eid What entity originated this message. (NULL for aggregate)
327  *
328  * \note An aggregate message is a combined representation of the local
329  * and remote entities publishing the message data.  e.g., An aggregate
330  * device state represents the combined device state from the local and
331  * any remote entities publishing state for a device.  e.g., An aggregate
332  * MWI message is the old/new MWI counts accumulated from the local and
333  * any remote entities publishing to a mailbox.
334  *
335  * \retval New message
336  * \retval \c NULL on error
337  *
338  * \since 12.2.0
339  */
340 struct stasis_message *stasis_message_create_full(struct stasis_message_type *type, void *data, const struct ast_eid *eid);
341
342 /*!
343  * \brief Get the entity id for a \ref stasis_message.
344  * \since 12.2.0
345  *
346  * \param msg Message to get eid.
347  *
348  * \retval Entity id of \a msg
349  * \retval \c NULL if \a msg is an aggregate or \a msg is \c NULL.
350  */
351 const struct ast_eid *stasis_message_eid(const struct stasis_message *msg);
352
353 /*!
354  * \brief Get the message type for a \ref stasis_message.
355  * \param msg Message to type
356  * \return Type of \a msg
357  * \return \c NULL if \a msg is \c NULL.
358  * \since 12
359  */
360 struct stasis_message_type *stasis_message_type(const struct stasis_message *msg);
361
362 /*!
363  * \brief Get the data contained in a message.
364  * \param msg Message.
365  * \return Immutable data pointer
366  * \return \c NULL if msg is \c NULL.
367  * \since 12
368  */
369 void *stasis_message_data(const struct stasis_message *msg);
370
371 /*!
372  * \brief Get the time when a message was created.
373  * \param msg Message.
374  * \return Pointer to the \a timeval when the message was created.
375  * \return \c NULL if msg is \c NULL.
376  * \since 12
377  */
378 const struct timeval *stasis_message_timestamp(const struct stasis_message *msg);
379
380 /*!
381  * \brief Build the JSON representation of the message.
382  *
383  * May return \c NULL, to indicate no representation. The returned object should
384  * be ast_json_unref()'ed.
385  *
386  * \param message Message to convert to JSON string.
387  * \param sanitize Snapshot sanitization callback.
388  *
389  * \return Newly allocated string with JSON message.
390  * \return \c NULL on error.
391  * \return \c NULL if JSON format is not supported.
392  */
393 struct ast_json *stasis_message_to_json(struct stasis_message *message, struct stasis_message_sanitizer *sanitize);
394
395 /*!
396  * \brief Build the AMI representation of the message.
397  *
398  * May return \c NULL, to indicate no representation. The returned object should
399  * be ao2_cleanup()'ed.
400  *
401  * \param message Message to convert to AMI.
402  * \return \c NULL on error.
403  * \return \c NULL if AMI format is not supported.
404  */
405 struct ast_manager_event_blob *stasis_message_to_ami(
406         struct stasis_message *message);
407
408 /*!
409  * \brief Build the \ref AstGenericEvents representation of the message.
410  *
411  * May return \c NULL, to indicate no representation. The returned object should
412  * be disposed of via \ref ast_event_destroy.
413  *
414  * \param message Message to convert to AMI.
415  * \return \c NULL on error.
416  * \return \c NULL if AMI format is not supported.
417  */
418 struct ast_event *stasis_message_to_event(
419         struct stasis_message *message);
420
421 /*! @} */
422
423 /*! @{ */
424
425 /*!
426  * \brief A topic to which messages may be posted, and subscribers, well, subscribe
427  * \since 12
428  */
429 struct stasis_topic;
430
431 /*!
432  * \brief Create a new topic.
433  * \param name Name of the new topic.
434  * \return New topic instance.
435  * \return \c NULL on error.
436  * \since 12
437  */
438 struct stasis_topic *stasis_topic_create(const char *name);
439
440 /*!
441  * \brief Return the name of a topic.
442  * \param topic Topic.
443  * \return Name of the topic.
444  * \return \c NULL if topic is \c NULL.
445  * \since 12
446  */
447 const char *stasis_topic_name(const struct stasis_topic *topic);
448
449 /*!
450  * \brief Publish a message to a topic's subscribers.
451  * \param topic Topic.
452  * \param message Message to publish.
453  *
454  * This call is asynchronous and will return immediately upon queueing
455  * the message for delivery to the topic's subscribers.
456  *
457  * \since 12
458  */
459 void stasis_publish(struct stasis_topic *topic, struct stasis_message *message);
460
461 /*!
462  * \brief Publish a message to a topic's subscribers, synchronizing
463  * on the specified subscriber
464  * \param sub Subscription to synchronize on.
465  * \param message Message to publish.
466  *
467  * The caller of stasis_publish_sync will block until the specified
468  * subscriber completes handling of the message.
469  *
470  * All other subscribers to the topic the \ref stasis_subpscription
471  * is subscribed to are also delivered the message; this delivery however
472  * happens asynchronously.
473  *
474  * \since 12.1.0
475  */
476 void stasis_publish_sync(struct stasis_subscription *sub, struct stasis_message *message);
477
478 /*! @} */
479
480 /*! @{ */
481
482 /*!
483  * \brief Callback function type for Stasis subscriptions.
484  * \param data Data field provided with subscription.
485  * \param message Published message.
486  * \since 12
487  */
488 typedef void (*stasis_subscription_cb)(void *data, struct stasis_subscription *sub, struct stasis_message *message);
489
490 /*!
491  * \brief Create a subscription.
492  *
493  * In addition to being AO2 managed memory (requiring an ao2_cleanup() to free
494  * up this reference), the subscription must be explicitly unsubscribed from its
495  * topic using stasis_unsubscribe().
496  *
497  * The invocations of the callback are serialized, but may not always occur on
498  * the same thread. The invocation order of different subscriptions is
499  * unspecified.
500  *
501  * \param topic Topic to subscribe to.
502  * \param callback Callback function for subscription messages.
503  * \param data Data to be passed to the callback, in addition to the message.
504  * \return New \ref stasis_subscription object.
505  * \return \c NULL on error.
506  * \since 12
507  */
508 struct stasis_subscription *stasis_subscribe(struct stasis_topic *topic,
509         stasis_subscription_cb callback, void *data);
510
511 /*!
512  * \brief Cancel a subscription.
513  *
514  * Note that in an asynchronous system, there may still be messages queued or
515  * in transit to the subscription's callback. These will still be delivered.
516  * There will be a final 'SubscriptionCancelled' message, indicating the
517  * delivery of the final message.
518  *
519  * \param subscription Subscription to cancel.
520  * \return \c NULL for convenience
521  * \since 12
522  */
523 struct stasis_subscription *stasis_unsubscribe(
524         struct stasis_subscription *subscription);
525
526 /*!
527  * \brief Block until the last message is processed on a subscription.
528  *
529  * This function will not return until the \a subscription's callback for the
530  * stasis_subscription_final_message() completes. This allows cleanup routines
531  * to run before unblocking the joining thread.
532  *
533  * \param subscription Subscription to block on.
534  * \since 12
535  */
536 void stasis_subscription_join(struct stasis_subscription *subscription);
537
538 /*!
539  * \brief Returns whether \a subscription has received its final message.
540  *
541  * Note that a subscription is considered done even while the
542  * stasis_subscription_final_message() is being processed. This allows cleanup
543  * routines to check the status of the subscription.
544  *
545  * \param subscription Subscription.
546  * \return True (non-zero) if stasis_subscription_final_message() has been
547  *         received.
548  * \return False (zero) if waiting for the end.
549  */
550 int stasis_subscription_is_done(struct stasis_subscription *subscription);
551
552 /*!
553  * \brief Cancel a subscription, blocking until the last message is processed.
554  *
555  * While normally it's recommended to stasis_unsubscribe() and wait for
556  * stasis_subscription_final_message(), there are times (like during a module
557  * unload) where you have to wait for the final message (otherwise you'll call
558  * a function in a shared module that no longer exists).
559  *
560  * \param subscription Subscription to cancel.
561  * \return \c NULL for convenience
562  * \since 12
563  */
564 struct stasis_subscription *stasis_unsubscribe_and_join(
565         struct stasis_subscription *subscription);
566
567 struct stasis_forward;
568
569 /*!
570  * \brief Create a subscription which forwards all messages from one topic to
571  * another.
572  *
573  * Note that the \a topic parameter of the invoked callback will the be the
574  * \a topic the message was sent to, not the topic the subscriber subscribed to.
575  *
576  * \param from_topic Topic to forward.
577  * \param to_topic Destination topic of forwarded messages.
578  * \return New forwarding subscription.
579  * \return \c NULL on error.
580  * \since 12
581  */
582 struct stasis_forward *stasis_forward_all(struct stasis_topic *from_topic,
583         struct stasis_topic *to_topic);
584
585 struct stasis_forward *stasis_forward_cancel(struct stasis_forward *forward);
586
587 /*!
588  * \brief Get the unique ID for the subscription.
589  *
590  * \param sub Subscription for which to get the unique ID.
591  * \return Unique ID for the subscription.
592  * \since 12
593  */
594 const char *stasis_subscription_uniqueid(const struct stasis_subscription *sub);
595
596 /*!
597  * \brief Returns whether a subscription is currently subscribed.
598  *
599  * Note that there may still be messages queued up to be dispatched to this
600  * subscription, but the stasis_subscription_final_message() has been enqueued.
601  *
602  * \param sub Subscription to check
603  * \return False (zero) if subscription is not subscribed.
604  * \return True (non-zero) if still subscribed.
605  */
606 int stasis_subscription_is_subscribed(const struct stasis_subscription *sub);
607
608 /*!
609  * \brief Determine whether a message is the final message to be received on a subscription.
610  *
611  * \param sub Subscription on which the message was received.
612  * \param msg Message to check.
613  * \return zero if the provided message is not the final message.
614  * \return non-zero if the provided message is the final message.
615  * \since 12
616  */
617 int stasis_subscription_final_message(struct stasis_subscription *sub, struct stasis_message *msg);
618
619 /*! \addtogroup StasisTopicsAndMessages
620  * @{
621  */
622
623 /*!
624  * \brief Holds details about changes to subscriptions for the specified topic
625  * \since 12
626  */
627 struct stasis_subscription_change {
628         AST_DECLARE_STRING_FIELDS(
629                 AST_STRING_FIELD(uniqueid);     /*!< The unique ID associated with this subscription */
630                 AST_STRING_FIELD(description);  /*!< The description of the change to the subscription associated with the uniqueid */
631         );
632         struct stasis_topic *topic;             /*!< The topic the subscription is/was subscribing to */
633 };
634
635 /*!
636  * \brief Gets the message type for subscription change notices
637  * \return The stasis_message_type for subscription change notices
638  * \since 12
639  */
640 struct stasis_message_type *stasis_subscription_change_type(void);
641
642 /*! @} */
643
644 /*! @{ */
645
646 /*!
647  * \brief Pool for topic aggregation
648  */
649 struct stasis_topic_pool;
650
651 /*!
652  * \brief Create a topic pool that routes messages from dynamically generated topics to the given topic
653  * \param pooled_topic Topic to which messages will be routed
654  * \return the new stasis_topic_pool
655  * \return \c NULL on failure
656  */
657 struct stasis_topic_pool *stasis_topic_pool_create(struct stasis_topic *pooled_topic);
658
659 /*!
660  * \brief Find or create a topic in the pool
661  * \param pool Pool for which to get the topic
662  * \param topic_name Name of the topic to get
663  * \return The already stored or newly allocated topic
664  * \return \c NULL if the topic was not found and could not be allocated
665  */
666 struct stasis_topic *stasis_topic_pool_get_topic(struct stasis_topic_pool *pool, const char *topic_name);
667
668 /*! @} */
669
670 /*! \addtogroup StasisTopicsAndMessages
671  * @{
672  */
673
674 /*!
675  * \brief Message type for cache update messages.
676  * \return Message type for cache update messages.
677  * \since 12
678  */
679 struct stasis_message_type *stasis_cache_update_type(void);
680
681 /*!
682  * \brief Cache update message
683  * \since 12
684  */
685 struct stasis_cache_update {
686         /*! \brief Convenience reference to snapshot type */
687         struct stasis_message_type *type;
688         /*! \brief Old value from the cache */
689         struct stasis_message *old_snapshot;
690         /*! \brief New value */
691         struct stasis_message *new_snapshot;
692 };
693
694 /*!
695  * \brief Message type for clearing a message from a stasis cache.
696  * \since 12
697  */
698 struct stasis_message_type *stasis_cache_clear_type(void);
699
700 /*! @} */
701
702 /*! @{ */
703
704 /*!
705  * \brief A message cache, for use with \ref stasis_caching_topic.
706  * \since 12
707  */
708 struct stasis_cache;
709
710 /*! Cache entry used for calculating the aggregate snapshot. */
711 struct stasis_cache_entry;
712
713 /*!
714  * \brief A topic wrapper, which caches certain messages.
715  * \since 12
716  */
717 struct stasis_caching_topic;
718
719
720 /*!
721  * \brief Callback extract a unique identity from a snapshot message.
722  *
723  * This identity is unique to the underlying object of the snapshot, such as the
724  * UniqueId field of a channel.
725  *
726  * \param message Message to extract id from.
727  * \return String representing the snapshot's id.
728  * \return \c NULL if the message_type of the message isn't a handled snapshot.
729  * \since 12
730  */
731 typedef const char *(*snapshot_get_id)(struct stasis_message *message);
732
733 /*!
734  * \brief Callback to calculate the aggregate cache entry.
735  * \since 12.2.0
736  *
737  * \param entry Cache entry to calculate a new aggregate snapshot.
738  * \param new_snapshot The shapshot that is being updated.
739  *
740  * \note Return a ref bumped pointer from stasis_cache_entry_get_aggregate()
741  * if a new aggregate could not be calculated because of error.
742  *
743  * \note An aggregate message is a combined representation of the local
744  * and remote entities publishing the message data.  e.g., An aggregate
745  * device state represents the combined device state from the local and
746  * any remote entities publishing state for a device.  e.g., An aggregate
747  * MWI message is the old/new MWI counts accumulated from the local and
748  * any remote entities publishing to a mailbox.
749  *
750  * \return New aggregate-snapshot calculated on success.
751  * Caller has a reference on return.
752  */
753 typedef struct stasis_message *(*cache_aggregate_calc_fn)(struct stasis_cache_entry *entry, struct stasis_message *new_snapshot);
754
755 /*!
756  * \brief Callback to publish the aggregate cache entry message.
757  * \since 12.2.0
758  *
759  * \details
760  * Once an aggregate message is calculated.  This callback publishes the
761  * message so subscribers will know the new value of an aggregated state.
762  *
763  * \param topic The aggregate message may be published to this topic.
764  *        It is the topic to which the cache itself is subscribed.
765  * \param aggregate The aggregate shapshot message to publish.
766  *
767  * \note It is up to the function to determine if there is a better topic
768  * the aggregate message should be published over.
769  *
770  * \note An aggregate message is a combined representation of the local
771  * and remote entities publishing the message data.  e.g., An aggregate
772  * device state represents the combined device state from the local and
773  * any remote entities publishing state for a device.  e.g., An aggregate
774  * MWI message is the old/new MWI counts accumulated from the local and
775  * any remote entities publishing to a mailbox.
776  *
777  * \return Nothing
778  */
779 typedef void (*cache_aggregate_publish_fn)(struct stasis_topic *topic, struct stasis_message *aggregate);
780
781 /*!
782  * \brief Get the aggregate cache entry snapshot.
783  * \since 12.2.0
784  *
785  * \param entry Cache entry to get the aggregate snapshot.
786  *
787  * \note A reference is not given to the returned pointer so don't unref it.
788  *
789  * \note An aggregate message is a combined representation of the local
790  * and remote entities publishing the message data.  e.g., An aggregate
791  * device state represents the combined device state from the local and
792  * any remote entities publishing state for a device.  e.g., An aggregate
793  * MWI message is the old/new MWI counts accumulated from the local and
794  * any remote entities publishing to a mailbox.
795  *
796  * \retval Aggregate-snapshot in cache.
797  * \retval NULL if not present.
798  */
799 struct stasis_message *stasis_cache_entry_get_aggregate(struct stasis_cache_entry *entry);
800
801 /*!
802  * \brief Get the local entity's cache entry snapshot.
803  * \since 12.2.0
804  *
805  * \param entry Cache entry to get the local entity's snapshot.
806  *
807  * \note A reference is not given to the returned pointer so don't unref it.
808  *
809  * \retval Internal-snapshot in cache.
810  * \retval NULL if not present.
811  */
812 struct stasis_message *stasis_cache_entry_get_local(struct stasis_cache_entry *entry);
813
814 /*!
815  * \brief Get a remote entity's cache entry snapshot by index.
816  * \since 12.2.0
817  *
818  * \param entry Cache entry to get a remote entity's snapshot.
819  * \param idx Which remote entity's snapshot to get.
820  *
821  * \note A reference is not given to the returned pointer so don't unref it.
822  *
823  * \retval Remote-entity-snapshot in cache.
824  * \retval NULL if not present.
825  */
826 struct stasis_message *stasis_cache_entry_get_remote(struct stasis_cache_entry *entry, int idx);
827
828 /*!
829  * \brief Create a cache.
830  *
831  * This is the backend store for a \ref stasis_caching_topic. The cache is
832  * thread safe, allowing concurrent reads and writes.
833  *
834  * The returned object is AO2 managed, so ao2_cleanup() when you're done.
835  *
836  * \param id_fn Callback to extract the id from a snapshot message.
837  *
838  * \retval New cache indexed by \a id_fn.
839  * \retval \c NULL on error
840  *
841  * \since 12
842  */
843 struct stasis_cache *stasis_cache_create(snapshot_get_id id_fn);
844
845 /*!
846  * \brief Create a cache.
847  *
848  * This is the backend store for a \ref stasis_caching_topic. The cache is
849  * thread safe, allowing concurrent reads and writes.
850  *
851  * The returned object is AO2 managed, so ao2_cleanup() when you're done.
852  *
853  * \param id_fn Callback to extract the id from a snapshot message.
854  * \param aggregate_calc_fn Callback to calculate the aggregate cache entry.
855  * \param aggregate_publish_fn Callback to publish the aggregate cache entry.
856  *
857  * \note An aggregate message is a combined representation of the local
858  * and remote entities publishing the message data.  e.g., An aggregate
859  * device state represents the combined device state from the local and
860  * any remote entities publishing state for a device.  e.g., An aggregate
861  * MWI message is the old/new MWI counts accumulated from the local and
862  * any remote entities publishing to a mailbox.
863  *
864  * \retval New cache indexed by \a id_fn.
865  * \retval \c NULL on error
866  *
867  * \since 12.2.0
868  */
869 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);
870
871 /*!
872  * \brief Create a topic which monitors and caches messages from another topic.
873  *
874  * The idea is that some topics publish 'snapshots' of some other object's state
875  * that should be cached. When these snapshot messages are received, the cache
876  * is updated, and a stasis_cache_update() message is forwarded, which has both
877  * the original snapshot message and the new message.
878  *
879  * The returned object is AO2 managed, so ao2_cleanup() when done with it.
880  *
881  * \param original_topic Topic publishing snapshot messages.
882  * \param cache Backend cache in which to keep snapshots.
883  * \return New topic which changes snapshot messages to stasis_cache_update()
884  *         messages, and forwards all other messages from the original topic.
885  * \return \c NULL on error
886  * \since 12
887  */
888 struct stasis_caching_topic *stasis_caching_topic_create(
889         struct stasis_topic *original_topic, struct stasis_cache *cache);
890
891 /*!
892  * \brief Unsubscribes a caching topic from its upstream topic.
893  *
894  * This function returns immediately, so be sure to cleanup when
895  * stasis_subscription_final_message() is received.
896  *
897  * \param caching_topic Caching topic to unsubscribe
898  * \return \c NULL for convenience
899  * \since 12
900  */
901 struct stasis_caching_topic *stasis_caching_unsubscribe(
902         struct stasis_caching_topic *caching_topic);
903
904 /*!
905  * \brief Unsubscribes a caching topic from its upstream topic, blocking until
906  * all messages have been forwarded.
907  *
908  * See stasis_unsubscriben_and_join() for more info on when to use this as
909  * opposed to stasis_caching_unsubscribe().
910  *
911  * \param caching_topic Caching topic to unsubscribe
912  * \return \c NULL for convenience
913  * \since 12
914  */
915 struct stasis_caching_topic *stasis_caching_unsubscribe_and_join(
916         struct stasis_caching_topic *caching_topic);
917
918 /*!
919  * \brief Returns the topic of cached events from a caching topics.
920  * \param caching_topic The caching topic.
921  * \return The topic that publishes cache update events, along with passthrough
922  *         events from the underlying topic.
923  * \return \c NULL if \a caching_topic is \c NULL.
924  * \since 12
925  */
926 struct stasis_topic *stasis_caching_get_topic(
927         struct stasis_caching_topic *caching_topic);
928
929 /*!
930  * \brief A message which instructs the caching topic to remove an entry from
931  * its cache.
932  *
933  * \param message Message representative of the cache entry that should be
934  *                cleared. This will become the data held in the
935  *                stasis_cache_clear message.
936  *
937  * \return Message which, when sent to a \ref stasis_caching_topic, will clear
938  *         the item from the cache.
939  * \return \c NULL on error.
940  * \since 12
941  */
942 struct stasis_message *stasis_cache_clear_create(struct stasis_message *message);
943
944 /*!
945  * \brief Retrieve an item from the cache for the ast_eid_default entity.
946  *
947  * The returned item is AO2 managed, so ao2_cleanup() when you're done with it.
948  *
949  * \param cache The cache to query.
950  * \param type Type of message to retrieve.
951  * \param id Identity of the snapshot to retrieve.
952  *
953  * \retval Message from the cache.
954  * \retval \c NULL if message is not found.
955  *
956  * \since 12
957  */
958 struct stasis_message *stasis_cache_get(struct stasis_cache *cache, struct stasis_message_type *type, const char *id);
959
960 /*!
961  * \brief Retrieve an item from the cache for a specific entity.
962  *
963  * The returned item is AO2 managed, so ao2_cleanup() when you're done with it.
964  *
965  * \param cache The cache to query.
966  * \param type Type of message to retrieve.
967  * \param id Identity of the snapshot to retrieve.
968  * \param eid Specific entity id to retrieve.  NULL for aggregate.
969  *
970  * \note An aggregate message is a combined representation of the local
971  * and remote entities publishing the message data.  e.g., An aggregate
972  * device state represents the combined device state from the local and
973  * any remote entities publishing state for a device.  e.g., An aggregate
974  * MWI message is the old/new MWI counts accumulated from the local and
975  * any remote entities publishing to a mailbox.
976  *
977  * \retval Message from the cache.
978  * \retval \c NULL if message is not found.
979  *
980  * \since 12.2.0
981  */
982 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);
983
984 /*!
985  * \brief Retrieve all matching entity items from the cache.
986  * \since 12.2.0
987  *
988  * \param cache The cache to query.
989  * \param type Type of message to retrieve.
990  * \param id Identity of the snapshot to retrieve.
991  *
992  * \retval Container of matching items found.
993  * \retval \c NULL if error.
994  */
995 struct ao2_container *stasis_cache_get_all(struct stasis_cache *cache, struct stasis_message_type *type, const char *id);
996
997 /*!
998  * \brief Dump cached items to a subscription for the ast_eid_default entity.
999  *
1000  * \param cache The cache to query.
1001  * \param type Type of message to dump (any type if \c NULL).
1002  *
1003  * \retval ao2_container containing all matches (must be unreffed by caller)
1004  * \retval \c NULL on allocation error
1005  *
1006  * \since 12
1007  */
1008 struct ao2_container *stasis_cache_dump(struct stasis_cache *cache, struct stasis_message_type *type);
1009
1010 /*!
1011  * \brief Dump cached items to a subscription for a specific entity.
1012  * \since 12.2.0
1013  *
1014  * \param cache The cache to query.
1015  * \param type Type of message to dump (any type if \c NULL).
1016  * \param eid Specific entity id to retrieve.  NULL for aggregate.
1017  *
1018  * \retval ao2_container containing all matches (must be unreffed by caller)
1019  * \retval \c NULL on allocation error
1020  */
1021 struct ao2_container *stasis_cache_dump_by_eid(struct stasis_cache *cache, struct stasis_message_type *type, const struct ast_eid *eid);
1022
1023 /*!
1024  * \brief Dump all entity items from the cache to a subscription.
1025  * \since 12.2.0
1026  *
1027  * \param cache The cache to query.
1028  * \param type Type of message to dump (any type if \c NULL).
1029  *
1030  * \retval ao2_container containing all matches (must be unreffed by caller)
1031  * \retval \c NULL on allocation error
1032  */
1033 struct ao2_container *stasis_cache_dump_all(struct stasis_cache *cache, struct stasis_message_type *type);
1034
1035 /*!
1036  * \brief Object type code for multi user object snapshots
1037  */
1038 enum stasis_user_multi_object_snapshot_type {
1039         STASIS_UMOS_CHANNEL = 0,     /*!< Channel Snapshots */
1040         STASIS_UMOS_BRIDGE,          /*!< Bridge Snapshots */
1041         STASIS_UMOS_ENDPOINT,        /*!< Endpoint Snapshots */
1042 };
1043
1044 /*! \brief Number of snapshot types */
1045 #define STASIS_UMOS_MAX (STASIS_UMOS_ENDPOINT + 1)
1046
1047 /*!
1048  * \brief Message type for custom user defined events with multi object blobs
1049  * \return The stasis_message_type for user event
1050  * \since 12.3.0
1051  */
1052 struct stasis_message_type *ast_multi_user_event_type(void);
1053
1054 /*!
1055  * \brief Create a stasis multi object blob
1056  * \since 12.3.0
1057  *
1058  * \details
1059  * Multi object blob can store a combination of arbitrary json values
1060  * (the blob) and also snapshots of various other system objects (such
1061  * as channels, bridges, etc) for delivery through a stasis message.
1062  * The multi object blob is first created, then optionally objects
1063  * are added to it, before being attached to a message and delivered
1064  * to stasis topic.
1065  *
1066  * \param blob Json blob
1067  *
1068  * \note When used for an ast_multi_user_event_type message, the
1069  * json blob should contain at minimum {eventname: name}.
1070  *
1071  * \retval ast_multi_object_blob* if succeeded
1072  * \retval NULL if creation failed
1073  */
1074 struct ast_multi_object_blob *ast_multi_object_blob_create(struct ast_json *blob);
1075
1076 /*!
1077  * \brief Add an object to a multi object blob previously created
1078  * \since 12.3.0
1079  *
1080  * \param multi The multi object blob previously created
1081  * \param type Type code for the object such as channel, bridge, etc.
1082  * \param object Snapshot object of the type supplied to typename
1083  *
1084  * \return Nothing
1085  */
1086 void ast_multi_object_blob_add(struct ast_multi_object_blob *multi, enum stasis_user_multi_object_snapshot_type type, void *object);
1087
1088 /*!
1089  * \brief Create and publish a stasis message blob on a channel with it's snapshot
1090  * \since 12.3.0
1091  *
1092  * \details
1093  * For compatibility with app_userevent, this creates a multi object
1094  * blob message, attaches the channel snapshot to it, and publishes it
1095  * to the channel's topic.
1096  *
1097  * \param chan The channel to snapshot and publish event to
1098  * \param type The message type
1099  * \param blob A json blob to publish with the snapshot
1100  *
1101  * \return Nothing
1102  */
1103 void ast_multi_object_blob_single_channel_publish(struct ast_channel *chan, struct stasis_message_type *type, struct ast_json *blob);
1104
1105
1106 /*! @} */
1107
1108 /*! @{ */
1109
1110 /*!
1111  * \internal
1112  * \brief Log a message about invalid attempt to access a type.
1113  */
1114 void stasis_log_bad_type_access(const char *name);
1115
1116 /*!
1117  * \brief Boiler-plate messaging macro for defining public message types.
1118  *
1119  * \code
1120  *      STASIS_MESSAGE_TYPE_DEFN(ast_foo_type,
1121  *              .to_ami = foo_to_ami,
1122  *              .to_json = foo_to_json,
1123  *              .to_event = foo_to_event,
1124  *              );
1125  * \endcode
1126  *
1127  * \param name Name of message type.
1128  * \param ... Virtual table methods for messages of this type.
1129  * \since 12
1130  */
1131 #define STASIS_MESSAGE_TYPE_DEFN(name, ...)                             \
1132         static struct stasis_message_vtable _priv_ ## name ## _v = {    \
1133                 __VA_ARGS__                                             \
1134         };                                                              \
1135         static struct stasis_message_type *_priv_ ## name;              \
1136         struct stasis_message_type *name(void) {                        \
1137                 if (_priv_ ## name == NULL) {                           \
1138                         stasis_log_bad_type_access(#name);              \
1139                 }                                                       \
1140                 return _priv_ ## name;                                  \
1141         }
1142
1143 /*!
1144  * \brief Boiler-plate messaging macro for defining local message types.
1145  *
1146  * \code
1147  *      STASIS_MESSAGE_TYPE_DEFN_LOCAL(ast_foo_type,
1148  *              .to_ami = foo_to_ami,
1149  *              .to_json = foo_to_json,
1150  *              .to_event = foo_to_event,
1151  *              );
1152  * \endcode
1153  *
1154  * \param name Name of message type.
1155  * \param ... Virtual table methods for messages of this type.
1156  * \since 12
1157  */
1158 #define STASIS_MESSAGE_TYPE_DEFN_LOCAL(name, ...)                       \
1159         static struct stasis_message_vtable _priv_ ## name ## _v = {    \
1160                 __VA_ARGS__                                             \
1161         };                                                              \
1162         static struct stasis_message_type *_priv_ ## name;              \
1163         static struct stasis_message_type *name(void) {                 \
1164                 if (_priv_ ## name == NULL) {                           \
1165                         stasis_log_bad_type_access(#name);              \
1166                 }                                                       \
1167                 return _priv_ ## name;                                  \
1168         }
1169
1170 /*!
1171 * \brief Boiler-plate messaging macro for initializing message types.
1172  *
1173  * \code
1174  *      if (STASIS_MESSAGE_TYPE_INIT(ast_foo_type) != 0) {
1175  *              return -1;
1176  *      }
1177  * \endcode
1178  *
1179  * \param name Name of message type.
1180  * \return 0 if initialization is successful.
1181  * \return Non-zero on failure.
1182  * \since 12
1183  */
1184 #define STASIS_MESSAGE_TYPE_INIT(name)                                  \
1185         ({                                                              \
1186                 ast_assert(_priv_ ## name == NULL);                     \
1187                 _priv_ ## name = stasis_message_type_create(#name,      \
1188                         &_priv_ ## name ## _v);                         \
1189                 _priv_ ## name ? 0 : -1;                                \
1190         })
1191
1192 /*!
1193  * \brief Boiler-plate messaging macro for cleaning up message types.
1194  *
1195  * Note that if your type is defined in core instead of a loadable module, you
1196  * should call message type cleanup from an ast_register_cleanup() handler
1197  * instead of an ast_register_atexit() handler.
1198  *
1199  * The reason is that during an immediate shutdown, loadable modules (which may
1200  * refer to core message types) are not unloaded. While the atexit handlers are
1201  * run, there's a window of time where a module subscription might reference a
1202  * core message type after it's been cleaned up. Which is bad.
1203  *
1204  * \param name Name of message type.
1205  * \since 12
1206  */
1207 #define STASIS_MESSAGE_TYPE_CLEANUP(name)       \
1208         ({                                      \
1209                 ao2_cleanup(_priv_ ## name);    \
1210                 _priv_ ## name = NULL;          \
1211         })
1212
1213 /*! @} */
1214
1215 /*! @{ */
1216
1217 /*!
1218  * \brief Initialize the Stasis subsystem.
1219  * \return 0 on success.
1220  * \return Non-zero on error.
1221  * \since 12
1222  */
1223 int stasis_init(void);
1224
1225 /*! @} */
1226
1227 /*! @{ */
1228
1229 /*!
1230  * \internal
1231  * \brief called by stasis_init() for cache initialization.
1232  * \return 0 on success.
1233  * \return Non-zero on error.
1234  * \since 12
1235  */
1236 int stasis_cache_init(void);
1237
1238 /*!
1239  * \internal
1240  * \brief called by stasis_init() for config initialization.
1241  * \return 0 on success.
1242  * \return Non-zero on error.
1243  * \since 12
1244  */
1245 int stasis_config_init(void);
1246
1247 /*! @} */
1248
1249 /*!
1250  * \defgroup StasisTopicsAndMessages Stasis topics, and their messages.
1251  *
1252  * This group contains the topics, messages and corresponding message types
1253  * found within Asterisk.
1254  */
1255
1256 #endif /* _ASTERISK_STASIS_H */