transport.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 TRANSPORT_H
#define TRANSPORT_H

#include "gnunet_crypto_lib.h"
#include "gnunet_time_lib.h"
#include "gnunet_constants.h"

#define DEBUG_TRANSPORT GNUNET_EXTRA_LOGGING


#define MAX_BANDWIDTH_CARRY_S GNUNET_CONSTANTS_MAX_BANDWIDTH_CARRY_S

#define MIN_QUOTA_REFRESH_TIME 2000

#define DEFAULT_MAX_FDS 256

#define LATENCY_EVALUATION_MAX_DELAY \
  GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_HOURS, 1)

#define CONNECTED_LATENCY_EVALUATION_MAX_DELAY \
  GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 1)

typedef void (*NotifyConnect) (
  void *cls,
  const struct GNUNET_PeerIdentity *peer,
  struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
  struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out);


GNUNET_NETWORK_STRUCT_BEGIN


struct StartMessage
{
  struct GNUNET_MessageHeader header;

  uint32_t options;

  struct GNUNET_PeerIdentity self;
};


struct ConnectInfoMessage
{
  struct GNUNET_MessageHeader header;

#if (defined(GNUNET_TRANSPORT_COMMUNICATION_VERSION) || \
  defined(GNUNET_TRANSPORT_CORE_VERSION))

  uint32_t reserved GNUNET_PACKED;
#else

  struct GNUNET_BANDWIDTH_Value32NBO quota_out;
#endif

  struct GNUNET_PeerIdentity id;
};


struct DisconnectInfoMessage
{
  struct GNUNET_MessageHeader header;

  uint32_t reserved GNUNET_PACKED;

  struct GNUNET_PeerIdentity peer;
};


struct QuotaSetMessage
{
  struct GNUNET_MessageHeader header;

  struct GNUNET_BANDWIDTH_Value32NBO quota;

  struct GNUNET_PeerIdentity peer;
};


struct InboundMessage
{
  struct GNUNET_MessageHeader header;

  struct GNUNET_PeerIdentity peer;
};


struct SendOkMessage
{
  struct GNUNET_MessageHeader header;

#if (defined(GNUNET_TRANSPORT_COMMUNICATION_VERSION) || \
  defined(GNUNET_TRANSPORT_CORE_VERSION))

  uint32_t reserved GNUNET_PACKED;
#else

  uint16_t success GNUNET_PACKED;

  uint16_t bytes_msg GNUNET_PACKED;

  uint32_t bytes_physical GNUNET_PACKED;
#endif

  struct GNUNET_PeerIdentity peer;
};


struct RecvOkMessage
{
  struct GNUNET_MessageHeader header;

  uint32_t increase_window_delta GNUNET_PACKED;

  struct GNUNET_PeerIdentity peer;
};


struct OutboundMessage
{
  struct GNUNET_MessageHeader header;

  uint32_t priority GNUNET_PACKED;

#if ! (defined(GNUNET_TRANSPORT_COMMUNICATION_VERSION) || \
  defined(GNUNET_TRANSPORT_CORE_VERSION))

  struct GNUNET_TIME_RelativeNBO timeout;
#endif

  struct GNUNET_PeerIdentity peer;
};


#if ! (defined(GNUNET_TRANSPORT_COMMUNICATION_VERSION) || \
  defined(GNUNET_TRANSPORT_CORE_VERSION))


struct AddressToStringResultMessage
{
  struct GNUNET_MessageHeader header;

  uint32_t res GNUNET_PACKED;

  uint32_t addr_len GNUNET_PACKED;
};


struct AddressLookupMessage
{
  struct GNUNET_MessageHeader header;

  int16_t numeric_only GNUNET_PACKED;

  uint16_t addrlen GNUNET_PACKED;

  struct GNUNET_TIME_RelativeNBO timeout;

  /* followed by @e addrlen bytes of the actual address, then
   * followed by the 0-terminated name of the transport */
};


struct ValidationIterateResponseMessage
{
  struct GNUNET_MessageHeader header;

  uint32_t reserved;

  struct GNUNET_PeerIdentity peer;

  uint32_t local_address_info GNUNET_PACKED;

  uint32_t addrlen GNUNET_PACKED;

