2 This file is part of GNUnet.
3 Copyright (C) 2012-2016 GNUnet e.V.
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
21 * @author Christian Grothoff
24 * General-purpose broadcast mechanism for message queues
26 * @defgroup mq NC library
27 * General-purpose broadcast mechanism for message queues
29 * @see [Documentation](https://gnunet.org/nc)
38 * The notification context is the key datastructure for a convenience
39 * API used for transmission of notifications to the subscriber until the
40 * subscriber disconnects (or the notification context is destroyed, in
41 * which case we disconnect these subscribers). Essentially, all
42 * (notification) messages are queued up until the subscriber is able to
45 struct GNUNET_NotificationContext;
49 * Create a new notification context.
51 * @param queue_length maximum number of messages to keep in
52 * the notification queue; optional messages are dropped
53 * if the queue gets longer than this number of messages
54 * @return handle to the notification context
56 struct GNUNET_NotificationContext *
57 GNUNET_notification_context_create (unsigned int queue_length);
61 * Destroy the context, force disconnect for all subscribers.
63 * @param nc context to destroy.
66 GNUNET_notification_context_destroy (struct GNUNET_NotificationContext *nc);
70 * Add a subscriber to the notification context.
72 * @param nc context to modify
73 * @param mq message queue add
76 GNUNET_notification_context_add (struct GNUNET_NotificationContext *nc,
77 struct GNUNET_MQ_Handle *mq);
81 * Send a message to all subscribers of this context.
83 * @param nc context to modify
84 * @param msg message to send
85 * @param can_drop can this message be dropped due to queue length limitations
88 GNUNET_notification_context_broadcast (struct GNUNET_NotificationContext *nc,
89 const struct GNUNET_MessageHeader *msg,
93 * Return active number of subscribers in this context.
95 * @param nc context to query
96 * @return number of current subscribers
99 GNUNET_notification_context_get_size (struct GNUNET_NotificationContext *nc);