Add message dump capability to stasis cache layer
[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  *  - Consistent memory management; all message bus objects are AO2 managed
39  *    objects, using ao2_ref() and ao2_cleanup() to manage the reference
40  *    counting.
41  *
42  * There are three main concepts for using the Stasis Message Bus:
43  *  - \ref stasis_message
44  *  - \ref stasis_topic
45  *  - \ref stasis_subscription
46  *
47  * \par stasis_message
48  *
49  * Central to the Stasis Message Bus is the \ref stasis_message, the messages
50  * that are sent on the bus. These messages have:
51  *  - a type (as defined by a \ref stasis_message_type)
52  *  - a value - a \c void pointer to an AO2 object
53  *  - a timestamp when it was created
54  *
55  * Once a \ref stasis_message has been created, it is immutable and cannot
56  * change. The same goes for the value of the message (although this cannot be
57  * enforced in code). Messages themselves are reference-counted, AO2 objects,
58  * along with their values. By being both reference counted and immutable,
59  * messages can be shared throughout the system without any concerns for
60  * threading. (Well, the objects must be allocated with \ref
61  * AO2_ALLOC_OPT_LOCK_MUTEX so that the reference counting operations are thread
62  * safe. But other than that, no worries).
63  *
64  * The type of a message is defined by an instance of \ref stasis_message_type,
65  * which can be created by calling stasis_message_type_create(). Message types
66  * are named, which is useful in debugging. It is recommended that the string
67  * name for a message type match the name of the struct that's stored in the
68  * message. For example, name for \ref stasis_cache_update's message type is \c
69  * "stasis_cache_update".
70  *
71  * \par stasis_topic
72  *
73  * A \ref stasis_topic is an object to which \ref stasis_subscriber's may be
74  * subscribed, and \ref stasis_message's may be published. Any message published
75  * to the topic is dispatched to all of its subscribers. The topic itself may be
76  * named, which is useful in debugging.
77  *
78  * Topics themselves are reference counted objects, and automagically
79  * unsubscribe all of their subscribers when they are destroyed. Topics are also
80  * thread safe, so no worries about publishing/subscribing/unsubscribing to a
81  * topic concurrently from multiple threads. It's also designed to handle the
82  * case of unsubscribing from a topic from within the subscription handler.
83  *
84  * \par Forwarding
85  *
86  * There is one special case of topics that's worth noting: forwarding
87  * messages. It's a fairly common use case to want to forward all the messages
88  * published on one topic to another one (for example, an aggregator topic that
89  * publishes all the events from a set of other topics). This can be
90  * accomplished easily using stasis_forward_all(). This sets up the forwarding
91  * between the two topics, and returns a \ref stasis_subscription, which can be
92  * unsubscribed to stop the forwarding.
93  *
94  * \par Caching
95  *
96  * Another common use case is to want to cache certain messages that are
97  * published on the bus. Usually these events are snapshots of the current state
98  * in the system, and it's desirable to query that state from the cache without
99  * locking the original object. It's also desirable for subscribers of the
100  * caching topic to receive messages that have both the old cache value and the
101  * new value being put into the cache. For this, we have
102  * stasis_caching_topic_create(), providing it with the topic which publishes
103  * the messages that you wish to cache, and a function that can identify
104  * cacheable messages.
105  *
106  * The returned \ref stasis_caching_topic provides a topic that forwards
107  * non-cacheable messages unchanged. A cacheable message is wrapped in a \ref
108  * stasis_cache_update message which provides the old snapshot (or \c NULL if
109  * this is a new cache entry), and the new snapshot (or \c NULL if the entry was
110  * removed from the cache). A stasis_cache_clear_create() message must be sent
111  * to the topic in order to remove entries from the cache.
112  *
113  * As with all things Stasis, the \ref stasis_caching_topic is a reference
114  * counted AO2 object.
115  *
116  * \par stasis_subscriber
117  *
118  * Any topic may be subscribed to by simply providing stasis_subscribe() the
119  * \ref stasis_topic to subscribe to, a handler function and \c void pointer to
120  * data that is passed back to the handler. Invocations on the subscription's
121  * handler are serialized, but different invocations may occur on different
122  * threads (this usually isn't important unless you use thread locals or
123  * something similar).
124  *
125  * Since the topic (by necessity) holds a reference to the subscription,
126  * reference counting alone is insufficient to terminate a subscription. In
127  * order to stop receiving messages, call stasis_unsubscribe() with your \ref
128  * stasis_subscription. This will remove the topic's reference to the
129  * subscription, and allow it to be destroyed when all of the other references
130  * are cleaned up.
131  */
132
133 #include "asterisk/utils.h"
134
135 /*! @{ */
136
137 /*!
138  * \brief Metadata about a \ref stasis_message.
139  * \since 12
140  */
141 struct stasis_message_type;
142
143 /*!
144  * \brief Register a new message type.
145  *
146  * \ref stasis_message_type is an AO2 object, so ao2_cleanup() when you're done
147  * with it.
148  *
149  * \param name Name of the new type.
150  * \return Pointer to the new type.
151  * \return \c NULL on error.
152  * \since 12
153  */
154 struct stasis_message_type *stasis_message_type_create(const char *name);
155
156 /*!
157  * \brief Gets the name of a given message type
158  * \param type The type to get.
159  * \return Name of the type.
160  * \return \c NULL if \a type is \c NULL.
161  * \since 12
162  */
163 const char *stasis_message_type_name(const struct stasis_message_type *type);
164
165 /*!
166  * \brief Opaque type for a Stasis message.
167  * \since 12
168  */
169 struct stasis_message;
170
171 /*!
172  * \brief Create a new message.
173  *
174  * This message is an \c ao2 object, and must be ao2_cleanup()'ed when you are done
175  * with it. Messages are also immutable, and must not be modified after they
176  * are initialized. Especially the \a data in the message.
177  *
178  * \param type Type of the message
179  * \param data Immutable data that is the actual contents of the message
180  * \return New message
181  * \return \c NULL on error
182  * \since 12
183  */
184 struct stasis_message *stasis_message_create(struct stasis_message_type *type, void *data);
185
186 /*!
187  * \brief Get the message type for a \ref stasis_message.
188  * \param msg Message to type
189  * \return Type of \a msg
190  * \return \c NULL if \a msg is \c NULL.
191  * \since 12
192  */
193 struct stasis_message_type *stasis_message_type(const struct stasis_message *msg);
194
195 /*!
196  * \brief Get the data contained in a message.
197  * \param msg Message.
198  * \return Immutable data pointer
199  * \return \c NULL if msg is \c NULL.
200  * \since 12
201  */
202 void *stasis_message_data(const struct stasis_message *msg);
203
204 /*!
205  * \brief Get the time when a message was created.
206  * \param msg Message.
207  * \return Pointer to the \a timeval when the message was created.
208  * \return \c NULL if msg is \c NULL.
209  * \since 12
210  */
211 const struct timeval *stasis_message_timestamp(const struct stasis_message *msg);
212
213 /*! @} */
214
215 /*! @{ */
216
217 /*!
218  * \brief A topic to which messages may be posted, and subscribers, well, subscribe
219  * \since 12
220  */
221 struct stasis_topic;
222
223 /*!
224  * \brief Create a new topic.
225  * \param name Name of the new topic.
226  * \return New topic instance.
227  * \return \c NULL on error.
228  * \since 12
229  */
230 struct stasis_topic *stasis_topic_create(const char *name);
231
232 /*!
233  * \brief Return the name of a topic.
234  * \param topic Topic.
235  * \return Name of the topic.
236  * \return \c NULL if topic is \c NULL.
237  * \since 12
238  */
239 const char *stasis_topic_name(const struct stasis_topic *topic);
240
241 /*!
242  * \brief Publish a message to a topic's subscribers.
243  * \param topic Topic.
244  * \param message Message to publish.
245  * \since 12
246  */
247 void stasis_publish(struct stasis_topic *topic, struct stasis_message *message);
248
249 /*!
250  * \brief Publish a message from a specified topic to all the subscribers of a
251  * possibly different topic.
252  * \param topic Topic to publish message to.
253  * \param topic Original topic message was from.
254  * \param message Message
255  * \since 12
256  */
257 void stasis_forward_message(struct stasis_topic *topic,
258                             struct stasis_topic *publisher_topic,
259                             struct stasis_message *message);
260
261 /*! @} */
262
263 /*! @{ */
264
265 /*!
266  * \brief Opaque type for a Stasis subscription.
267  * \since 12
268  */
269 struct stasis_subscription;
270
271 /*!
272  * \brief Callback function type for Stasis subscriptions.
273  * \param data Data field provided with subscription.
274  * \param topic Topic to which the message was published.
275  * \param message Published message.
276  * \since 12
277  */
278 typedef void (*stasis_subscription_cb)(void *data, struct stasis_subscription *sub, struct stasis_topic *topic, struct stasis_message *message);
279
280 /*!
281  * \brief Create a subscription.
282  *
283  * In addition to being AO2 managed memory (requiring an ao2_cleanup() to free
284  * up this reference), the subscription must be explicitly unsubscribed from its
285  * topic using stasis_unsubscribe().
286  *
287  * The invocations of the callback are serialized, but may not always occur on
288  * the same thread. The invocation order of different subscriptions is
289  * unspecified.
290  *
291  * \param topic Topic to subscribe to.
292  * \param callback Callback function for subscription messages.
293  * \param data Data to be passed to the callback, in addition to the message.
294  * \return New \ref stasis_subscription object.
295  * \return \c NULL on error.
296  * \since 12
297  */
298 struct stasis_subscription *stasis_subscribe(struct stasis_topic *topic,
299                                              stasis_subscription_cb callback,
300                                              void *data);
301
302 /*!
303  * \brief Cancel a subscription.
304  *
305  * Note that in an asynchronous system, there may still be messages queued or
306  * in transit to the subscription's callback. These will still be delivered.
307  * There will be a final 'SubscriptionCancelled' message, indicating the
308  * delivery of the final message.
309  *
310  * \param subscription Subscription to cancel.
311  * \since 12
312  */
313 void stasis_unsubscribe(struct stasis_subscription *subscription);
314
315 /*!
316  * \brief Create a subscription which forwards all messages from one topic to
317  * another.
318  *
319  * Note that the \a topic parameter of the invoked callback will the be \a topic
320  * the message was sent to, not the topic the subscriber subscribed to.
321  *
322  * \param from_topic Topic to forward.
323  * \param to_topic Destination topic of forwarded messages.
324  * \return New forwarding subscription.
325  * \return \c NULL on error.
326  * \since 12
327  */
328 struct stasis_subscription *stasis_forward_all(struct stasis_topic *from_topic, struct stasis_topic *to_topic);
329
330 /*!
331  * \brief Get the unique ID for the subscription.
332  *
333  * \param sub Subscription for which to get the unique ID.
334  * \return Unique ID for the subscription.
335  * \since 12
336  */
337 const char *stasis_subscription_uniqueid(const struct stasis_subscription *sub);
338
339 /*!
340  * \brief Returns whether a subscription is currently subscribed.
341  *
342  * Note that there may still be messages queued up to be dispatched to this
343  * subscription, but the stasis_subscription_final_message() has been enqueued.
344  *
345  * \param sub Subscription to check
346  * \return False (zero) if subscription is not subscribed.
347  * \return True (non-zero) if still subscribed.
348  */
349 int stasis_subscription_is_subscribed(const struct stasis_subscription *sub);
350
351 /*!
352  * \brief Determine whether a message is the final message to be received on a subscription.
353  *
354  * \param sub Subscription on which the message was received.
355  * \param msg Message to check.
356  * \return zero if the provided message is not the final message.
357  * \return non-zero if the provided message is the final message.
358  * \since 12
359  */
360 int stasis_subscription_final_message(struct stasis_subscription *sub, struct stasis_message *msg);
361
362 /*!
363  * \brief Holds details about changes to subscriptions for the specified topic
364  * \since 12
365  */
366 struct stasis_subscription_change {
367         AST_DECLARE_STRING_FIELDS(
368                 AST_STRING_FIELD(uniqueid);     /*!< The unique ID associated with this subscription */
369                 AST_STRING_FIELD(description);  /*!< The description of the change to the subscription associated with the uniqueid */
370         );
371         struct stasis_topic *topic;             /*!< The topic the subscription is/was subscribing to */
372 };
373
374 /*!
375  * \brief Gets the message type for subscription change notices
376  * \return The stasis_message_type for subscription change notices
377  * \since 12
378  */
379 struct stasis_message_type *stasis_subscription_change(void);
380
381 /*! @} */
382
383 /*! @{ */
384
385 /*!
386  * \brief A topic wrapper, which caches certain messages.
387  * \since 12
388  */
389 struct stasis_caching_topic;
390
391 /*!
392  * \brief Message type for cache update messages.
393  * \return Message type for cache update messages.
394  * \since 12
395  */
396 struct stasis_message_type *stasis_cache_update(void);
397
398 /*!
399  * \brief Cache update message
400  * \since 12
401  */
402 struct stasis_cache_update {
403         /*! \brief Topic that published \c new_snapshot */
404         struct stasis_topic *topic;
405         /*! \brief Convenience reference to snapshot type */
406         struct stasis_message_type *type;
407         /*! \brief Old value from the cache */
408         struct stasis_message *old_snapshot;
409         /*! \brief New value */
410         struct stasis_message *new_snapshot;
411 };
412
413 /*!
414  * \brief A message which instructs the caching topic to remove an entry from its cache.
415  * \param type Message type.
416  * \param id Unique id of the snapshot to clear.
417  * \return Message which, when sent to the \a topic, will clear the item from the cache.
418  * \return \c NULL on error.
419  * \since 12
420  */
421 struct stasis_message *stasis_cache_clear_create(struct stasis_message_type *type, const char *id);
422
423 /*!
424  * \brief Callback extract a unique identity from a snapshot message.
425  *
426  * This identity is unique to the underlying object of the snapshot, such as the
427  * UniqueId field of a channel.
428  *
429  * \param message Message to extract id from.
430  * \return String representing the snapshot's id.
431  * \return \c NULL if the message_type of the message isn't a handled snapshot.
432  * \since 12
433  */
434 typedef const char *(*snapshot_get_id)(struct stasis_message *message);
435
436 /*!
437  * \brief Create a topic which monitors and caches messages from another topic.
438  *
439  * The idea is that some topics publish 'snapshots' of some other object's state
440  * that should be cached. When these snapshot messages are received, the cache
441  * is updated, and a stasis_cache_update() message is forwarded, which has both
442  * the original snapshot message and the new message.
443  *
444  * \param original_topic Topic publishing snapshot messages.
445  * \param id_fn Callback to extract the id from a snapshot message.
446  * \return New topic which changes snapshot messages to stasis_cache_update()
447  *         messages, and forwards all other messages from the original topic.
448  * \since 12
449  */
450 struct stasis_caching_topic *stasis_caching_topic_create(struct stasis_topic *original_topic, snapshot_get_id id_fn);
451
452 /*!
453  * Unsubscribes a caching topic from its upstream topic.
454  * \param caching_topic Caching topic to unsubscribe
455  * \since 12
456  */
457 void stasis_caching_unsubscribe(struct stasis_caching_topic *caching_topic);
458
459 /*!
460  * \brief Returns the topic of cached events from a caching topics.
461  * \param caching_topic The caching topic.
462  * \return The topic that publishes cache update events, along with passthrough events
463  *         from the underlying topic.
464  * \return \c NULL if \a caching_topic is \c NULL.
465  * \since 12
466  */
467 struct stasis_topic *stasis_caching_get_topic(struct stasis_caching_topic *caching_topic);
468
469 /*!
470  * \brief Retrieve an item from the cache.
471  * \param caching_topic The topic returned from stasis_caching_topic_create().
472  * \param type Type of message to retrieve.
473  * \param id Identity of the snapshot to retrieve.
474  * \return Message from the cache. The cache still owns the message, so
475  *         ao2_ref() if you want to keep it.
476  * \return \c NULL if message is not found.
477  * \since 12
478  */
479 struct stasis_message *stasis_cache_get(struct stasis_caching_topic *caching_topic,
480                                         struct stasis_message_type *type,
481                                         const char *id);
482
483 /*!
484  * \brief Dump cached items to a subscription
485  * \param caching_topic The topic returned from stasis_caching_topic_create().
486  * \param type Type of message to dump (any type if NULL).
487  * \return ao2_container containing all matches (must be unreffed by caller)
488  * \return NULL on allocation error
489  * \since 12
490  */
491 struct ao2_container *stasis_cache_dump(struct stasis_caching_topic *caching_topic,
492                                         struct stasis_message_type *type);
493
494 /*! @} */
495
496 /*! @{ */
497
498 /*!
499  * \brief Initialize the Stasis subsystem
500  * \return 0 on success.
501  * \return Non-zero on error.
502  * \since 12
503  */
504 int stasis_init(void);
505
506 /*!
507  * \private
508  * \brief called by stasis_init() for cache initialization.
509  * \return 0 on success.
510  * \return Non-zero on error.
511  * \since 12
512  */
513 int stasis_cache_init(void);
514
515 /*! @} */
516
517 #endif /* _ASTERISK_STASIS_H */