GNUnet  0.10.x
gnunet_cadet_service.h
Go to the documentation of this file.
1 /*
2  This file is part of GNUnet.
3  Copyright (C) 2009-2017 GNUnet e.V.
4 
5  GNUnet is free software: you can redistribute it and/or modify it
6  under the terms of the GNU Affero General Public License as published
7  by the Free Software Foundation, either version 3 of the License,
8  or (at your option) any later version.
9 
10  GNUnet is distributed in the hope that it will be useful, but
11  WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  Affero General Public License for more details.
14 
15  You should have received a copy of the GNU Affero General Public License
16  along with this program. If not, see <http://www.gnu.org/licenses/>.
17 
18  SPDX-License-Identifier: AGPL3.0-or-later
19  */
35 #ifndef GNUNET_CADET_SERVICE_H
36 #define GNUNET_CADET_SERVICE_H
37 
38 #ifdef __cplusplus
39 extern "C" {
40 #if 0 /* keep Emacsens' auto-indent happy */
41 }
42 #endif
43 #endif
44 
45 #include "gnunet_util_lib.h"
47 
51 #define GNUNET_CADET_VERSION 0x00000005
52 
53 
57 struct GNUNET_CADET_Handle;
58 
63 
67 struct GNUNET_CADET_Port;
68 
69 
75 };
76 
77 
91  uint32_t cn GNUNET_PACKED;
92 };
93 
106 typedef void *(*GNUNET_CADET_ConnectEventHandler) (
107  void *cls,
108  struct GNUNET_CADET_Channel *channel,
109  const struct GNUNET_PeerIdentity *source);
110 
111 
124  void *cls,
125  const struct GNUNET_CADET_Channel *channel);
126 
127 
143  void *cls,
144  const struct GNUNET_CADET_Channel *channel,
145  int window_size);
146 
147 
154 struct GNUNET_CADET_Handle *
156 
157 
166 void
168 
169 
183 struct GNUNET_CADET_Port *
185  const struct GNUNET_HashCode *port,
187  void *connects_cls,
190  const struct GNUNET_MQ_MessageHandler *handlers);
191 
192 
199 void
201 
202 
223 struct GNUNET_CADET_Channel *
225  void *channel_cls,
226  const struct GNUNET_PeerIdentity *destination,
227  const struct GNUNET_HashCode *port,
230  const struct GNUNET_MQ_MessageHandler *handlers);
231 
232 
242 void
244 
245 
252 struct GNUNET_MQ_Handle *
253 GNUNET_CADET_get_mq(const struct GNUNET_CADET_Channel *channel);
254 
255 
263 void
265 
266 
276 const struct GNUNET_HashCode *
277 GC_u2h(uint32_t port);
278 
286 };
287 
295  int yes_no;
296 
300  const struct GNUNET_PeerIdentity peer;
301 };
302 
303 
311 const union GNUNET_CADET_ChannelInfo *
314  ...);
315 
316 
317 /******************************************************************************/
318 /******************** MONITORING /DEBUG API *************************/
319 /******************************************************************************/
320 /* The following calls are not useful for normal CADET operation, but for */
321 /* debug and monitoring of the cadet state. They can be safely ignored. */
322 /* The API can change at any point without notice. */
323 /* Please contact the developer if you consider any of this calls useful for */
324 /* normal cadet applications. */
325 /******************************************************************************/
326 
327 
335  struct GNUNET_PeerIdentity root;
336 
340  struct GNUNET_PeerIdentity dest;
341 
342  // to be expanded!
343 };
344 
345 
353 typedef void (*GNUNET_CADET_ChannelCB) (
354  void *cls,
355  const struct GNUNET_CADET_ChannelInternals *info);
356 
357 
362 
363 
374  struct GNUNET_PeerIdentity *peer,
375  GNUNET_CADET_ChannelCB callback,
376  void *callback_cls);
377 
378 
385 void *
387 
388 
396  struct GNUNET_PeerIdentity peer;
397 
402 
406  unsigned int n_paths;
407 
411  unsigned int best_path_length;
412 };
413 
414 
424 typedef void (*GNUNET_CADET_PeersCB) (
425  void *cls,
426  const struct GNUNET_CADET_PeerListEntry *ple);
427 
428 
433 
434 
447  GNUNET_CADET_PeersCB callback,
448  void *callback_cls);
449 
450 
457 void *
459 
460 
468  struct GNUNET_PeerIdentity peer;
469 
473  unsigned int target_offset;
474 
478  unsigned int path_length;
479 
485  const struct GNUNET_PeerIdentity *path;
486 };
487 
488 
496 typedef void (*GNUNET_CADET_PathCB) (
497  void *cls,
498  const struct GNUNET_CADET_PeerPathDetail *ppd);
499 
500 
504 struct GNUNET_CADET_GetPath;
505 
506 
516 struct GNUNET_CADET_GetPath *
518  const struct GNUNET_PeerIdentity *id,
519  GNUNET_CADET_PathCB callback,
520  void *callback_cls);
521 
522 
529 void *
531 
532 
540  struct GNUNET_PeerIdentity peer;
541 
545  uint32_t channels;
546 
550  uint32_t connections;
551 
555  uint16_t estate;
556 
560  uint16_t cstate;
561 };
562 
563 
573 typedef void (*GNUNET_CADET_TunnelsCB) (
574  void *cls,
575  const struct GNUNET_CADET_TunnelDetails *td);
576 
577 
582 
583 
596  GNUNET_CADET_TunnelsCB callback,
597  void *callback_cls);
598 
599 
606 void *
608 
609 
610 #if 0 /* keep Emacsens' auto-indent happy */
611 {
612 #endif
613 #ifdef __cplusplus
614 }
615 #endif
616 
617 /* ifndef GNUNET_CADET_SERVICE_H */
618 #endif
619  /* end of group */
621 
622 /* end of gnunet_cadet_service.h */
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. ...
void GNUNET_CADET_disconnect(struct GNUNET_CADET_Handle *handle)
Disconnect from the cadet service.
Definition: cadet_api.c:838
void * GNUNET_CADET_list_tunnels_cancel(struct GNUNET_CADET_ListTunnels *lt)
Cancel a monitor request.
GNUNET_CADET_WindowSizeEventHandler window_changes
Window size change handler.
Definition: cadet_api.c:172
Opaque handle to the service.
Definition: cadet_api.c:38
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.
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.
Definition: cadet_api.c:929
void(* GNUNET_CADET_WindowSizeEventHandler)(void *cls, const struct GNUNET_CADET_Channel *channel, int window_size)
Function called whenever an MQ-channel&#39;s transmission window size changes.
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...
Internal details about a channel.
uint16_t cstate
What is our connectivity state?
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.
Opaque handle to a channel.
Definition: cadet_api.c:79
unsigned int path_length
Number of entries on the path.
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.
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...
void * GNUNET_CADET_list_peers_cancel(struct GNUNET_CADET_PeersLister *pl)
Cancel a peer info request.
static struct GNUNET_ARM_Handle * h
Connection with ARM.
Definition: gnunet-arm.c:94
unsigned int best_path_length
Length of the shortest path (0 = unknown, 1 = ourselves, 2 = direct neighbour).
struct GNUNET_CADET_Handle * GNUNET_CADET_connect(const struct GNUNET_CONFIGURATION_Handle *cfg)
Connect to the MQ-based cadet service.
Definition: cadet_api.c:973
const struct GNUNET_HashCode * GC_u2h(uint32_t port)
Transitional function to convert an unsigned int port to a hash value.
A 256-bit hashcode.
Details about a tunnel managed by CADET.
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.
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 incomming MQ-based channels.
Definition: cadet_api.c:1007
static struct GNUNET_OS_Process * p
Helper process we started.
Definition: gnunet-qr.c:59
static struct GNUNET_CADET_MessageHandler handlers[]
Handlers, for diverse services.
GNUNET_CADET_ChannelInfoOption
static char * option
Name of the option.
Definition: gnunet-config.c:38
uint32_t channels
How many channels use the tunnel.
static struct GNUNET_DNS_Handle * handle
Handle to transport service.
void * GNUNET_CADET_get_path_cancel(struct GNUNET_CADET_GetPath *gp)
Cancel gp operation.
A 512-bit hashcode.
Union to retrieve info about a channel.
unsigned int target_offset
Offset of the target peer on the path.
Message handler for a specific message type.
void * connects(void *cls, const struct GNUNET_PeerIdentity *peer, struct GNUNET_MQ_Handle *mq)
Definition: 010.c:2
int yes_no
GNUNET_YES / GNUNET_NO, for binary flags.
static struct GNUNET_CONFIGURATION_Handle * cfg
Our configuration.
Definition: gnunet-arm.c:104
Operation handle.
static GstElement * source
Appsrc instance into which we write data for the pipeline.
void disconnects(void *cls, const struct GNUNET_PeerIdentity *peer)
Definition: 011.c:2
struct GNUNET_TESTBED_Peer * peer
The peer associated with this model.
int have_tunnel
Do we have a tunnel to this peer?
void * connects_cls
Closure for connects.
Definition: cadet_api.c:167
const struct GNUNET_PeerIdentity * path
Array of PEER_IDs representing all paths to reach the peer.
void * GNUNET_CADET_get_channel_cancel(struct GNUNET_CADET_ChannelMonitor *cm)
Cancel a channel monitor request.
Handle to a message queue.
Definition: mq.c:84
uint16_t estate
What is our encryption state?
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.
The identity of the host (wraps the signing key of the peer).
Detailed information we return per peer.
void GNUNET_CADET_receive_done(struct GNUNET_CADET_Channel *channel)
Indicate readiness to receive the next message on a channel.
Definition: cadet_api.c:951
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.
Definition: cadet_api.c:1065
#define GNUNET_PACKED
gcc-ism to get packed structs.
static uint16_t port
Port number.
Definition: gnunet-bcd.c:81
Hash uniquely identifying a connection below a tunnel.
configuration data
Definition: configuration.c:83
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.
Information we return per peer.
GNUNET_CADET_WindowSizeEventHandler window_changes
Window change handler.
Definition: cadet_api.c:121
Number identifying a CADET channel within a tunnel.
Opaque handle to a port.
Definition: cadet_api.c:143
unsigned int n_paths
Number of disjoint known paths to peer.
uint32_t connections
How many connections support the tunnel.
void GNUNET_CADET_close_port(struct GNUNET_CADET_Port *p)
Close a port opened with GNUNET_CADET_open_port.
Definition: cadet_api.c:871
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_C...
struct GNUNET_ShortHashCode connection_of_tunnel
void GNUNET_CADET_channel_destroy(struct GNUNET_CADET_Channel *channel)
Destroy an existing channel.
Definition: cadet_api.c:900
Who is the peer at the other end of the channel.
struct GNUNET_MQ_Handle * GNUNET_CADET_get_mq(const struct GNUNET_CADET_Channel *channel)
Obtain the message queue for a connected channel.
Definition: cadet_api.c:1116