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
|
/*
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 mesh/gnunet-service-mesh_connection.h
* @brief mesh service; dealing with connections
* @author Bartlomiej Polot
*
* All functions in this file should use the prefix GMC (Gnunet Mesh Connection)
*/
#ifndef GNUNET_SERVICE_MESH_CONNECTION_H
#define GNUNET_SERVICE_MESH_CONNECTION_H
#ifdef __cplusplus
extern "C"
{
#if 0 /* keep Emacsens' auto-indent happy */
}
#endif
#endif
#include "gnunet_util_lib.h"
/**
* Struct containing all information regarding a connection to a peer.
*/
struct MeshConnection;
/**
* Initialize the connections subsystem
*
* @param c Configuration handle.
*/
void
GMC_init (const struct GNUNET_CONFIGURATION_Handle *c);
/**
* Shut down the connections subsystem.
*/
void
GMC_shutdown (void);
/**
* Create a connection.
*
* @param cid Connection ID.
*/
struct MeshConnection *
GMC_new (const struct GNUNET_HashCode *cid);
/**
* Connection is no longer needed: destroy it and remove from tunnel.
*
* @param c Connection to destroy.
*/
void
GMC_destroy (struct MeshConnection *c);
/**
* Count connections in a DLL.
*/
unsigned int
GMC_count (const struct MeshConnection *head);
/**
* Send FWD keepalive packets for a connection.
*
* @param cls Closure (connection for which to send the keepalive).
* @param tc Notification context.
*/
void
GMC_fwd_keepalive (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
/**
* Send BCK keepalive packets for a connection.
*
* @param cls Closure (connection for which to send the keepalive).
* @param tc Notification context.
*/
void
GMC_bck_keepalive (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc);
/**
* Change the tunnel state.
*
* @param c Connection whose state to change.
* @param state New state.
*/
void
GMC_change_state (struct MeshConnection* c, enum MeshConnectionState state);
/**
* Iterator to notify all connections of a broken link. Mark connections
* to destroy after all traffic has been sent.
*
* @param cls Closure (peer disconnected).
* @param key Current key code (tid).
* @param value Value in the hash map (connection).
*
* @return GNUNET_YES if we should continue to iterate,
* GNUNET_NO if not.
*/
int
GMC_notify_broken (void *cls,
const struct GNUNET_HashCode *key,
void *value);
/**
* @brief Queue and pass message to core when possible.
*
* @param cls Closure (@c type dependant). It will be used by queue_send to
* build the message to be sent if not already prebuilt.
* @param type Type of the message, 0 for a raw message.
* @param size Size of the message.
* @param c Connection this message belongs to (cannot be NULL).
* @param ch Channel this message belongs to, if applicable (otherwise NULL).
* @param fwd Is this a message going root->dest? (FWD ACK are NOT FWD!)
*/
void
GMC_queue_add (void* cls,
uint16_t type,
size_t size,
struct MeshConnection* c,
struct MeshChannel* ch,
int fwd);
/**
* Free a transmission that was already queued with all resources
* associated to the request.
*
* @param queue Queue handler to cancel.
* @param clear_cls Is it necessary to free associated cls?
*/
void
GMC_queue_destroy (struct MeshPeerQueue *queue, int clear_cls);
/**
* Core callback to write a queued packet to core buffer
*
* @param cls Closure (peer info).
* @param size Number of bytes available in buf.
* @param buf Where the to write the message.
*
* @return number of bytes written to buf
*/
size_t
GMC_queue_send (void *cls, size_t size, void *buf);
/**
* Is this peer the first one on the connection?
*
* @param c Connection.
* @param fwd Is this about fwd traffic?
*
* @return GNUNET_YES if origin, GNUNET_NO if relay/terminal.
*/
int
GMC_is_origin (struct MeshConnection *c, int fwd);
/**
* Is this peer the last one on the connection?
*
* @param c Connection.
* @param fwd Is this about fwd traffic?
* Note that the ROOT is the terminal for BCK traffic!
*
* @return GNUNET_YES if terminal, GNUNET_NO if relay/origin.
*/
int
GMC_is_terminal (struct MeshConnection *c, int fwd);
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
/* ifndef GNUNET_SERVICE_MESH_CONNECTION_H */
#endif
/* end of gnunet-service-mesh_connection.h */
|
