gnunet_cadet_service.h File Reference

CADET service; establish channels to distant peers. More...

#include "gnunet_util_lib.h"

Include dependency graph for gnunet_cadet_service.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	GNUNET_CADET_ConnectionTunnelIdentifier
	Hash uniquely identifying a connection below a tunnel. More...
struct	GNUNET_CADET_ChannelTunnelNumber
	Number identifying a CADET channel within a tunnel. More...
union	GNUNET_CADET_ChannelInfo
	Union to retrieve info about a channel. More...
struct	GNUNET_CADET_ChannelInternals
	Internal details about a channel. More...
struct	GNUNET_CADET_PeerListEntry
	Information we return per peer. More...
struct	GNUNET_CADET_PeerPathDetail
	Detailed information we return per peer. More...
struct	GNUNET_CADET_TunnelDetails
	Details about a tunnel managed by CADET. More...

Macros
#define	GNUNET_CADET_VERSION   0x00000005
	Version number of GNUnet-cadet API. More...

Typedefs
typedef void *(*	GNUNET_CADET_ConnectEventHandler) (void *cls, struct GNUNET_CADET_Channel *channel, const struct GNUNET_PeerIdentity *source)
	Method called whenever a peer connects to a port in MQ-based CADET. More...
typedef void(*	GNUNET_CADET_DisconnectEventHandler) (void *cls, const struct GNUNET_CADET_Channel *channel)
	Function called whenever an MQ-channel is destroyed, unless the destruction was requested by GNUNET_CADET_channel_destroy. More...
typedef void(*	GNUNET_CADET_WindowSizeEventHandler) (void *cls, const struct GNUNET_CADET_Channel *channel, int window_size)
	Function called whenever an MQ-channel's transmission window size changes. More...
typedef void(*	GNUNET_CADET_ChannelCB) (void *cls, const struct GNUNET_CADET_ChannelInternals *info)
	Method called to retrieve information about a specific channel the cadet peer is aware of, including all transit nodes. More...
typedef void(*	GNUNET_CADET_PeersCB) (void *cls, const struct GNUNET_CADET_PeerListEntry *ple)
	Method called to retrieve information about all peers in CADET, called once per peer. More...
typedef void(*	GNUNET_CADET_PathCB) (void *cls, const struct GNUNET_CADET_PeerPathDetail *ppd)
	Method called to retrieve information about a specific path known to the service. More...
typedef void(*	GNUNET_CADET_TunnelsCB) (void *cls, const struct GNUNET_CADET_TunnelDetails *td)
	Method called to retrieve information about all tunnels in CADET, called once per tunnel. More...

Enumerations
enum	GNUNET_CADET_ChannelInfoOption { GNUNET_CADET_OPTION_PEER = 0x0 }

Functions
struct GNUNET_CADET_Handle *	GNUNET_CADET_connect (const struct GNUNET_CONFIGURATION_Handle *cfg)
	Connect to the MQ-based cadet service. More...
void	GNUNET_CADET_disconnect (struct GNUNET_CADET_Handle *handle)
	Disconnect from the cadet service. More...
struct GNUNET_CADET_Port *	GNUNET_CADET_open_port (struct GNUNET_CADET_Handle *h, const struct GNUNET_HashCode *port, GNUNET_CADET_ConnectEventHandler connects, void *connects_cls, GNUNET_CADET_WindowSizeEventHandler window_changes, GNUNET_CADET_DisconnectEventHandler disconnects, const struct GNUNET_MQ_MessageHandler *handlers)
	Open a port to receive incoming MQ-based channels. More...
void	GNUNET_CADET_close_port (struct GNUNET_CADET_Port *p)
	Close a port opened with GNUNET_CADET_open_port. More...
struct GNUNET_CADET_Channel *	GNUNET_CADET_channel_create (struct GNUNET_CADET_Handle *h, void *channel_cls, const struct GNUNET_PeerIdentity *destination, const struct GNUNET_HashCode *port, GNUNET_CADET_WindowSizeEventHandler window_changes, GNUNET_CADET_DisconnectEventHandler disconnects, const struct GNUNET_MQ_MessageHandler *handlers)
	Create a new channel towards a remote peer. More...
void	GNUNET_CADET_channel_destroy (struct GNUNET_CADET_Channel *channel)
	Destroy an existing channel. More...
struct GNUNET_MQ_Handle *	GNUNET_CADET_get_mq (const struct GNUNET_CADET_Channel *channel)
	Obtain the message queue for a connected channel. More...
void	GNUNET_CADET_receive_done (struct GNUNET_CADET_Channel *channel)
	Indicate readiness to receive the next message on a channel. More...
const struct GNUNET_HashCode *	GC_u2h (uint32_t port)
	Transitional function to convert an unsigned int port to a hash value. More...
const union GNUNET_CADET_ChannelInfo *	GNUNET_CADET_channel_get_info (struct GNUNET_CADET_Channel *channel, enum GNUNET_CADET_ChannelInfoOption option,...)
	Get information about a channel. More...
struct GNUNET_CADET_ChannelMonitor *	GNUNET_CADET_get_channel (const struct GNUNET_CONFIGURATION_Handle *cfg, struct GNUNET_PeerIdentity *peer, GNUNET_CADET_ChannelCB callback, void *callback_cls)
	Request information about channels to peer from the local peer. More...
void *	GNUNET_CADET_get_channel_cancel (struct GNUNET_CADET_ChannelMonitor *cm)
	Cancel a channel monitor request. More...
struct GNUNET_CADET_PeersLister *	GNUNET_CADET_list_peers (const struct GNUNET_CONFIGURATION_Handle *cfg, GNUNET_CADET_PeersCB callback, void *callback_cls)
	Request information about peers known to the running cadet service. More...
void *	GNUNET_CADET_list_peers_cancel (struct GNUNET_CADET_PeersLister *pl)
	Cancel a peer info request. More...
struct GNUNET_CADET_GetPath *	GNUNET_CADET_get_path (const struct GNUNET_CONFIGURATION_Handle *cfg, const struct GNUNET_PeerIdentity *id, GNUNET_CADET_PathCB callback, void *callback_cls)
	Request information about a peer known to the running cadet peer. More...
void *	GNUNET_CADET_get_path_cancel (struct GNUNET_CADET_GetPath *gp)
	Cancel gp operation. More...
struct GNUNET_CADET_ListTunnels *	GNUNET_CADET_list_tunnels (const struct GNUNET_CONFIGURATION_Handle *cfg, GNUNET_CADET_TunnelsCB callback, void *callback_cls)
	Request information about tunnels of the running cadet peer. More...
void *	GNUNET_CADET_list_tunnels_cancel (struct GNUNET_CADET_ListTunnels *lt)
	Cancel a monitor request. More...

Detailed Description

CADET service; establish channels to distant peers.

Definition in file gnunet_cadet_service.h.