123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242 |
- /*
- 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
- */
- /**
- * @file transport/transport.h
- * @brief common internal definitions for transport service
- * @author Christian Grothoff
- */
- #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
- /**
- * For how long do we allow unused bandwidth
- * from the past to carry over into the future? (in seconds)
- */
- #define MAX_BANDWIDTH_CARRY_S GNUNET_CONSTANTS_MAX_BANDWIDTH_CARRY_S
- /**
- * How often do we (at most) do a full quota
- * recalculation? (in ms)
- */
- #define MIN_QUOTA_REFRESH_TIME 2000
- /**
- * What's the maximum number of sockets transport uses for validation and
- * neighbors
- */
- #define DEFAULT_MAX_FDS 256
- /**
- * Maximum frequency for re-evaluating latencies for all transport addresses.
- */
- #define LATENCY_EVALUATION_MAX_DELAY \
- GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_HOURS, 1)
- /**
- * Maximum frequency for re-evaluating latencies for connected addresses.
- */
- #define CONNECTED_LATENCY_EVALUATION_MAX_DELAY \
- GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_MINUTES, 1)
- /**
- * Similiar to GNUNET_TRANSPORT_NotifyDisconnect but in and out quotas are
- * included here. These values are not required outside transport_api
- *
- * @param cls closure
- * @param peer the peer that connected
- * @param bandwidth_in inbound bandwidth in NBO
- * @param bandwidth_out outbound bandwidth in NBO
- *
- */
- 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
- /**
- * Message from the transport service to the library
- * asking to check if both processes agree about this
- * peers identity.
- */
- struct StartMessage
- {
- /**
- * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_START
- */
- struct GNUNET_MessageHeader header;
- /**
- * 0: no options
- * 1: The @e self field should be checked
- * 2: this client is interested in payload traffic
- */
- uint32_t options;
- /**
- * Identity we think we have. If it does not match, the
- * receiver should print out an error message and disconnect.
- */
- struct GNUNET_PeerIdentity self;
- };
- /**
- * Message from the transport service to the library
- * informing about neighbors.
- */
- struct ConnectInfoMessage
- {
- /**
- * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT
- */
- struct GNUNET_MessageHeader header;
- #if (defined(GNUNET_TRANSPORT_COMMUNICATION_VERSION) || \
- defined(GNUNET_TRANSPORT_CORE_VERSION))
- /**
- * Always zero, for alignment.
- */
- uint32_t reserved GNUNET_PACKED;
- #else
- /**
- * Current outbound quota for this peer
- */
- struct GNUNET_BANDWIDTH_Value32NBO quota_out;
- #endif
- /**
- * Identity of the new neighbour.
- */
- struct GNUNET_PeerIdentity id;
- };
- /**
- * Message from the transport service to the library
- * informing about disconnects.
- */
- struct DisconnectInfoMessage
- {
- /**
- * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT
- */
- struct GNUNET_MessageHeader header;
- /**
- * Reserved, always zero.
- */
- uint32_t reserved GNUNET_PACKED;
- /**
- * Who got disconnected?
- */
- struct GNUNET_PeerIdentity peer;
- };
- /**
- * Message used to set a particular bandwidth quota. Sent TO the
- * service to set an incoming quota, sent FROM the service to update
- * an outgoing quota.
- *
- * NOTE: no longer used in TNG!
- */
- struct QuotaSetMessage
- {
- /**
- * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA
- */
- struct GNUNET_MessageHeader header;
- /**
- * Quota.
- */
- struct GNUNET_BANDWIDTH_Value32NBO quota;
- /**
- * About which peer are we talking here?
- */
- struct GNUNET_PeerIdentity peer;
- };
- /**
- * Message used to notify the transport API about a message
- * received from the network. The actual message follows.
- */
- struct InboundMessage
- {
- /**
- * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_RECV
- */
- struct GNUNET_MessageHeader header;
- /**
- * Which peer sent the message?
- */
- struct GNUNET_PeerIdentity peer;
- };
- /**
- * Message used to notify the transport API that it can
- * send another message to the transport service.
- */
- struct SendOkMessage
- {
- /**
- * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK
- */
- struct GNUNET_MessageHeader header;
- #if (defined(GNUNET_TRANSPORT_COMMUNICATION_VERSION) || \
- defined(GNUNET_TRANSPORT_CORE_VERSION))
- uint32_t reserved GNUNET_PACKED;
- #else
- /**
- * #GNUNET_OK if the transmission succeeded,
- * #GNUNET_SYSERR if it failed (i.e. network disconnect);
- * in either case, it is now OK for this client to
- * send us another message for the given peer.
- */
- uint16_t success GNUNET_PACKED;
- /**
- * Size of message sent
- */
- uint16_t bytes_msg GNUNET_PACKED;
- /**
- * Size of message sent over wire.
- * Includes plugin and protocol specific overheads.
- */
- uint32_t bytes_physical GNUNET_PACKED;
- #endif
- /**
- * Which peer can send more now?
- */
- struct GNUNET_PeerIdentity peer;
- };
- /**
- * Message used to notify the transport API that it can
- * send another message to the transport service.
- * (Used to implement flow control.)
- */
- struct RecvOkMessage
- {
- /**
- * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_RECV_OK
- */
- struct GNUNET_MessageHeader header;
- /**
- * Number of messages by which to increase the window, greater or
- * equal to one.
- */
- uint32_t increase_window_delta GNUNET_PACKED;
- /**
- * Which peer can CORE handle more from now?
- */
- struct GNUNET_PeerIdentity peer;
- };
- /**
- * Message used to notify the transport service about a message
- * to be transmitted to another peer. The actual message follows.
- */
- struct OutboundMessage
- {
- /**
- * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_SEND
- */
- struct GNUNET_MessageHeader header;
- /**
- * An `enum GNUNET_MQ_PriorityPreferences` in NBO.
- */
- uint32_t priority GNUNET_PACKED;
- #if ! (defined(GNUNET_TRANSPORT_COMMUNICATION_VERSION) || \
- defined(GNUNET_TRANSPORT_CORE_VERSION))
- /**
- * Allowed delay.
- */
- struct GNUNET_TIME_RelativeNBO timeout;
- #endif
- /**
- * Which peer should receive the message?
- */
- struct GNUNET_PeerIdentity peer;
- };
- #if ! (defined(GNUNET_TRANSPORT_COMMUNICATION_VERSION) || \
- defined(GNUNET_TRANSPORT_CORE_VERSION))
- /**
- * Message used to notify the transport API about an address to string
- * conversion. Message is followed by the string with the humand-readable
- * address. For each lookup, multiple results may be returned. The
- * last message must have a @e res of #GNUNET_OK and an @e addr_len
- * of zero.
- */
- struct AddressToStringResultMessage
- {
- /**
- * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING_REPLY
- */
- struct GNUNET_MessageHeader header;
- /**
- * #GNUNET_OK if the conversion succeeded,
- * #GNUNET_SYSERR if it failed
- */
- uint32_t res GNUNET_PACKED;
- /**
- * Length of the following string, zero if @e is #GNUNET_SYSERR
- */
- uint32_t addr_len GNUNET_PACKED;
- };
- /**
- * Message from the library to the transport service
- * asking for converting a transport address to a
- * human-readable UTF-8 string.
- */
- struct AddressLookupMessage
- {
- /**
- * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING
- */
- struct GNUNET_MessageHeader header;
- /**
- * Should the conversion use numeric IP addresses (otherwise
- * a reverse DNS lookup is OK -- if applicable).
- */
- int16_t numeric_only GNUNET_PACKED;
- /**
- * Length of the (binary) address in bytes, in big-endian.
- */
- uint16_t addrlen GNUNET_PACKED;
- /**
- * timeout to give up (for DNS resolution timeout mostly)
- */
- struct GNUNET_TIME_RelativeNBO timeout;
- /* followed by @e addrlen bytes of the actual address, then
- * followed by the 0-terminated name of the transport */
- };
- /**
- * Message from the transport service to the library containing information
- * about a peer. Information contained are:
- * - current address used to communicate with this peer
- * - state
- * - state timeout
- *
- * Memory layout:
- * [AddressIterateResponseMessage][address[addrlen]][transportname[pluginlen]]
- */
- struct ValidationIterateResponseMessage
- {
- /**
- * Type is #GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_VALIDATION_RESPONSE
- */
- struct GNUNET_MessageHeader header;
- /**
- * For alignment.
- */
- uint32_t reserved;
- /**
- * Peer identity
- */
- struct GNUNET_PeerIdentity peer;
- /**
- * Local info about the address
- */
- uint32_t local_address_info GNUNET_PACKED;
- /**
- * Address length
- */
- uint32_t addrlen GNUNET_PACKED;
- /**
- * Length of the plugin name
- */
- uint32_t pluginlen GNUNET_PACKED;
- /**
- * State
- */
- uint32_t state GNUNET_PACKED;
- /**
- * At what time did we successfully validate the address last.
- * Will be NEVER if the address failed validation.
- */
- struct GNUNET_TIME_AbsoluteNBO last_validation;
- /**
- * Until when is the address believed to be valid.
- * Will be ZERO if the address is not belived to be valid.
- */
- struct GNUNET_TIME_AbsoluteNBO valid_until;
- /**
- * When will we next try to validate the address (typically
- * done before @e valid_until happens).
- */
- struct GNUNET_TIME_AbsoluteNBO next_validation;
- };
- /**
- * Message from the library to the transport service
- * asking for binary addresses known for a peer.
- */
- struct ValidationMonitorMessage
- {
- /**
- * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_VALIDATION_REQUEST
- */
- struct GNUNET_MessageHeader header;
- /**
- * One shot call or continous replies?
- */
- uint32_t one_shot GNUNET_PACKED;
- /**
- * The identity of the peer to look up.
- */
- struct GNUNET_PeerIdentity peer;
- };
- /**
- * Message from the library to the transport service
- * asking for binary addresses known for a peer.
- */
- struct PeerMonitorMessage
- {
- /**
- * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PEER_REQUEST
- */
- struct GNUNET_MessageHeader header;
- /**
- * One shot call or continous replies?
- */
- uint32_t one_shot GNUNET_PACKED;
- /**
- * The identity of the peer to look up.
- */
- struct GNUNET_PeerIdentity peer;
- };
- /**
- * Message from the library to the transport service
- * asking for binary addresses known for a peer.
- */
- struct TrafficMetricMessage
- {
- /**
- * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_TRAFFIC_METRIC
- */
- struct GNUNET_MessageHeader header;
- /**
- * Always zero.
- */
- uint32_t reserved GNUNET_PACKED;
- /**
- * The identity of the peer to look up.
- */
- struct GNUNET_PeerIdentity peer;
- /**
- * Fake properties to generate.
- */
- struct GNUNET_ATS_PropertiesNBO properties;
- /**
- * Fake delay to add on inbound traffic.
- */
- struct GNUNET_TIME_RelativeNBO delay_in;
- /**
- * Fake delay to add on outbound traffic.
- */
- struct GNUNET_TIME_RelativeNBO delay_out;
- };
- /**
- * Message from the transport service to the library containing information
- * about a peer. Information contained are:
- * - current address used to communicate with this peer
- * - state
- * - state timeout
- *
- * Memory layout:
- * [AddressIterateResponseMessage][address[addrlen]][transportname[pluginlen]]
- */
- struct PeerIterateResponseMessage
- {
- /**
- * Type is #GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PEER_RESPONSE
- */
- struct GNUNET_MessageHeader header;
- /**
- * For alignment.
- */
- uint32_t reserved;
- /**
- * Peer identity
- */
- struct GNUNET_PeerIdentity peer;
- /**
- * Timeout for the state this peer is in
- */
- struct GNUNET_TIME_AbsoluteNBO state_timeout;
- /**
- * Local info about the address
- */
- uint32_t local_address_info GNUNET_PACKED;
- /**
- * State this peer is in as an `enum GNUNET_TRANSPORT_PeerState`
- */
- uint32_t state GNUNET_PACKED;
- /**
- * Address length
- */
- uint32_t addrlen GNUNET_PACKED;
- /**
- * Length of the plugin name
- */
- uint32_t pluginlen GNUNET_PACKED;
- };
- /**
- * Change in blacklisting (either request or notification,
- * depending on which direction it is going).
- */
- struct BlacklistMessage
- {
- /**
- * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_QUERY or
- * #GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_REPLY.
- */
- struct GNUNET_MessageHeader header;
- /**
- * 0 for the query, #GNUNET_OK (allowed) or #GNUNET_SYSERR (disallowed)
- * for the response.
- */
- uint32_t is_allowed GNUNET_PACKED;
- /**
- * Which peer is being blacklisted or queried?
- */
- struct GNUNET_PeerIdentity peer;
- };
- /**
- * Transport-level connection status update.
- */
- struct TransportPluginMonitorMessage
- {
- /**
- * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_PLUGIN_EVENT.
- */
- struct GNUNET_MessageHeader header;
- /**
- * An `enum GNUNET_TRANSPORT_SessionState` in NBO.
- */
- uint16_t session_state GNUNET_PACKED;
- /**
- * #GNUNET_YES if this is an inbound connection,
- * #GNUNET_NO if this is an outbound connection,
- * #GNUNET_SYSERR if connections of this plugin
- * are so fundamentally bidirectional
- * that they have no 'initiator'
- * Value given in NBO.
- */
- int16_t is_inbound GNUNET_PACKED;
- /**
- * Number of messages waiting transmission.
- */
- uint32_t msgs_pending GNUNET_PACKED;
- /**
- * Number of bytes waiting for transmission.
- */
- uint32_t bytes_pending GNUNET_PACKED;
- /**
- * When will this transport plugin session time out?
- */
- struct GNUNET_TIME_AbsoluteNBO timeout;
- /**
- * Until how long is this plugin currently blocked from reading?
- */
- struct GNUNET_TIME_AbsoluteNBO delay;
- /**
- * Which peer is this connection for?
- */
- struct GNUNET_PeerIdentity peer;
- /**
- * Unique identifier for the session.
- */
- uint64_t session_id;
- /**
- * Length of the plugin name in bytes, including 0-termination.
- */
- uint16_t plugin_name_len GNUNET_PACKED;
- /**
- * Length of the plugin address in bytes.
- */
- 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 ***************** */
- /**
- * Communicator goes online. Note which addresses it can
- * work with.
- */
- struct GNUNET_TRANSPORT_CommunicatorAvailableMessage
- {
- /**
- * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_NEW_COMMUNICATOR.
- */
- struct GNUNET_MessageHeader header;
- /**
- * NBO encoding of `enum GNUNET_TRANSPORT_CommunicatorCharacteristics`
- */
- uint32_t cc;
- /* Followed by the address prefix of the communicator */
- };
- /**
- * Add address to the list.
- */
- struct GNUNET_TRANSPORT_AddAddressMessage
- {
- /**
- * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_ADD_ADDRESS.
- */
- struct GNUNET_MessageHeader header;
- /**
- * Address identifier (used during deletion).
- */
- uint32_t aid GNUNET_PACKED;
- /**
- * When does the address expire?
- */
- struct GNUNET_TIME_RelativeNBO expiration;
- /**
- * An `enum GNUNET_NetworkType` in NBO.
- */
- uint32_t nt;
- /* followed by UTF-8 encoded, 0-terminated human-readable address */
- };
- /**
- * Remove address from the list.
- */
- struct GNUNET_TRANSPORT_DelAddressMessage
- {
- /**
- * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_DEL_ADDRESS.
- */
- struct GNUNET_MessageHeader header;
- /**
- * Address identifier.
- */
- uint32_t aid GNUNET_PACKED;
- };
- /**
- * Inform transport about an incoming message.
- */
- struct GNUNET_TRANSPORT_IncomingMessage
- {
- /**
- * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_INCOMING_MSG.
- */
- struct GNUNET_MessageHeader header;
- /**
- * Do we use flow control or not?
- */
- uint32_t fc_on GNUNET_PACKED;
- /**
- * 64-bit number to identify the matching ACK.
- */
- uint64_t fc_id GNUNET_PACKED;
- /**
- * How long does the communicator believe the address on which
- * the message was received to remain valid?
- */
- struct GNUNET_TIME_RelativeNBO expected_address_validity;
- /**
- * Sender identifier.
- */
- struct GNUNET_PeerIdentity sender;
- /* followed by the message */
- };
- /**
- * Transport informs us about being done with an incoming message.
- * (only sent if fc_on was set).
- */
- struct GNUNET_TRANSPORT_IncomingMessageAck
- {
- /**
- * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_INCOMING_MSG_ACK.
- */
- struct GNUNET_MessageHeader header;
- /**
- * Reserved (0)
- */
- uint32_t reserved GNUNET_PACKED;
- /**
- * Which message is being ACKed?
- */
- uint64_t fc_id GNUNET_PACKED;
- /**
- * Sender identifier of the original message.
- */
- struct GNUNET_PeerIdentity sender;
- };
- /**
- * Add queue to the transport
- */
- struct GNUNET_TRANSPORT_AddQueueMessage
- {
- /**
- * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_QUEUE_SETUP.
- */
- struct GNUNET_MessageHeader header;
- /**
- * Queue identifier (used to identify the queue).
- */
- uint32_t qid GNUNET_PACKED;
- /**
- * Receiver that can be addressed via the queue.
- */
- struct GNUNET_PeerIdentity receiver;
- /**
- * An `enum GNUNET_NetworkType` in NBO.
- */
- uint32_t nt;
- /**
- * Maximum transmission unit, in NBO. UINT32_MAX for unlimited.
- */
- uint32_t mtu;
- /**
- * Queue length, in NBO. Defines how many messages may be
- * send through this queue. UINT64_MAX for unlimited.
- */
- uint64_t q_len;
- /**
- * Priority of the queue in relation to other queues.
- */
- uint32_t priority;
- /**
- * An `enum GNUNET_TRANSPORT_ConnectionStatus` in NBO.
- */
- uint32_t cs;
- /* followed by UTF-8 encoded, 0-terminated human-readable address */
- };
- /**
- * Update queue
- */
- struct GNUNET_TRANSPORT_UpdateQueueMessage
- {
- /**
- * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_QUEUE_SETUP.
- */
- struct GNUNET_MessageHeader header;
- /**
- * Queue identifier (used to identify the queue).
- */
- uint32_t qid GNUNET_PACKED;
- /**
- * Receiver that can be addressed via the queue.
- */
- struct GNUNET_PeerIdentity receiver;
- /**
- * An `enum GNUNET_NetworkType` in NBO.
- */
- uint32_t nt;
- /**
- * Maximum transmission unit, in NBO. UINT32_MAX for unlimited.
- */
- uint32_t mtu;
- /**
- * Queue length, in NBO. Defines how many messages may be
- * send through this queue. UINT64_MAX for unlimited.
- */
- uint64_t q_len;
- /**
- * Priority of the queue in relation to other queues.
- */
- uint32_t priority;
- /**
- * An `enum GNUNET_TRANSPORT_ConnectionStatus` in NBO.
- */
- uint32_t cs;
- };
- /**
- * Remove queue, it is no longer available.
- */
- struct GNUNET_TRANSPORT_DelQueueMessage
- {
- /**
- * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_QUEUE_TEARDOWN.
- */
- struct GNUNET_MessageHeader header;
- /**
- * Address identifier.
- */
- uint32_t qid GNUNET_PACKED;
- /**
- * Receiver that can be addressed via the queue.
- */
- struct GNUNET_PeerIdentity receiver;
- };
- /**
- * Transport tells communicator that it wants a new queue.
- */
- struct GNUNET_TRANSPORT_CreateQueue
- {
- /**
- * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_QUEUE_CREATE.
- */
- struct GNUNET_MessageHeader header;
- /**
- * Unique ID for the request.
- */
- uint32_t request_id GNUNET_PACKED;
- /**
- * Receiver that can be addressed via the queue.
- */
- struct GNUNET_PeerIdentity receiver;
- /* followed by UTF-8 encoded, 0-terminated human-readable address */
- };
- /**
- * Communicator tells transport how queue creation went down.
- */
- struct GNUNET_TRANSPORT_CreateQueueResponse
- {
- /**
- * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_QUEUE_CREATE_OK or
- * #GNUNET_MESSAGE_TYPE_TRANSPORT_QUEUE_CREATE_FAIL.
- */
- struct GNUNET_MessageHeader header;
- /**
- * Unique ID for the request.
- */
- uint32_t request_id GNUNET_PACKED;
- };
- /**
- * Inform communicator about transport's desire to send a message.
- */
- struct GNUNET_TRANSPORT_SendMessageTo
- {
- /**
- * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_MSG.
- */
- struct GNUNET_MessageHeader header;
- /**
- * Which queue should we use?
- */
- uint32_t qid GNUNET_PACKED;
- /**
- * Message ID, used for flow control.
- */
- uint64_t mid GNUNET_PACKED;
- /**
- * Receiver identifier.
- */
- struct GNUNET_PeerIdentity receiver;
- /* followed by the message */
- };
- /**
- * Inform transport that message was sent.
- */
- struct GNUNET_TRANSPORT_SendMessageToAck
- {
- /**
- * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_MSG_ACK.
- */
- struct GNUNET_MessageHeader header;
- /**
- * Success (#GNUNET_OK), failure (#GNUNET_SYSERR).
- */
- uint32_t status GNUNET_PACKED;
- /**
- * Message ID of the original message.
- */
- uint64_t mid GNUNET_PACKED;
- /**
- * Receiver identifier.
- */
- struct GNUNET_PeerIdentity receiver;
- };
- /**
- * Message from communicator to transport service asking for
- * transmission of a backchannel message with the given peer @e pid
- * and communicator.
- */
- struct GNUNET_TRANSPORT_CommunicatorBackchannel
- {
- /**
- * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_COMMUNICATOR_BACKCHANNEL
- */
- struct GNUNET_MessageHeader header;
- /**
- * Always zero, for alignment.
- */
- uint32_t reserved;
- /**
- * Target peer.
- */
- 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 */
- };
- /**
- * Message from transport to communicator passing along a backchannel
- * message from the given peer @e pid.
- */
- struct GNUNET_TRANSPORT_CommunicatorBackchannelIncoming
- {
- /**
- * Type will be
- * #GNUNET_MESSAGE_TYPE_TRANSPORT_COMMUNICATOR_BACKCHANNEL_INCOMING
- */
- struct GNUNET_MessageHeader header;
- /**
- * Always zero, for alignment.
- */
- uint32_t reserved;
- /**
- * Origin peer.
- */
- struct GNUNET_PeerIdentity pid;
- /* Followed by a `struct GNUNET_MessageHeader` with the encapsulated
- message to the communicator */
- };
- /**
- * Request to start monitoring.
- */
- struct GNUNET_TRANSPORT_MonitorStart
- {
- /**
- * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_START.
- */
- struct GNUNET_MessageHeader header;
- /**
- * #GNUNET_YES for one-shot montoring, #GNUNET_NO for continuous monitoring.
- */
- uint32_t one_shot;
- /**
- * Target identifier to monitor, all zeros for "all peers".
- */
- struct GNUNET_PeerIdentity peer;
- };
- /**
- * Monitoring data.
- */
- struct GNUNET_TRANSPORT_MonitorData
- {
- /**
- * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_MONITOR_DATA.
- */
- struct GNUNET_MessageHeader header;
- /**
- * Network type (an `enum GNUNET_NetworkType` in NBO).
- */
- uint32_t nt GNUNET_PACKED;
- /**
- * Target identifier.
- */
- struct GNUNET_PeerIdentity peer;
- /**
- * @deprecated To be discussed if we keep these...
- */
- struct GNUNET_TIME_AbsoluteNBO last_validation;
- struct GNUNET_TIME_AbsoluteNBO valid_until;
- struct GNUNET_TIME_AbsoluteNBO next_validation;
- /**
- * Current round-trip time estimate.
- */
- struct GNUNET_TIME_RelativeNBO rtt;
- /**
- * Connection status (in NBO).
- */
- uint32_t cs GNUNET_PACKED;
- /**
- * Messages pending (in NBO).
- */
- uint32_t num_msg_pending GNUNET_PACKED;
- /**
- * Bytes pending (in NBO).
- */
- uint32_t num_bytes_pending GNUNET_PACKED;
- /* Followed by 0-terminated address of the peer */
- };
- /**
- * Request to verify address.
- */
- struct GNUNET_TRANSPORT_AddressToVerify
- {
- /**
- * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_CONSIDER_VERIFY.
- */
- struct GNUNET_MessageHeader header;
- /**
- * Reserved. 0.
- */
- uint32_t reserved;
- /**
- * Peer the address is from.
- */
- struct GNUNET_PeerIdentity peer;
- /* followed by variable-size raw address */
- };
- /**
- * Application client to TRANSPORT service: we would like to have
- * address suggestions for this peer.
- */
- struct ExpressPreferenceMessage
- {
- /**
- * Type is #GNUNET_MESSAGE_TYPE_TRANSPORT_SUGGEST or
- * #GNUNET_MESSAGE_TYPE_TRANSPORT_SUGGEST_CANCEL to stop
- * suggestions.
- */
- struct GNUNET_MessageHeader header;
- /**
- * What type of performance preference does the client have?
- * A `enum GNUNET_MQ_PreferenceKind` in NBO.
- */
- uint32_t pk GNUNET_PACKED;
- /**
- * Peer to get address suggestions for.
- */
- struct GNUNET_PeerIdentity peer;
- /**
- * How much bandwidth in bytes/second does the application expect?
- */
- struct GNUNET_BANDWIDTH_Value32NBO bw;
- };
- /**
- * We got an address of another peer, TRANSPORT service
- * should validate it. There is no response.
- */
- struct RequestHelloValidationMessage
- {
- /**
- * Type is #GNUNET_MESSAGE_TYPE_TRANSPORT_REQUEST_HELLO_VALIDATION.
- */
- struct GNUNET_MessageHeader header;
- /**
- * What type of network does the other peer claim this is?
- * A `enum GNUNET_NetworkType` in NBO.
- */
- uint32_t nt GNUNET_PACKED;
- /**
- * Peer to the address is presumably for.
- */
- struct GNUNET_PeerIdentity peer;
- /* followed by 0-terminated address to validate */
- };
- #endif
- GNUNET_NETWORK_STRUCT_END
- /* end of transport.h */
- #endif
|