  uint32_t pluginlen GNUNET_PACKED;

  uint32_t state GNUNET_PACKED;

  struct GNUNET_TIME_AbsoluteNBO last_validation;

  struct GNUNET_TIME_AbsoluteNBO valid_until;

  struct GNUNET_TIME_AbsoluteNBO next_validation;
};


struct ValidationMonitorMessage
{
  struct GNUNET_MessageHeader header;

  uint32_t one_shot GNUNET_PACKED;

  struct GNUNET_PeerIdentity peer;
};


struct PeerMonitorMessage
{
  struct GNUNET_MessageHeader header;

  uint32_t one_shot GNUNET_PACKED;

  struct GNUNET_PeerIdentity peer;
};


struct TrafficMetricMessage
{
  struct GNUNET_MessageHeader header;

  uint32_t reserved GNUNET_PACKED;

  struct GNUNET_PeerIdentity peer;

  struct GNUNET_ATS_PropertiesNBO properties;

  struct GNUNET_TIME_RelativeNBO delay_in;

  struct GNUNET_TIME_RelativeNBO delay_out;
};


struct PeerIterateResponseMessage
{
  struct GNUNET_MessageHeader header;

  uint32_t reserved;

  struct GNUNET_PeerIdentity peer;

  struct GNUNET_TIME_AbsoluteNBO state_timeout;

  uint32_t local_address_info GNUNET_PACKED;

  uint32_t state GNUNET_PACKED;

  uint32_t addrlen GNUNET_PACKED;

  uint32_t pluginlen GNUNET_PACKED;
};


struct BlacklistMessage
{
  struct GNUNET_MessageHeader header;

  uint32_t is_allowed GNUNET_PACKED;

  struct GNUNET_PeerIdentity peer;
};


struct TransportPluginMonitorMessage
{
  struct GNUNET_MessageHeader header;

  uint16_t session_state GNUNET_PACKED;

  int16_t is_inbound GNUNET_PACKED;

  uint32_t msgs_pending GNUNET_PACKED;

  uint32_t bytes_pending GNUNET_PACKED;

  struct GNUNET_TIME_AbsoluteNBO timeout;

  struct GNUNET_TIME_AbsoluteNBO delay;

  struct GNUNET_PeerIdentity peer;

  uint64_t session_id;

  uint16_t plugin_name_len GNUNET_PACKED;

  uint16_t plugin_address_len GNUNET_PACKED;

  /* followed by 0-terminated plugin name and
     @e plugin_address_len bytes of plugin address */
};

#else

/* *********************** TNG messages ***************** */

struct GNUNET_TRANSPORT_CommunicatorAvailableMessage
{
  struct GNUNET_MessageHeader header;

  uint32_t cc;

  /* Followed by the address prefix of the communicator */
};


struct GNUNET_TRANSPORT_AddAddressMessage
{
  struct GNUNET_MessageHeader header;

  uint32_t aid GNUNET_PACKED;

  struct GNUNET_TIME_RelativeNBO expiration;

  uint32_t nt;

  /* followed by UTF-8 encoded, 0-terminated human-readable address */
};


struct GNUNET_TRANSPORT_DelAddressMessage
{
  struct GNUNET_MessageHeader header;

  uint32_t aid GNUNET_PACKED;
};


struct GNUNET_TRANSPORT_IncomingMessage
{
  struct GNUNET_MessageHeader header;

  uint32_t fc_on GNUNET_PACKED;

  uint64_t fc_id GNUNET_PACKED;

  struct GNUNET_TIME_RelativeNBO expected_address_validity;

  struct GNUNET_PeerIdentity sender;

  /* followed by the message */
};


struct GNUNET_TRANSPORT_IncomingMessageAck
{
  struct GNUNET_MessageHeader header;

  uint32_t reserved GNUNET_PACKED;

  uint64_t fc_id GNUNET_PACKED;

  struct GNUNET_PeerIdentity sender;
};


struct GNUNET_TRANSPORT_AddQueueMessage
{
  struct GNUNET_MessageHeader header;

  uint32_t qid GNUNET_PACKED;

  struct GNUNET_PeerIdentity receiver;

  uint32_t nt;

  uint32_t mtu;

  uint64_t q_len;

