/*
This file is part of GNUnet.
- (C) 2009 - 2013 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2009-2014 GNUnet e.V.
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
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.
+ Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
*/
-
/**
- * @file include/gnunet_cadet_service.h
- * @brief cadet service; establish channels to distant peers
* @author Christian Grothoff
+ * @author Bart Polot
+ *
+ * @file
+ * CADET service; establish channels to distant peers
+ *
+ * @defgroup cadet CADET service
+ * Confidential Ad-hoc Decentralized End-to-End Transport
+ *
+ * @see [Documentation](https://gnunet.org/cadet-subsystem)
+ * @see [Paper](https://gnunet.org/cadet)
+ *
+ * @{
*/
-
#ifndef GNUNET_CADET_SERVICE_H
#define GNUNET_CADET_SERVICE_H
/**
* Hash to be used in Cadet communication. Only 256 bits needed,
- * instead of the 512 from @c GNUNET_HashCode.
- *
+ * instead of the 512 from `struct GNUNET_HashCode`.
*/
struct GNUNET_CADET_Hash
{
unsigned char bits[256 / 8];
};
+
/**
- * Channel options.
- * Second line indicates filed in the CadetChannelInfo union carrying the answer.
+ * Channel options. Second line indicates filed in the
+ * CadetChannelInfo union carrying the answer.
*/
enum GNUNET_CADET_ChannelOption
{
* @return #GNUNET_OK to keep the channel open,
* #GNUNET_SYSERR to close it (signal serious error).
*/
-typedef int (*GNUNET_CADET_MessageCallback) (void *cls,
- struct GNUNET_CADET_Channel *channel,
- void **channel_ctx,
- const struct GNUNET_MessageHeader *message);
+typedef int
+(*GNUNET_CADET_MessageCallback) (void *cls,
+ struct GNUNET_CADET_Channel *channel,
+ void **channel_ctx,
+ const struct GNUNET_MessageHeader *message);
/**
struct GNUNET_CADET_MessageHandler
{
/**
- * Function to call for messages of "type".
+ * Function to call for messages of type @e type.
*/
GNUNET_CADET_MessageCallback callback;
* @return initial channel context for the channel
* (can be NULL -- that's not an error)
*/
-typedef void *(GNUNET_CADET_InboundChannelNotificationHandler) (void *cls,
- struct
- GNUNET_CADET_Channel
- * channel,
- const struct
- GNUNET_PeerIdentity
- * initiator,
- uint32_t port,
- enum GNUNET_CADET_ChannelOption
- options);
+typedef void *
+(GNUNET_CADET_InboundChannelNotificationHandler) (void *cls,
+ struct GNUNET_CADET_Channel *channel,
+ const struct GNUNET_PeerIdentity *initiator,
+ uint32_t port,
+ enum GNUNET_CADET_ChannelOption options);
/**
* Function called whenever a channel is destroyed. Should clean up
- * any associated state.
+ * any associated state, including cancelling any pending transmission on this
+ * channel.
*
* It must NOT call #GNUNET_CADET_channel_destroy on the channel.
*
* @param channel_ctx place where local state associated
* with the channel is stored
*/
-typedef void (GNUNET_CADET_ChannelEndHandler) (void *cls,
- const struct GNUNET_CADET_Channel *
- channel,
- void *channel_ctx);
+typedef void
+(GNUNET_CADET_ChannelEndHandler) (void *cls,
+ const struct GNUNET_CADET_Channel *channel,
+ void *channel_ctx);
/**
* @param new_channel Function called when an *incoming* channel is created.
* Can be NULL if no inbound channels are desired.
* See @a ports.
- * @param cleaner Function called when a channel is destroyed by the remote peer.
- * It is NOT called if #GNUNET_CADET_channel_destroy is called on
- * the channel.
+ * @param cleaner Function called when a channel is destroyed.
+ * It is called immediately if #GNUNET_CADET_channel_destroy
+ * is called on the channel.
* @param handlers Callbacks for messages we care about, NULL-terminated. Each
* one must call #GNUNET_CADET_receive_done on the channel to
* receive the next message. Messages of a type that is not
* (in this case, init is never called)
*/
struct GNUNET_CADET_Handle *
-GNUNET_CADET_connect (const struct GNUNET_CONFIGURATION_Handle *cfg, void *cls,
- GNUNET_CADET_InboundChannelNotificationHandler new_channel,
- GNUNET_CADET_ChannelEndHandler cleaner,
- const struct GNUNET_CADET_MessageHandler *handlers,
- const uint32_t *ports);
+GNUNET_CADET_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
+ void *cls,
+ GNUNET_CADET_InboundChannelNotificationHandler new_channel,
+ GNUNET_CADET_ChannelEndHandler cleaner,
+ const struct GNUNET_CADET_MessageHandler *handlers,
+ const uint32_t *ports);
/**
*/
struct GNUNET_CADET_Channel *
GNUNET_CADET_channel_create (struct GNUNET_CADET_Handle *h,
- void *channel_ctx,
- const struct GNUNET_PeerIdentity *peer,
- uint32_t port,
- enum GNUNET_CADET_ChannelOption options);
+ void *channel_ctx,
+ const struct GNUNET_PeerIdentity *peer,
+ uint32_t port,
+ enum GNUNET_CADET_ChannelOption options);
/**
* @param th handle that was returned by "notify_transmit_ready".
*/
void
-GNUNET_CADET_notify_transmit_ready_cancel (struct GNUNET_CADET_TransmitHandle
- *th);
+GNUNET_CADET_notify_transmit_ready_cancel (struct GNUNET_CADET_TransmitHandle *th);
/**
* @param dest_channel_number Local number for dest, if known.
* @param public_channel_numbe Number for P2P, always known.
*/
-typedef void (*GNUNET_CADET_ChannelCB) (void *cls,
- const struct GNUNET_PeerIdentity *root,
- const struct GNUNET_PeerIdentity *dest,
- uint32_t port,
- uint32_t root_channel_number,
- uint32_t dest_channel_number,
- uint32_t public_channel_number);
+typedef void
+(*GNUNET_CADET_ChannelCB) (void *cls,
+ const struct GNUNET_PeerIdentity *root,
+ const struct GNUNET_PeerIdentity *dest,
+ uint32_t port,
+ uint32_t root_channel_number,
+ uint32_t dest_channel_number,
+ uint32_t public_channel_number);
/**
* Method called to retrieve information about all peers in CADET, called
* @param best_path How long is the best path?
* (0 = unknown, 1 = ourselves, 2 = neighbor)
*/
-typedef void (*GNUNET_CADET_PeersCB) (void *cls,
- const struct GNUNET_PeerIdentity *peer,
- int tunnel, unsigned int n_paths,
- unsigned int best_path);
+typedef void
+(*GNUNET_CADET_PeersCB) (void *cls,
+ const struct GNUNET_PeerIdentity *peer,
+ int tunnel,
+ unsigned int n_paths,
+ unsigned int best_path);
/**
* Method called to retrieve information about a specific peer
* @param neighbor Is this a direct neighbor? #GNUNET_YES/#GNUNET_NO
* @param n_paths Number of paths known towards peer.
* @param paths Array of PEER_IDs representing all paths to reach the peer.
- * Each path starts with the local peer.
+ * Each path starts with the first hop (local peer not included).
* Each path ends with the destination peer (given in @c peer).
*/
-typedef void (*GNUNET_CADET_PeerCB) (void *cls,
- const struct GNUNET_PeerIdentity *peer,
- int tunnel,
- int neighbor,
- unsigned int n_paths,
- struct GNUNET_PeerIdentity *paths);
+typedef void
+(*GNUNET_CADET_PeerCB) (void *cls,
+ const struct GNUNET_PeerIdentity *peer,
+ int tunnel,
+ int neighbor,
+ unsigned int n_paths,
+ struct GNUNET_PeerIdentity *paths);
/**
* @param estate Encryption state.
* @param cstate Connectivity state.
*/
-typedef void (*GNUNET_CADET_TunnelsCB) (void *cls,
- const struct GNUNET_PeerIdentity *peer,
- unsigned int channels,
- unsigned int connections,
- uint16_t estate,
- uint16_t cstate);
-
+typedef void
+(*GNUNET_CADET_TunnelsCB) (void *cls,
+ const struct GNUNET_PeerIdentity *peer,
+ unsigned int channels,
+ unsigned int connections,
+ uint16_t estate,
+ uint16_t cstate);
/**
* @param estate Encryption state.
* @param cstate Connectivity state.
*/
-typedef void (*GNUNET_CADET_TunnelCB) (void *cls,
- const struct GNUNET_PeerIdentity *peer,
- unsigned int n_channels,
- unsigned int n_connections,
- uint32_t *channels,
- struct GNUNET_CADET_Hash *connections,
- unsigned int estate,
- unsigned int cstate);
+typedef void
+(*GNUNET_CADET_TunnelCB) (void *cls,
+ const struct GNUNET_PeerIdentity *peer,
+ unsigned int n_channels,
+ unsigned int n_connections,
+ uint32_t *channels,
+ struct GNUNET_CADET_Hash *connections,
+ unsigned int estate,
+ unsigned int cstate);
+
/**
* Request information about a specific channel of the running cadet peer.
*/
void
GNUNET_CADET_get_channel (struct GNUNET_CADET_Handle *h,
- struct GNUNET_PeerIdentity *peer,
- uint32_t channel_number,
- GNUNET_CADET_ChannelCB callback,
- void *callback_cls);
+ struct GNUNET_PeerIdentity *peer,
+ uint32_t channel_number,
+ GNUNET_CADET_ChannelCB callback,
+ void *callback_cls);
+
/**
* Request a debug dump on the service's STDERR.
void
GNUNET_CADET_request_dump (struct GNUNET_CADET_Handle *h);
+
/**
* Request information about peers known to the running cadet service.
* The callback will be called for every peer known to the service.
*/
int
GNUNET_CADET_get_peers (struct GNUNET_CADET_Handle *h,
- GNUNET_CADET_PeersCB callback,
- void *callback_cls);
+ GNUNET_CADET_PeersCB callback,
+ void *callback_cls);
+
/**
* Cancel a peer info request. The callback will not be called (anymore).
*
* @param h Cadet handle.
*
- * @return Closure given to GNUNET_CADET_get_peers.
+ * @return Closure that was given to #GNUNET_CADET_get_peers().
*/
void *
GNUNET_CADET_get_peers_cancel (struct GNUNET_CADET_Handle *h);
GNUNET_CADET_PeerCB callback,
void *callback_cls);
+
/**
* Request information about tunnels of the running cadet peer.
* The callback will be called for every tunnel of the service.
*/
int
GNUNET_CADET_get_tunnels (struct GNUNET_CADET_Handle *h,
- GNUNET_CADET_TunnelsCB callback,
- void *callback_cls);
+ GNUNET_CADET_TunnelsCB callback,
+ void *callback_cls);
+
/**
* Cancel a monitor request. The monitor callback will not be called.
*
* @param h Cadet handle.
*
- * @return Closure given to GNUNET_CADET_monitor, if any.
+ * @return Closure given to #GNUNET_CADET_get_tunnels(), if any.
*/
void *
GNUNET_CADET_get_tunnels_cancel (struct GNUNET_CADET_Handle *h);
*/
int
GNUNET_CADET_get_tunnel (struct GNUNET_CADET_Handle *h,
- const struct GNUNET_PeerIdentity *id,
- GNUNET_CADET_TunnelCB callback,
- void *callback_cls);
+ const struct GNUNET_PeerIdentity *id,
+ GNUNET_CADET_TunnelCB callback,
+ void *callback_cls);
+
/**
* Create a message queue for a cadet channel.
/* ifndef GNUNET_CADET_SERVICE_H */
#endif
+
+/** @} */ /* end of group */
+
/* end of gnunet_cadet_service.h */