aboutsummaryrefslogtreecommitdiff
path: root/src/include/gnunet_mesh_service_enc.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/include/gnunet_mesh_service_enc.h')
-rw-r--r--src/include/gnunet_mesh_service_enc.h20
1 files changed, 10 insertions, 10 deletions
diff --git a/src/include/gnunet_mesh_service_enc.h b/src/include/gnunet_mesh_service_enc.h
index b495d0754..af4eeaa5d 100644
--- a/src/include/gnunet_mesh_service_enc.h
+++ b/src/include/gnunet_mesh_service_enc.h
@@ -91,7 +91,7 @@ enum MeshOption
91/** 91/**
92 * Functions with this signature are called whenever a message is 92 * Functions with this signature are called whenever a message is
93 * received. 93 * received.
94 * 94 *
95 * Each time the function must call #GNUNET_MESH_receive_done on the channel 95 * Each time the function must call #GNUNET_MESH_receive_done on the channel
96 * in order to receive the next message. This doesn't need to be immediate: 96 * in order to receive the next message. This doesn't need to be immediate:
97 * can be delayed if some processing is done on the message. 97 * can be delayed if some processing is done on the message.
@@ -161,8 +161,8 @@ typedef void *(GNUNET_MESH_InboundChannelNotificationHandler) (void *cls,
161 161
162/** 162/**
163 * Function called whenever a channel is destroyed. Should clean up 163 * Function called whenever a channel is destroyed. Should clean up
164 * any associated state. 164 * any associated state.
165 * 165 *
166 * It must NOT call #GNUNET_MESH_channel_destroy on the channel. 166 * It must NOT call #GNUNET_MESH_channel_destroy on the channel.
167 * 167 *
168 * @param cls closure (set from #GNUNET_MESH_connect) 168 * @param cls closure (set from #GNUNET_MESH_connect)
@@ -180,7 +180,7 @@ typedef void (GNUNET_MESH_ChannelEndHandler) (void *cls,
180 * Connect to the mesh service. 180 * Connect to the mesh service.
181 * 181 *
182 * @param cfg Configuration to use. 182 * @param cfg Configuration to use.
183 * @param cls Closure for the various callbacks that follow (including 183 * @param cls Closure for the various callbacks that follow (including
184 * handlers in the handlers array). 184 * handlers in the handlers array).
185 * @param new_channel Function called when an *incoming* channel is created. 185 * @param new_channel Function called when an *incoming* channel is created.
186 * Can be NULL if no inbound channels are desired. 186 * Can be NULL if no inbound channels are desired.
@@ -191,10 +191,10 @@ typedef void (GNUNET_MESH_ChannelEndHandler) (void *cls,
191 * @param handlers Callbacks for messages we care about, NULL-terminated. Each 191 * @param handlers Callbacks for messages we care about, NULL-terminated. Each
192 * one must call #GNUNET_MESH_receive_done on the channel to 192 * one must call #GNUNET_MESH_receive_done on the channel to
193 * receive the next message. Messages of a type that is not 193 * receive the next message. Messages of a type that is not
194 * in the handlers array are ignored if received. 194 * in the handlers array are ignored if received.
195 * @param ports NULL or 0-terminated array of port numbers for incoming channels. 195 * @param ports NULL or 0-terminated array of port numbers for incoming channels.
196 * See @a new_channel. 196 * See @a new_channel.
197 * 197 *
198 * @return handle to the mesh service NULL on error 198 * @return handle to the mesh service NULL on error
199 * (in this case, init is never called) 199 * (in this case, init is never called)
200 */ 200 */
@@ -231,7 +231,7 @@ GNUNET_MESH_disconnect (struct GNUNET_MESH_Handle *handle);
231 * @return handle to the channel 231 * @return handle to the channel
232 */ 232 */
233struct GNUNET_MESH_Channel * 233struct GNUNET_MESH_Channel *
234GNUNET_MESH_channel_create (struct GNUNET_MESH_Handle *h, 234GNUNET_MESH_channel_create (struct GNUNET_MESH_Handle *h,
235 void *channel_ctx, 235 void *channel_ctx,
236 const struct GNUNET_PeerIdentity *peer, 236 const struct GNUNET_PeerIdentity *peer,
237 uint32_t port, 237 uint32_t port,
@@ -241,7 +241,7 @@ GNUNET_MESH_channel_create (struct GNUNET_MESH_Handle *h,
241 241
242/** 242/**
243 * Destroy an existing channel. 243 * Destroy an existing channel.
244 * 244 *
245 * The existing end callback for the channel will be called immediately. 245 * The existing end callback for the channel will be called immediately.
246 * Any pending outgoing messages will be sent but no incoming messages will be 246 * Any pending outgoing messages will be sent but no incoming messages will be
247 * accepted and no data callbacks will be called. 247 * accepted and no data callbacks will be called.
@@ -255,7 +255,7 @@ GNUNET_MESH_channel_destroy (struct GNUNET_MESH_Channel *channel);
255/** 255/**
256 * Struct to retrieve info about a channel. 256 * Struct to retrieve info about a channel.
257 */ 257 */
258union GNUNET_MESH_ChannelInfo 258union GNUNET_MESH_ChannelInfo
259{ 259{
260 260
261 /** 261 /**
@@ -329,7 +329,7 @@ GNUNET_MESH_notify_transmit_ready_cancel (struct GNUNET_MESH_TransmitHandle
329 329
330/** 330/**
331 * Indicate readiness to receive the next message on a channel. 331 * Indicate readiness to receive the next message on a channel.
332 * 332 *
333 * Should only be called once per handler called. 333 * Should only be called once per handler called.
334 * 334 *
335 * @param channel Channel that will be allowed to call another handler. 335 * @param channel Channel that will be allowed to call another handler.