  uint32_t priority;

  uint32_t cs;

  /* followed by UTF-8 encoded, 0-terminated human-readable address */
};


struct GNUNET_TRANSPORT_UpdateQueueMessage
{
  struct GNUNET_MessageHeader header;

  uint32_t qid GNUNET_PACKED;

  struct GNUNET_PeerIdentity receiver;

  uint32_t nt;

  uint32_t mtu;

  uint64_t q_len;

  uint32_t priority;

  uint32_t cs;
};


struct GNUNET_TRANSPORT_DelQueueMessage
{
  struct GNUNET_MessageHeader header;

  uint32_t qid GNUNET_PACKED;

  struct GNUNET_PeerIdentity receiver;
};


struct GNUNET_TRANSPORT_CreateQueue
{
  struct GNUNET_MessageHeader header;

  uint32_t request_id GNUNET_PACKED;

  struct GNUNET_PeerIdentity receiver;

  /* followed by UTF-8 encoded, 0-terminated human-readable address */
};


struct GNUNET_TRANSPORT_CreateQueueResponse
{
  struct GNUNET_MessageHeader header;

  uint32_t request_id GNUNET_PACKED;
};


struct GNUNET_TRANSPORT_SendMessageTo
{
  struct GNUNET_MessageHeader header;

  uint32_t qid GNUNET_PACKED;

  uint64_t mid GNUNET_PACKED;

  struct GNUNET_PeerIdentity receiver;

  /* followed by the message */
};


struct GNUNET_TRANSPORT_SendMessageToAck
{
  struct GNUNET_MessageHeader header;

  uint32_t status GNUNET_PACKED;

  uint64_t mid GNUNET_PACKED;

  struct GNUNET_PeerIdentity receiver;
};


struct GNUNET_TRANSPORT_CommunicatorBackchannel
{
  struct GNUNET_MessageHeader header;

  uint32_t reserved;

  struct GNUNET_PeerIdentity pid;

  /* Followed by a `struct GNUNET_MessageHeader` with the encapsulated
     message to the communicator */

  /* Followed by the 0-terminated string specifying the desired
     communicator at the target (@e pid) peer */
};


struct GNUNET_TRANSPORT_CommunicatorBackchannelIncoming
{
  struct GNUNET_MessageHeader header;

  uint32_t reserved;

  struct GNUNET_PeerIdentity pid;

  /* Followed by a `struct GNUNET_MessageHeader` with the encapsulated
     message to the communicator */
};


struct GNUNET_TRANSPORT_MonitorStart
{
  struct GNUNET_MessageHeader header;

  uint32_t one_shot;

  struct GNUNET_PeerIdentity peer;
};


struct GNUNET_TRANSPORT_MonitorData
{
  struct GNUNET_MessageHeader header;

  uint32_t nt GNUNET_PACKED;

  struct GNUNET_PeerIdentity peer;

  struct GNUNET_TIME_AbsoluteNBO last_validation;
  struct GNUNET_TIME_AbsoluteNBO valid_until;
  struct GNUNET_TIME_AbsoluteNBO next_validation;

  struct GNUNET_TIME_RelativeNBO rtt;

  uint32_t cs GNUNET_PACKED;

  uint32_t num_msg_pending GNUNET_PACKED;

  uint32_t num_bytes_pending GNUNET_PACKED;

  /* Followed by 0-terminated address of the peer */
};


struct GNUNET_TRANSPORT_AddressToVerify
{
  struct GNUNET_MessageHeader header;

  uint32_t reserved;

  struct GNUNET_PeerIdentity peer;

  /* followed by variable-size raw address */
};


struct ExpressPreferenceMessage
{
  struct GNUNET_MessageHeader header;

  uint32_t pk GNUNET_PACKED;

  struct GNUNET_PeerIdentity peer;

  struct GNUNET_BANDWIDTH_Value32NBO bw;
};


struct RequestHelloValidationMessage
{
  struct GNUNET_MessageHeader header;

  uint32_t nt GNUNET_PACKED;

  struct GNUNET_PeerIdentity peer;

  /* followed by 0-terminated address to validate */
};

#endif

GNUNET_NETWORK_STRUCT_END

/* end of transport.h */
#endif