gnunet_transport_plugin.h

Go to the documentation of this file.

/*
     This file is part of GNUnet
     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 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 PLUGIN_TRANSPORT_H
#define PLUGIN_TRANSPORT_H
 
 
#include "gnunet_configuration_lib.h"
#include "gnunet_scheduler_lib.h"
#include "gnunet_statistics_service.h"
#include "gnunet_transport_service.h"
#include "gnunet_ats_service.h"
 
#define TRANSPORT_SESSION_INBOUND_STRING "<inbound>"
 
struct GNUNET_ATS_Session;
 
 
typedef void
(*GNUNET_TRANSPORT_SessionEnd) (void *cls,
                                const struct GNUNET_HELLO_Address *address,
                                struct GNUNET_ATS_Session *session);
 
 
typedef void
(*GNUNET_TRANSPORT_SessionStart) (void *cls,
                                  const struct GNUNET_HELLO_Address *address,
                                  struct GNUNET_ATS_Session *session,
                                  enum GNUNET_NetworkType net);
 
 
typedef struct GNUNET_TIME_Relative
(*GNUNET_TRANSPORT_PluginReceiveCallback) (void *cls,
                                           const struct
                                           GNUNET_HELLO_Address *address,
                                           struct GNUNET_ATS_Session *session,
                                           const struct
                                           GNUNET_MessageHeader *message);
 
 
typedef enum GNUNET_NetworkType
(*GNUNET_TRANSPORT_AddressToType)(void *cls,
                                  const struct sockaddr *addr,
                                  size_t addrlen);
 
 
typedef void
(*GNUNET_TRANSPORT_UpdateAddressDistance) (void *cls,
                                           const struct
                                           GNUNET_HELLO_Address *address,
                                           uint32_t distance);
 
 
typedef void
(*GNUNET_TRANSPORT_AddressNotification) (void *cls,
                                         int add_remove,
                                         const struct
                                         GNUNET_HELLO_Address *address);
 
 
typedef struct GNUNET_TIME_Relative
(*GNUNET_TRANSPORT_TrafficReport) (void *cls,
                                   const struct GNUNET_PeerIdentity *peer,
                                   size_t amount_recved);
 
 
typedef const struct GNUNET_MessageHeader *
(*GNUNET_TRANSPORT_GetHelloCallback) (void);
 
 
struct GNUNET_TRANSPORT_PluginEnvironment
{
  const struct GNUNET_CONFIGURATION_Handle *cfg;
 
  const struct GNUNET_PeerIdentity *my_identity;
 
  void *cls;
 
  struct GNUNET_STATISTICS_Handle *stats;
 
  GNUNET_TRANSPORT_PluginReceiveCallback receive;
 
  GNUNET_TRANSPORT_GetHelloCallback get_our_hello;
 
  GNUNET_TRANSPORT_AddressNotification notify_address;
 
  GNUNET_TRANSPORT_SessionEnd session_end;
 
  GNUNET_TRANSPORT_SessionStart session_start;
 
  GNUNET_TRANSPORT_AddressToType get_address_type;
 
  GNUNET_TRANSPORT_UpdateAddressDistance update_address_distance;
 
  uint32_t max_connections;
};
 
 
typedef void
(*GNUNET_TRANSPORT_TransmitContinuation) (void *cls,
                                          const struct
                                          GNUNET_PeerIdentity *target,
                                          int result,
                                          size_t size_payload,
                                          size_t size_on_wire);
 
 
typedef ssize_t
(*GNUNET_TRANSPORT_TransmitFunction) (void *cls,
                                      struct GNUNET_ATS_Session *session,
                                      const char *msgbuf,
                                      size_t msgbuf_size,
                                      unsigned int priority,
                                      struct GNUNET_TIME_Relative to,
                                      GNUNET_TRANSPORT_TransmitContinuation cont,
                                      void *cont_cls);
 
 
typedef int
(*GNUNET_TRANSPORT_DisconnectSessionFunction) (void *cls,
                                               struct GNUNET_ATS_Session *
                                               session);
 
 
typedef unsigned int
(*GNUNET_TRANSPORT_QueryKeepaliveFactorFunction) (void *cls);
 
 
typedef void
(*GNUNET_TRANSPORT_DisconnectPeerFunction) (void *cls,
                                            const struct
                                            GNUNET_PeerIdentity *target);
 
 
typedef void
(*GNUNET_TRANSPORT_AddressStringCallback) (void *cls,
                                           const char *address,
                                           int res);
 
 
typedef void
(*GNUNET_TRANSPORT_AddressPrettyPrinter) (void *cls,
                                          const char *type,
                                          const void *addr,
                                          size_t addrlen,
                                          int numeric,
                                          struct GNUNET_TIME_Relative timeout,
                                          GNUNET_TRANSPORT_AddressStringCallback
                                          asc,
                                          void *asc_cls);
 
 
typedef int
(*GNUNET_TRANSPORT_CheckAddress) (void *cls,
                                  const void *addr,
                                  size_t addrlen);
 
 
typedef struct GNUNET_ATS_Session *
(*GNUNET_TRANSPORT_CreateSession) (void *cls,
                                   const struct GNUNET_HELLO_Address *address);
 
 
typedef void
(*GNUNET_TRANSPORT_UpdateSessionTimeout) (void *cls,
                                          const struct
                                          GNUNET_PeerIdentity *peer,
                                          struct GNUNET_ATS_Session *session);
 
 
typedef void
(*GNUNET_TRANSPORT_UpdateInboundDelay) (void *cls,
                                        const struct GNUNET_PeerIdentity *peer,
                                        struct GNUNET_ATS_Session *session,
                                        struct GNUNET_TIME_Relative delay);
 
 
typedef const char *
(*GNUNET_TRANSPORT_AddressToString) (void *cls,
                                     const void *addr,
                                     size_t addrlen);
 
 
typedef int
(*GNUNET_TRANSPORT_StringToAddress) (void *cls,
                                     const char *addr,
                                     uint16_t addrlen,
                                     void **buf,
                                     size_t *added);
 
 
typedef enum GNUNET_NetworkType
(*GNUNET_TRANSPORT_GetNetworkType)(void *cls,
                                   struct GNUNET_ATS_Session *session);
 
 
typedef enum GNUNET_NetworkType
(*GNUNET_TRANSPORT_GetNetworkTypeForAddress)(void *cls,
                                             const struct
                                             GNUNET_HELLO_Address *address);
 
 
typedef void
(*GNUNET_TRANSPORT_SessionInfoCallback) (void *cls,
                                         struct GNUNET_ATS_Session *session,
                                         const struct
                                         GNUNET_TRANSPORT_SessionInfo *info);
 
 
typedef void
(*GNUNET_TRANSPORT_SessionMonitorSetup) (void *cls,
                                         GNUNET_TRANSPORT_SessionInfoCallback
                                         sic,
                                         void *sic_cls);
 
 
struct GNUNET_TRANSPORT_PluginFunctions
{
  void *cls;
 
  GNUNET_TRANSPORT_TransmitFunction send;
 
  GNUNET_TRANSPORT_DisconnectPeerFunction disconnect_peer;
 
  GNUNET_TRANSPORT_DisconnectSessionFunction disconnect_session;
 
  GNUNET_TRANSPORT_UpdateSessionTimeout update_session_timeout;
 
  GNUNET_TRANSPORT_UpdateInboundDelay update_inbound_delay;
 
  GNUNET_TRANSPORT_QueryKeepaliveFactorFunction query_keepalive_factor;
 
  GNUNET_TRANSPORT_AddressPrettyPrinter address_pretty_printer;
 
  GNUNET_TRANSPORT_CheckAddress check_address;
 
  GNUNET_TRANSPORT_AddressToString address_to_string;
 
  GNUNET_TRANSPORT_StringToAddress string_to_address;
 
  GNUNET_TRANSPORT_CreateSession get_session;
 
  GNUNET_TRANSPORT_GetNetworkType get_network;
 
  GNUNET_TRANSPORT_GetNetworkTypeForAddress get_network_for_address;
 
  GNUNET_TRANSPORT_SessionMonitorSetup setup_monitor;
};
 
 
/*#ifndef PLUGIN_TRANSPORT_H*/
#endif
  /* end of group */
 /* end of group addition */
 
/* end of gnunet_transport_plugin.h */