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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
/*
This file is part of GNUnet.
Copyright (C) 2009-2013, 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
* Library for tokenizing a message stream
* @defgroup server Server library
* Library for tokenizing a message stream
*
* @see [Documentation](https://gnunet.org/mst)
*
* @{
*/
#ifndef GNUNET_MST_LIB_H
#define GNUNET_MST_LIB_H
#ifdef __cplusplus
extern "C"
{
#if 0 /* keep Emacsens' auto-indent happy */
}
#endif
#endif
#include "gnunet_common.h"
/**
* Handle to a message stream tokenizer.
*/
struct GNUNET_MessageStreamTokenizer;
/**
* Functions with this signature are called whenever a
* complete message is received by the tokenizer.
*
* Do not call #GNUNET_mst_destroy from within
* the scope of this callback.
*
* @param cls closure
* @param message the actual message
* @return #GNUNET_OK on success,
* #GNUNET_NO to stop further processing due to disconnect (no error)
* #GNUNET_SYSERR to stop further processing due to error
*/
typedef int
(*GNUNET_MessageTokenizerCallback) (void *cls,
const struct GNUNET_MessageHeader *message);
/**
* Create a message stream tokenizer.
*
* @param cb function to call on completed messages
* @param cb_cls closure for @a cb
* @return handle to tokenizer
*/
struct GNUNET_MessageStreamTokenizer *
GNUNET_MST_create (GNUNET_MessageTokenizerCallback cb,
void *cb_cls);
/**
* Add incoming data to the receive buffer and call the
* callback for all complete messages.
*
* @param mst tokenizer to use
* @param buf input data to add
* @param size number of bytes in @a buf
* @param purge should any excess bytes in the buffer be discarded
* (i.e. for packet-based services like UDP)
* @param one_shot only call callback once, keep rest of message in buffer
* @return #GNUNET_OK if we are done processing (need more data)
* #GNUNET_NO if one_shot was set and we have another message ready
* #GNUNET_SYSERR if the data stream is corrupt
*/
int
GNUNET_MST_from_buffer (struct GNUNET_MessageStreamTokenizer *mst,
const char *buf,
size_t size,
int purge,
int one_shot);
/**
* Add incoming data to the receive buffer and call the
* callback for all complete messages.
*
* @param mst tokenizer to use
* @param buf input data to add
* @param size number of bytes in @a buf
* @param purge should any excess bytes in the buffer be discarded
* (i.e. for packet-based services like UDP)
* @param one_shot only call callback once, keep rest of message in buffer
* @return #GNUNET_OK if we are done processing (need more data)
* #GNUNET_NO if one_shot was set and we have another message ready
* #GNUNET_SYSERR if the data stream is corrupt
*/
int
GNUNET_MST_read (struct GNUNET_MessageStreamTokenizer *mst,
struct GNUNET_NETWORK_Handle *sock,
int purge,
int one_shot);
/**
* Obtain the next message from the @a mst, assuming that
* there are more unprocessed messages in the internal buffer
* of the @a mst.
*
* @param mst tokenizer to use
* @param one_shot only call callback once, keep rest of message in buffer
* @return #GNUNET_OK if we are done processing (need more data)
* #GNUNET_NO if one_shot was set and we have another message ready
* #GNUNET_SYSERR if the data stream is corrupt
*/
int
GNUNET_MST_next (struct GNUNET_MessageStreamTokenizer *mst,
int one_shot);
/**
* Destroys a tokenizer.
*
* @param mst tokenizer to destroy
*/
void
GNUNET_MST_destroy (struct GNUNET_MessageStreamTokenizer *mst);
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
#endif
/** @} */ /* end of group server */
/* end of gnunet_mst_lib.h */
|
