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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
|
/*
This file is part of GNUnet.
(C) 2012 Christian Grothoff (and other contributing authors)
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
by the Free Software Foundation; either version 2, 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
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNUnet; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
*/
/**
* @author Florian Dold
* @file mq/mq.h
* @brief general purpose request queue
*/
#ifndef MQ_H
#define MQ_H
#include "platform.h"
#include "gnunet_common.h"
#include "gnunet_util_lib.h"
#include "gnunet_connection_lib.h"
#define GNUNET_MQ_msg_extra(mvar, esize, type) GNUNET_MQ_msg_(((void) mvar->header, (struct GNUNET_MessageHeader**) &mvar), (esize) + sizeof *mvar, type)
#define GNUNET_MQ_msg(mvar, type) GNUNET_MQ_msg_extra(mvar, 0, type)
#define GNUNET_MQ_msg_raw(type) GNUNET_MQ_msg_ (NULL, sizeof (struct GNUNET_MessageHeader), type)
#define GNUNET_MQ_HANDLERS_END {NULL, 0}
struct GNUNET_MQ_MessageQueue;
struct GNUNET_MQ_Message;
struct GNUNET_MQ_Handler
{
void *cb;
uint16_t type;
};
/**
* Callback used for notifications
*
* @param cls closure
*/
typedef void (*GNUNET_MQ_NotifyCallback) (void *cls);
/**
* Create a new message for MQ.
*
* @param mhp message header to store the allocated message header in, can be NULL
* @param size size of the message to allocate
* @param type type of the message, will be set in the allocated message
* @param return the allocated MQ message
*/
struct GNUNET_MQ_Message *
GNUNET_MQ_msg_ (struct GNUNET_MessageHeader **mhp, uint16_t size, uint16_t type);
/**
* Send a message with the give message queue.
* May only be called once per message.
*
* @param mq message queue
* @param mqm the message to send.
*/
void
GNUNET_MQ_send (struct GNUNET_MQ_MessageQueue *mq, struct GNUNET_MQ_Message *mqm);
/**
* Cancel sending the message. Message must have been sent with GNUNET_MQ_send before.
* May not be called after the notify sent callback has been called
*
* @param mqm queued message to cancel
*/
void
GNUNET_MQ_send_cancel (struct GNUNET_MQ_Message *mqm);
/**
* Associate the assoc_data in mq with a unique request id.
*
* @param mq message queue, id will be unique for the queue
* @param mqm message to associate
* @param data to associate
*/
uint32_t
GNUNET_MQ_assoc_add (struct GNUNET_MQ_MessageQueue *mq,
struct GNUNET_MQ_Message *mqm,
void *assoc_data);
void *
GNUNET_MQ_assoc_get (struct GNUNET_MQ_MessageQueue *mq, uint32_t request_id);
void *
GNUNET_MQ_assoc_remove (struct GNUNET_MQ_MessageQueue *mq, uint32_t request_id);
struct GNUNET_MQ_MessageQueue *
GNUNET_MQ_queue_for_connection_client (struct GNUNET_CLIENT_Connection *connection,
const struct GNUNET_MQ_Handler *handlers,
void *cls);
void
GNUNET_MQ_notify_sent (struct GNUNET_MQ_Message *mqm,
GNUNET_MQ_NotifyCallback cb,
void *cls);
void
GNUNET_MQ_notify_timeout (struct GNUNET_MQ_Message *mqm,
GNUNET_MQ_NotifyCallback cb,
void *cls);
void
GNUNET_MQ_destroy (struct GNUNET_MQ_MessageQueue *mq);
#endif
|
