gnunet_cadet_service.h

Go to the documentation of this file.

/*
     This file is part of GNUnet.
     Copyright (C) 2009-2017 GNUnet e.V.
 
     GNUnet is free software: you can redistribute it and/or modify it
     under the terms of the GNU Affero General Public License as published
     by the Free Software Foundation, either version 3 of the License,
     or (at your option) any later version.
 
     GNUnet is distributed in the hope that it will be useful, but
     WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     Affero General Public License for more details.
 
     You should have received a copy of the GNU Affero General Public License
     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
     SPDX-License-Identifier: AGPL3.0-or-later
 */
#ifndef GNUNET_CADET_SERVICE_H
#define GNUNET_CADET_SERVICE_H
 
#ifdef __cplusplus
extern "C" {
#if 0 /* keep Emacsens' auto-indent happy */
}
#endif
#endif
 
 
#include "gnunet_util_lib.h"
 
#define GNUNET_CADET_VERSION 0x00000005
 
 
struct GNUNET_CADET_Handle;
 
struct GNUNET_CADET_Channel;
 
struct GNUNET_CADET_Port;
 
 
struct GNUNET_CADET_ConnectionTunnelIdentifier
{
  struct GNUNET_ShortHashCode connection_of_tunnel;
};
 
 
struct GNUNET_CADET_ChannelTunnelNumber
{
  uint32_t cn GNUNET_PACKED;
};
 
typedef void *(*GNUNET_CADET_ConnectEventHandler) (
  void *cls,
  struct GNUNET_CADET_Channel *channel,
  const struct GNUNET_PeerIdentity *source);
 
 
typedef void (*GNUNET_CADET_DisconnectEventHandler) (
  void *cls,
  const struct GNUNET_CADET_Channel *channel);
 
 
typedef void (*GNUNET_CADET_WindowSizeEventHandler) (
  void *cls,
  const struct GNUNET_CADET_Channel *channel,
  int window_size);
 
 
struct GNUNET_CADET_Handle *
GNUNET_CADET_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
 
 
void
GNUNET_CADET_disconnect (struct GNUNET_CADET_Handle *handle);
 
 
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);
 
 
void
GNUNET_CADET_close_port (struct GNUNET_CADET_Port *p);
 
 
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);
 
 
void
GNUNET_CADET_channel_destroy (struct GNUNET_CADET_Channel *channel);
 
 
struct GNUNET_MQ_Handle *
GNUNET_CADET_get_mq (const struct GNUNET_CADET_Channel *channel);
 
 
void
GNUNET_CADET_receive_done (struct GNUNET_CADET_Channel *channel);
 
const struct GNUNET_HashCode *
GC_u2h (uint32_t port);
 
enum GNUNET_CADET_ChannelInfoOption
{
  GNUNET_CADET_OPTION_PEER = 0x0
};
 
union GNUNET_CADET_ChannelInfo
{
  int yes_no;
 
  const struct GNUNET_PeerIdentity peer;
};
 
 
const union GNUNET_CADET_ChannelInfo *
GNUNET_CADET_channel_get_info (struct GNUNET_CADET_Channel *channel,
                               enum GNUNET_CADET_ChannelInfoOption option,
                               ...);
 
 
/******************************************************************************/
/********************       MONITORING /DEBUG API     *************************/
/******************************************************************************/
/* The following calls are not useful for normal CADET operation, but for      */
/* debug and monitoring of the cadet state. They can be safely ignored.        */
/* The API can change at any point without notice.                            */
/* Please contact the developer if you consider any of this calls useful for  */
/* normal cadet applications.                                                  */
/******************************************************************************/
 
 
struct GNUNET_CADET_ChannelInternals
{
  struct GNUNET_PeerIdentity root;
 
  struct GNUNET_PeerIdentity dest;
 
  // to be expanded!
};
 
 
typedef void (*GNUNET_CADET_ChannelCB) (
  void *cls,
  const struct GNUNET_CADET_ChannelInternals *info);
 
 
struct GNUNET_CADET_ChannelMonitor;
 
 
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);
 
 
void *
GNUNET_CADET_get_channel_cancel (struct GNUNET_CADET_ChannelMonitor *cm);
 
 
struct GNUNET_CADET_PeerListEntry
{
  struct GNUNET_PeerIdentity peer;
 
  int have_tunnel;
 
  unsigned int n_paths;
 
  unsigned int best_path_length;
};
 
 
typedef void (*GNUNET_CADET_PeersCB) (
  void *cls,
  const struct GNUNET_CADET_PeerListEntry *ple);
 
 
struct GNUNET_CADET_PeersLister;
 
 
struct GNUNET_CADET_PeersLister *
GNUNET_CADET_list_peers (const struct GNUNET_CONFIGURATION_Handle *cfg,
                         GNUNET_CADET_PeersCB callback,
                         void *callback_cls);
 
 
void *
GNUNET_CADET_list_peers_cancel (struct GNUNET_CADET_PeersLister *pl);
 
 
struct GNUNET_CADET_PeerPathDetail
{
  struct GNUNET_PeerIdentity peer;
 
  unsigned int target_offset;
 
  unsigned int path_length;
 
  const struct GNUNET_PeerIdentity *path;
};
 
 
typedef void (*GNUNET_CADET_PathCB) (
  void *cls,
  const struct GNUNET_CADET_PeerPathDetail *ppd);
 
 
struct GNUNET_CADET_GetPath;
 
 
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);
 
 
void *
GNUNET_CADET_get_path_cancel (struct GNUNET_CADET_GetPath *gp);
 
 
struct GNUNET_CADET_TunnelDetails
{
  struct GNUNET_PeerIdentity peer;
 
  uint32_t channels;
 
  uint32_t connections;
 
  uint16_t estate;
 
  uint16_t cstate;
};
 
 
typedef void (*GNUNET_CADET_TunnelsCB) (
  void *cls,
  const struct GNUNET_CADET_TunnelDetails *td);
 
 
struct GNUNET_CADET_ListTunnels;
 
 
struct GNUNET_CADET_ListTunnels *
GNUNET_CADET_list_tunnels (const struct GNUNET_CONFIGURATION_Handle *cfg,
                           GNUNET_CADET_TunnelsCB callback,
                           void *callback_cls);
 
 
void *
GNUNET_CADET_list_tunnels_cancel (struct GNUNET_CADET_ListTunnels *lt);
 
 
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
 
/* ifndef GNUNET_CADET_SERVICE_H */
#endif
 /* end of group */
 /* end of group addition */
 
/* end of gnunet_cadet_service.h */