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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
|
/*
This file is part of GNUnet.
(C) 2013 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 3, 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.
*/
/**
* @file cadet/gnunet-service-cadet_local.h
* @brief cadet service; dealing with local clients
* @author Bartlomiej Polot
*
* All functions in this file should use the prefix GML (Gnunet Cadet Local)
*/
#ifndef GNUNET_SERVICE_CADET_LOCAL_H
#define GNUNET_SERVICE_CADET_LOCAL_H
#ifdef __cplusplus
extern "C"
{
#if 0 /* keep Emacsens' auto-indent happy */
}
#endif
#endif
#include "platform.h"
#include "gnunet_util_lib.h"
/**
* Struct containing information about a client of the service
*/
struct CadetClient;
#include "gnunet-service-cadet_channel.h"
/******************************************************************************/
/******************************** API ***********************************/
/******************************************************************************/
/**
* Initialize server subsystem.
*
* @param handle Server handle.
*/
void
GML_init (struct GNUNET_SERVER_Handle *handle);
/**
* Install server (service) handlers and start listening to clients.
*/
void
GML_start (void);
/**
* Shutdown server.
*/
void
GML_shutdown (void);
/**
* Get a channel from a client.
*
* @param c Client to check.
* @param chid Channel ID, must be local (> 0x800...).
*
* @return non-NULL if channel exists in the clients lists
*/
struct CadetChannel *
GML_channel_get (struct CadetClient *c, uint32_t chid);
/**
* Add a channel to a client
*
* @param client Client.
* @param chid Channel ID.
* @param ch Channel.
*/
void
GML_channel_add (struct CadetClient *client,
uint32_t chid,
struct CadetChannel *ch);
/**
* Remove a channel from a client
*
* @param client Client.
* @param chid Channel ID.
* @param ch Channel.
*/
void
GML_channel_remove (struct CadetClient *client,
uint32_t chid,
struct CadetChannel *ch);
/**
* Get the tunnel's next free local channel ID.
*
* @param c Client.
*
* @return LID of a channel free to use.
*/
CADET_ChannelNumber
GML_get_next_chid (struct CadetClient *c);
/**
* Check if client has registered with the service and has not disconnected
*
* @param client the client to check
*
* @return non-NULL if client exists in the global DLL
*/
struct CadetClient *
GML_client_get (struct GNUNET_SERVER_Client *client);
/**
* Find a client that has opened a port
*
* @param port Port to check.
*
* @return non-NULL if a client has the port.
*/
struct CadetClient *
GML_client_get_by_port (uint32_t port);
/**
* Deletes a tunnel from a client (either owner or destination).
*
* @param c Client whose tunnel to delete.
* @param ch Channel which should be deleted.
* @param id Channel ID.
*/
void
GML_client_delete_channel (struct CadetClient *c,
struct CadetChannel *ch,
CADET_ChannelNumber id);
/**
* Build a local ACK message and send it to a local client, if needed.
*
* If the client was already allowed to send data, do nothing.
*
* @param c Client to whom send the ACK.
* @param id Channel ID to use
*/
void
GML_send_ack (struct CadetClient *c, CADET_ChannelNumber id);
/**
* Notify the appropriate client that a new incoming channel was created.
*
* @param c Client to notify.
* @param id Channel ID.
* @param port Channel's destination port.
* @param opt Options (bit array).
* @param peer Origin peer.
*/
void
GML_send_channel_create (struct CadetClient *c,
uint32_t id, uint32_t port, uint32_t opt,
const struct GNUNET_PeerIdentity *peer);
/**
* Build a local channel NACK message and send it to a local client.
*
* @param c Client to whom send the NACK.
* @param id Channel ID to use
*/
void
GML_send_channel_nack (struct CadetClient *c, CADET_ChannelNumber id);
/**
* Notify a client that a channel is no longer valid.
*
* @param c Client.
* @param id ID of the channel that is destroyed.
*/
void
GML_send_channel_destroy (struct CadetClient *c, uint32_t id);
/**
* Modify the cadet message ID from global to local and send to client.
*
* @param c Client to send to.
* @param msg Message to modify and send.
* @param id Channel ID to use (c can be both owner and client).
*/
void
GML_send_data (struct CadetClient *c,
const struct GNUNET_CADET_Data *msg,
CADET_ChannelNumber id);
/**
* Get the static string to represent a client.
*
* @param c Client.
*
* @return Static string for the client.
*/
const char *
GML_2s (const struct CadetClient *c);
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
/* ifndef GNUNET_CADET_SERVICE_LOCAL_H */
#endif
/* end of gnunet-cadet-service_LOCAL.h */
|
