blob: b911d56320a59d87b01f914779ac6a869270f9dc (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
/*
This file is part of GNUnet.
Copyright (C) 2012-2016 GNUnet e.V.
GNUnet is free software: you can redistribute it and/or modify it
under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License,
or (at your option) any later version.
GNUnet is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @author Christian Grothoff
*
* @file
* General-purpose broadcast mechanism for message queues
*
* @defgroup mq NC library
* General-purpose broadcast mechanism for message queues
*
* @see [Documentation](https://gnunet.org/nc)
*
* @{
*/
#ifndef GNUNET_NC_H
#define GNUNET_NC_H
/**
* The notification context is the key datastructure for a convenience
* API used for transmission of notifications to the subscriber until the
* subscriber disconnects (or the notification context is destroyed, in
* which case we disconnect these subscribers). Essentially, all
* (notification) messages are queued up until the subscriber is able to
* read them.
*/
struct GNUNET_NotificationContext;
/**
* Create a new notification context.
*
* @param queue_length maximum number of messages to keep in
* the notification queue; optional messages are dropped
* if the queue gets longer than this number of messages
* @return handle to the notification context
*/
struct GNUNET_NotificationContext *
GNUNET_notification_context_create (unsigned int queue_length);
/**
* Destroy the context, force disconnect for all subscribers.
*
* @param nc context to destroy.
*/
void
GNUNET_notification_context_destroy (struct GNUNET_NotificationContext *nc);
/**
* Add a subscriber to the notification context.
*
* @param nc context to modify
* @param mq message queue add
*/
void
GNUNET_notification_context_add (struct GNUNET_NotificationContext *nc,
struct GNUNET_MQ_Handle *mq);
/**
* Send a message to all subscribers of this context.
*
* @param nc context to modify
* @param msg message to send
* @param can_drop can this message be dropped due to queue length limitations
*/
void
GNUNET_notification_context_broadcast (struct GNUNET_NotificationContext *nc,
const struct GNUNET_MessageHeader *msg,
int can_drop);
/**
* Return active number of subscribers in this context.
*
* @param nc context to query
* @return number of current subscribers
*/
unsigned int
GNUNET_notification_context_get_size (struct GNUNET_NotificationContext *nc);
#endif
|
