gnunet_transport_service.h

Go to the documentation of this file.

/*
     This file is part of GNUnet.
     Copyright (C) 2009-2016 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_TRANSPORT_SERVICE_H
#define GNUNET_TRANSPORT_SERVICE_H

#ifdef __cplusplus
extern "C" {
#if 0 /* keep Emacsens' auto-indent happy */
}
#endif
#endif

#include "gnunet_util_lib.h"
#include "gnunet_ats_service.h"

#define GNUNET_TRANSPORT_VERSION 0x00000003


/* *************************** HELLO *************************** */

struct GNUNET_TRANSPORT_OfferHelloHandle;


struct GNUNET_TRANSPORT_OfferHelloHandle *
GNUNET_TRANSPORT_offer_hello (const struct GNUNET_CONFIGURATION_Handle *cfg,
                              const struct GNUNET_MessageHeader *hello,
                              GNUNET_SCHEDULER_TaskCallback cont,
                              void *cont_cls);


void
GNUNET_TRANSPORT_offer_hello_cancel (
  struct GNUNET_TRANSPORT_OfferHelloHandle *ohh);


/* *********************** Address to String ******************* */

struct GNUNET_TRANSPORT_AddressToStringContext;


typedef void (*GNUNET_TRANSPORT_AddressToStringCallback) (void *cls,
                                                          const char *address,
                                                          int res);


struct GNUNET_TRANSPORT_AddressToStringContext *
GNUNET_TRANSPORT_address_to_string (
  const struct GNUNET_CONFIGURATION_Handle *cfg,
  const struct GNUNET_HELLO_Address *address,
  int numeric,
  struct GNUNET_TIME_Relative timeout,
  GNUNET_TRANSPORT_AddressToStringCallback aluc,
  void *aluc_cls);


void
GNUNET_TRANSPORT_address_to_string_cancel (
  struct GNUNET_TRANSPORT_AddressToStringContext *alc);


/* *********************** Monitoring ************************** */


enum GNUNET_TRANSPORT_PeerState
{
  GNUNET_TRANSPORT_PS_NOT_CONNECTED = 0,

  GNUNET_TRANSPORT_PS_INIT_ATS,

  GNUNET_TRANSPORT_PS_SYN_SENT,

  GNUNET_TRANSPORT_PS_SYN_RECV_ATS,

  GNUNET_TRANSPORT_PS_SYN_RECV_ACK,

  GNUNET_TRANSPORT_PS_CONNECTED,

  GNUNET_TRANSPORT_PS_RECONNECT_ATS,

  GNUNET_TRANSPORT_PS_RECONNECT_SENT,

  GNUNET_TRANSPORT_PS_SWITCH_SYN_SENT,

  GNUNET_TRANSPORT_PS_DISCONNECT,

  GNUNET_TRANSPORT_PS_DISCONNECT_FINISHED
};


const char *
GNUNET_TRANSPORT_ps2s (enum GNUNET_TRANSPORT_PeerState state);


int
GNUNET_TRANSPORT_is_connected (enum GNUNET_TRANSPORT_PeerState state);


struct GNUNET_TRANSPORT_PeerMonitoringContext;


typedef void (*GNUNET_TRANSPORT_PeerIterateCallback) (
  void *cls,
  const struct GNUNET_PeerIdentity *peer,
  const struct GNUNET_HELLO_Address *address,
  enum GNUNET_TRANSPORT_PeerState state,
  struct GNUNET_TIME_Absolute state_timeout);


struct GNUNET_TRANSPORT_PeerMonitoringContext *
GNUNET_TRANSPORT_monitor_peers (
  const struct GNUNET_CONFIGURATION_Handle *cfg,
  const struct GNUNET_PeerIdentity *peer,
  int one_shot,
  GNUNET_TRANSPORT_PeerIterateCallback peer_callback,
  void *peer_callback_cls);


