aboutsummaryrefslogtreecommitdiff
path: root/src/include/gnunet_core_service.h
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2013-08-21 15:16:58 +0000
committerChristian Grothoff <christian@grothoff.org>2013-08-21 15:16:58 +0000
commit5a38c8f0d1826ea964e3e3452e1a3a2a24d7d35b (patch)
tree7ba261fc1882bcfa6dc0da916272a0ed0d17468e /src/include/gnunet_core_service.h
parent1fca0c918c8468ba16666e8a1c41526cacdc6df2 (diff)
downloadgnunet-5a38c8f0d1826ea964e3e3452e1a3a2a24d7d35b.tar.gz
gnunet-5a38c8f0d1826ea964e3e3452e1a3a2a24d7d35b.zip
-misc doxygen fixes
Diffstat (limited to 'src/include/gnunet_core_service.h')
-rw-r--r--src/include/gnunet_core_service.h51
1 files changed, 8 insertions, 43 deletions
diff --git a/src/include/gnunet_core_service.h b/src/include/gnunet_core_service.h
index dc64f189a..ea8391d4e 100644
--- a/src/include/gnunet_core_service.h
+++ b/src/include/gnunet_core_service.h
@@ -1,6 +1,6 @@
1/* 1/*
2 This file is part of GNUnet. 2 This file is part of GNUnet.
3 (C) 2009, 2010 Christian Grothoff (and other contributing authors) 3 (C) 2009-2013 Christian Grothoff (and other contributing authors)
4 4
5 GNUnet is free software; you can redistribute it and/or modify 5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published 6 it under the terms of the GNU General Public License as published
@@ -23,6 +23,8 @@
23 * @brief core service; this is the main API for encrypted P2P 23 * @brief core service; this is the main API for encrypted P2P
24 * communications 24 * communications
25 * @author Christian Grothoff 25 * @author Christian Grothoff
26 * @defgroup core encrypted direct communication between peers
27 * @{
26 */ 28 */
27 29
28#ifndef GNUNET_CORE_SERVICE_H 30#ifndef GNUNET_CORE_SERVICE_H
@@ -58,8 +60,7 @@ struct GNUNET_CORE_Handle;
58 * @param peer peer identity this notification is about 60 * @param peer peer identity this notification is about
59 */ 61 */
60typedef void (*GNUNET_CORE_ConnectEventHandler) (void *cls, 62typedef void (*GNUNET_CORE_ConnectEventHandler) (void *cls,
61 const struct 63 const struct GNUNET_PeerIdentity *peer);
62 GNUNET_PeerIdentity * peer);
63 64
64 65
65/** 66/**
@@ -69,8 +70,7 @@ typedef void (*GNUNET_CORE_ConnectEventHandler) (void *cls,
69 * @param peer peer identity this notification is about 70 * @param peer peer identity this notification is about
70 */ 71 */
71typedef void (*GNUNET_CORE_DisconnectEventHandler) (void *cls, 72typedef void (*GNUNET_CORE_DisconnectEventHandler) (void *cls,
72 const struct 73 const struct GNUNET_PeerIdentity *peer);
73 GNUNET_PeerIdentity * peer);
74 74
75 75
76/** 76/**
@@ -133,8 +133,7 @@ struct GNUNET_CORE_MessageHandler
133 */ 133 */
134typedef void (*GNUNET_CORE_StartupCallback) (void *cls, 134typedef void (*GNUNET_CORE_StartupCallback) (void *cls,
135 struct GNUNET_CORE_Handle * server, 135 struct GNUNET_CORE_Handle * server,
136 const struct GNUNET_PeerIdentity * 136 const struct GNUNET_PeerIdentity *my_identity);
137 my_identity);
138 137
139 138
140/** 139/**
@@ -280,42 +279,6 @@ GNUNET_CORE_iterate_peers (const struct GNUNET_CONFIGURATION_Handle *cfg,
280 279
281 280
282/** 281/**
283 * Handle to cancel 'is_peer_connected' test.
284 */
285struct GNUNET_CORE_ConnectTestHandle;
286
287
288/**
289 * Check if the given peer is currently connected and return information
290 * about the session if so. This function is for special cirumstances
291 * (GNUNET_TESTING uses it), normal users of the CORE API are
292 * expected to track which peers are connected based on the
293 * connect/disconnect callbacks from GNUNET_CORE_connect. This
294 * function is NOT part of the 'versioned', 'official' API.
295 *
296 * @param cfg configuration to use
297 * @param peer the specific peer to check for
298 * @param peer_cb function to call with the peer information
299 * @param cb_cls closure for @a peer_cb
300 * @return handle to cancel the operation
301 */
302struct GNUNET_CORE_ConnectTestHandle *
303GNUNET_CORE_is_peer_connected (const struct GNUNET_CONFIGURATION_Handle *cfg,
304 const struct GNUNET_PeerIdentity *peer,
305 GNUNET_CORE_ConnectEventHandler peer_cb,
306 void *cb_cls);
307
308
309/**
310 * Abort 'is_connected' test operation.
311 *
312 * @param cth handle for operation to cancel
313 */
314void
315GNUNET_CORE_is_peer_connected_cancel (struct GNUNET_CORE_ConnectTestHandle *cth);
316
317
318/**
319 * Check if the given peer is currently connected. This function is for special 282 * Check if the given peer is currently connected. This function is for special
320 * cirumstances (GNUNET_TESTBED uses it), normal users of the CORE API are 283 * cirumstances (GNUNET_TESTBED uses it), normal users of the CORE API are
321 * expected to track which peers are connected based on the connect/disconnect 284 * expected to track which peers are connected based on the connect/disconnect
@@ -342,6 +305,8 @@ GNUNET_CORE_is_peer_connected_sync (const struct GNUNET_CORE_Handle *h,
342} 305}
343#endif 306#endif
344 307
308/** @} */ /* end of group core */
309
345/* ifndef GNUNET_CORE_SERVICE_H */ 310/* ifndef GNUNET_CORE_SERVICE_H */
346#endif 311#endif
347/* end of gnunet_core_service.h */ 312/* end of gnunet_core_service.h */