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_util_lib.h"
#include "gnunet_time_lib.h"
#include "gnunet_constants.h"
#include "gnunet_transport_monitor_service.h"
 
#define DEBUG_TRANSPORT GNUNET_EXTRA_LOGGING
 
 
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;
 
  // TODO remove
  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 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;
};
 
 
/* *********************** TNG messages ***************** */
 
struct GNUNET_TRANSPORT_CommunicatorAvailableMessage
{
  struct GNUNET_MessageHeader header;
 
  uint32_t cc;
 
  uint32_t can_burst;
 
  /* 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;
 
  struct GNUNET_PeerIdentity neighbour_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;
 
  uint32_t qid 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_StartBurst
{
  struct GNUNET_MessageHeader header;
 
  struct GNUNET_PeerIdentity pid;
 
  struct GNUNET_TIME_RelativeNBO rtt;
 
  /* followed by UTF-8 encoded, 0-terminated human-readable address */
};
 
struct GNUNET_TRANSPORT_BurstFinished
{
  struct GNUNET_MessageHeader header;
};
 
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_LinkListRequest
{
  struct GNUNET_MessageHeader header;
 
  uint32_t include_unconfirmed GNUNET_PACKED;
 
  struct GNUNET_PeerIdentity peer;
};
 
 
struct GNUNET_TRANSPORT_LinkListResponse
{
  struct GNUNET_MessageHeader header;
 
  struct GNUNET_PeerIdentity target;
 
  uint32_t confirmed GNUNET_PACKED;
 
  uint32_t route GNUNET_PACKED;
 
  uint32_t distance GNUNET_PACKED;
 
  uint32_t num_queues GNUNET_PACKED;
 
  int32_t core_recv_window GNUNET_PACKED;
 
  uint32_t stalled GNUNET_PACKED;
 
  uint32_t pending GNUNET_PACKED;
 
  uint32_t fc_retransmit_count GNUNET_PACKED;
 
  uint64_t available_fc_window_size GNUNET_PACKED;
 
  uint64_t incoming_fc_window_size_ram GNUNET_PACKED;
 
  uint64_t incoming_fc_window_size GNUNET_PACKED;
 
  uint64_t incoming_fc_window_size_used GNUNET_PACKED;
 
  int64_t incoming_fc_window_size_loss GNUNET_PACKED;
 
  uint64_t outbound_fc_window_size GNUNET_PACKED;
 
  uint64_t outbound_fc_window_size_used GNUNET_PACKED;
 
  struct GNUNET_TIME_RelativeNBO last_fc_rtt;
 
  struct GNUNET_TIME_RelativeNBO other_rtt;
 
  struct GNUNET_TIME_AbsoluteNBO last_fc_transmission;
 
  /* Followed by a 0-terminated, comma-separated list of the address
     prefixes of the communicators currently carrying this link ("tcp",
     "udp", ...).  For a DV link these are the communicators to the next
     hop of the shortest path, not to @e target.  May be empty. */
};
 
 
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 */
};
 
GNUNET_NETWORK_STRUCT_END
 
/* end of transport.h */
#endif