gnunet_transport_communication_service.h

Go to the documentation of this file.

/*
     This file is part of GNUnet.
     Copyright (C) 2009-2019 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_COMMUNICATION_SERVICE_H
#define GNUNET_TRANSPORT_COMMUNICATION_SERVICE_H
 
#ifdef __cplusplus
extern "C" {
#if 0 /* keep Emacsens' auto-indent happy */
}
#endif
#endif
 
 
#include "gnunet_util_lib.h"
 
#define GNUNET_TRANSPORT_COMMUNICATION_VERSION 0x00000000
 
#define GNUNET_TRANSPORT_QUEUE_LENGTH_UNLIMITED UINT64_MAX
 
typedef int (*GNUNET_TRANSPORT_CommunicatorMqInit) (
  void *cls,
  const struct GNUNET_PeerIdentity *peer,
  const char *address);
 
 
struct GNUNET_TRANSPORT_CommunicatorHandle;
 
 
enum GNUNET_TRANSPORT_CommunicatorCharacteristics
{
  GNUNET_TRANSPORT_CC_UNKNOWN = 0,
 
  GNUNET_TRANSPORT_CC_RELIABLE = 1,
 
  GNUNET_TRANSPORT_CC_UNRELIABLE = 2
};
 
 
typedef void (*GNUNET_TRANSPORT_CommunicatorNotify) (
  void *cls,
  const struct GNUNET_PeerIdentity *sender,
  const struct GNUNET_MessageHeader *msg);
 
 
typedef void (*GNUNET_TRANSPORT_StartBurstNotify) (const char *address,
                                                   struct GNUNET_TIME_Relative rtt,
                                                   struct GNUNET_PeerIdentity *peer);
 
struct GNUNET_TRANSPORT_CommunicatorHandle *
GNUNET_TRANSPORT_communicator_connect (
  const struct GNUNET_CONFIGURATION_Handle *cfg,
  const char *config_section_name,
  const char *addr_prefix,
  enum GNUNET_TRANSPORT_CommunicatorCharacteristics cc,
  GNUNET_TRANSPORT_CommunicatorMqInit mq_init,
  void *mq_init_cls,
  GNUNET_TRANSPORT_CommunicatorNotify notify_cb,
  void *notify_cb_cls,
  GNUNET_TRANSPORT_StartBurstNotify sb);
 
 
void
GNUNET_TRANSPORT_communicator_disconnect (
  struct GNUNET_TRANSPORT_CommunicatorHandle *ch);
 
 
/* ************************* Receiving *************************** */
 
typedef void
(*GNUNET_TRANSPORT_MessageCompletedCallback) (void *cls,
                                              int success);
 
 
int
GNUNET_TRANSPORT_communicator_receive (
  struct GNUNET_TRANSPORT_CommunicatorHandle *handle,
  const struct GNUNET_PeerIdentity *sender,
  const struct GNUNET_MessageHeader *msg,
  struct GNUNET_TIME_Relative expected_addr_validity,
  GNUNET_TRANSPORT_MessageCompletedCallback cb,
  void *cb_cls);
 
 
void
GNUNET_TRANSPORT_communicator_burst_finished (struct GNUNET_TRANSPORT_CommunicatorHandle *ch);
 
/* ************************* Discovery *************************** */
 
struct GNUNET_TRANSPORT_QueueHandle;
 
 
enum GNUNET_TRANSPORT_ConnectionStatus
{
  GNUNET_TRANSPORT_CS_DOWN = -1,
 
  GNUNET_TRANSPORT_CS_OUTBOUND = 0,
 
  GNUNET_TRANSPORT_CS_INBOUND = 1
};
 
 
struct GNUNET_TRANSPORT_QueueHandle *
GNUNET_TRANSPORT_communicator_mq_add (
  struct GNUNET_TRANSPORT_CommunicatorHandle *ch,
  const struct GNUNET_PeerIdentity *peer,
  const char *address,
  uint32_t mtu,
  uint64_t q_len,
  uint32_t priority,
  enum GNUNET_NetworkType nt,
  enum GNUNET_TRANSPORT_ConnectionStatus cs,
  struct GNUNET_MQ_Handle *mq);
 
void
GNUNET_TRANSPORT_communicator_mq_update (
  struct GNUNET_TRANSPORT_CommunicatorHandle *ch,
  const struct GNUNET_TRANSPORT_QueueHandle *u_qh,
  uint64_t q_len,
  uint32_t priority);
 
void
GNUNET_TRANSPORT_communicator_mq_del (struct GNUNET_TRANSPORT_QueueHandle *qh);
 
 
struct GNUNET_TRANSPORT_AddressIdentifier;
 
 
struct GNUNET_TRANSPORT_AddressIdentifier *
GNUNET_TRANSPORT_communicator_address_add (
  struct GNUNET_TRANSPORT_CommunicatorHandle *ch,
  const char *address,
  enum GNUNET_NetworkType nt,
  struct GNUNET_TIME_Relative expiration);
 
 
void
GNUNET_TRANSPORT_communicator_address_remove (
  struct GNUNET_TRANSPORT_AddressIdentifier *ai);
 
void
GNUNET_TRANSPORT_communicator_address_remove_all (
                                                  struct GNUNET_TRANSPORT_CommunicatorHandle *ch);
 
void
GNUNET_TRANSPORT_communicator_notify (
  struct GNUNET_TRANSPORT_CommunicatorHandle *ch,
  const struct GNUNET_PeerIdentity *pid,
  const char *comm,
  const struct GNUNET_MessageHeader *header);
 
 
#if 0 /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
 
/* ifndef GNUNET_TRANSPORT_COMMUNICATOR_SERVICE_H */
#endif
 /* end of group */
 /* end of group addition */
 
/* end of gnunet_transport_communicator_service.h */