void
GNUNET_TRANSPORT_monitor_peers_cancel (
  struct GNUNET_TRANSPORT_PeerMonitoringContext *pic);


/* *********************** Blacklisting ************************ */

struct GNUNET_TRANSPORT_Blacklist;


typedef int (*GNUNET_TRANSPORT_BlacklistCallback) (
  void *cls,
  const struct GNUNET_PeerIdentity *pid);


struct GNUNET_TRANSPORT_Blacklist *
GNUNET_TRANSPORT_blacklist (const struct GNUNET_CONFIGURATION_Handle *cfg,
                            GNUNET_TRANSPORT_BlacklistCallback cb,
                            void *cb_cls);


void
GNUNET_TRANSPORT_blacklist_cancel (struct GNUNET_TRANSPORT_Blacklist *br);


struct GNUNET_TRANSPORT_PluginMonitor;

struct GNUNET_TRANSPORT_PluginSession;


enum GNUNET_TRANSPORT_SessionState
{
  GNUNET_TRANSPORT_SS_INIT,

  GNUNET_TRANSPORT_SS_HANDSHAKE,

  GNUNET_TRANSPORT_SS_UP,

  GNUNET_TRANSPORT_SS_UPDATE,

  GNUNET_TRANSPORT_SS_DONE
};


struct GNUNET_TRANSPORT_SessionInfo
{
  enum GNUNET_TRANSPORT_SessionState state;

  int is_inbound;

  uint32_t num_msg_pending;

  uint32_t num_bytes_pending;

  struct GNUNET_TIME_Absolute receive_delay;

  struct GNUNET_TIME_Absolute session_timeout;

  const struct GNUNET_HELLO_Address *address;
};


typedef void (*GNUNET_TRANSPORT_SessionMonitorCallback) (
  void *cls,
  struct GNUNET_TRANSPORT_PluginSession *session,
  void **session_ctx,
  const struct GNUNET_TRANSPORT_SessionInfo *info);


struct GNUNET_TRANSPORT_PluginMonitor *
GNUNET_TRANSPORT_monitor_plugins (const struct GNUNET_CONFIGURATION_Handle *cfg,
                                  GNUNET_TRANSPORT_SessionMonitorCallback cb,
                                  void *cb_cls);


void
GNUNET_TRANSPORT_monitor_plugins_cancel (
  struct GNUNET_TRANSPORT_PluginMonitor *pm);


struct GNUNET_TRANSPORT_CoreHandle;


typedef void *(*GNUNET_TRANSPORT_NotifyConnect) (
  void *cls,
  const struct GNUNET_PeerIdentity *peer,
  struct GNUNET_MQ_Handle *mq);


typedef void (*GNUNET_TRANSPORT_NotifyDisconnect) (
  void *cls,
  const struct GNUNET_PeerIdentity *peer,
  void *handler_cls);


typedef void (*GNUNET_TRANSPORT_NotifyExcessBandwidth) (
  void *cls,
  const struct GNUNET_PeerIdentity *neighbour,
  void *handlers_cls);


struct GNUNET_TRANSPORT_CoreHandle *
GNUNET_TRANSPORT_core_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
                               const struct GNUNET_PeerIdentity *self,
                               const struct GNUNET_MQ_MessageHandler *handlers,
                               void *cls,
                               GNUNET_TRANSPORT_NotifyConnect nc,
                               GNUNET_TRANSPORT_NotifyDisconnect nd,
                               GNUNET_TRANSPORT_NotifyExcessBandwidth neb);


void
GNUNET_TRANSPORT_core_disconnect (struct GNUNET_TRANSPORT_CoreHandle *handle);


struct GNUNET_MQ_Handle *
GNUNET_TRANSPORT_core_get_mq (struct GNUNET_TRANSPORT_CoreHandle *handle,
                              const struct GNUNET_PeerIdentity *peer);


#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif

/* ifndef GNUNET_TRANSPORT_SERVICE_H */
#endif
 /* end of group */

/* end of gnunet_transport_service.h */