aboutsummaryrefslogtreecommitdiff
path: root/src/include/gnunet_service_lib.h
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2016-08-29 11:38:50 +0000
committerFlorian Dold <florian.dold@gmail.com>2016-08-29 11:38:50 +0000
commit95830b32ee739a74ac6a4b44aaddd110176273f1 (patch)
treef036e4689adf09e7a157950686cdc3a8d3203e13 /src/include/gnunet_service_lib.h
parentc72191714fb32cf3c7c9b3816293cfce64fbdf36 (diff)
downloadgnunet-95830b32ee739a74ac6a4b44aaddd110176273f1.tar.gz
gnunet-95830b32ee739a74ac6a4b44aaddd110176273f1.zip
more docs for service api
Diffstat (limited to 'src/include/gnunet_service_lib.h')
-rw-r--r--src/include/gnunet_service_lib.h30
1 files changed, 15 insertions, 15 deletions
diff --git a/src/include/gnunet_service_lib.h b/src/include/gnunet_service_lib.h
index 389de0575..0d9589205 100644
--- a/src/include/gnunet_service_lib.h
+++ b/src/include/gnunet_service_lib.h
@@ -195,23 +195,23 @@ GNUNET_SERVICE_stop (struct GNUNET_SERVICE_Context *sctx);
195/* **************** NEW SERVICE API ********************** */ 195/* **************** NEW SERVICE API ********************** */
196 196
197/** 197/**
198 * 198 * Handle to a service.
199 */ 199 */
200struct GNUNET_SERVICE_Handle; 200struct GNUNET_SERVICE_Handle;
201 201
202 202
203/** 203/**
204 * 204 * Handle to a client that is connected to a service.
205 */ 205 */
206struct GNUNET_SERVICE_Client; 206struct GNUNET_SERVICE_Client;
207 207
208 208
209/** 209/**
210 * Callback to initialize a service, called exactly once when the service is run.
210 * 211 *
211 * 212 * @param cls closure passed to #GNUNET_SERVICE_MAIN
212 * @param cls 213 * @param cfg configuration to use for this service
213 * @param cfg 214 * @param sh handle to the newly create service
214 * @param sh
215 */ 215 */
216typedef void 216typedef void
217(*GNUNET_SERVICE_InitCallback)(void *cls, 217(*GNUNET_SERVICE_InitCallback)(void *cls,
@@ -220,12 +220,12 @@ typedef void
220 220
221 221
222/** 222/**
223 * Callback to be called when a client connects to the service.
223 * 224 *
224 * 225 * @param cls closure for the service
225 * @param cls 226 * @param c the new client that connected to the service
226 * @param c 227 * @param mq the message queue used to send messages to the client
227 * @param mq 228 * @return the client-specific (`internal') closure
228 * @return
229 */ 229 */
230typedef void * 230typedef void *
231(*GNUNET_SERVICE_ConnectHandler)(void *cls, 231(*GNUNET_SERVICE_ConnectHandler)(void *cls,
@@ -234,11 +234,11 @@ typedef void *
234 234
235 235
236/** 236/**
237 * Callback to be called when a client disconnected from the service
237 * 238 *
238 * 239 * @param cls closure for the service
239 * @param cls 240 * @param c the client that disconnected
240 * @param c 241 * @param internal_cls the client-specific (`internal') closure
241 * @param internal_cls
242 */ 242 */
243typedef void 243typedef void
244(*GNUNET_SERVICE_DisconnectHandler)(void *cls, 244(*GNUNET_SERVICE_DisconnectHandler)(void *cls,