/*
This file is part of GNUnet.
- (C) 2009 Christian Grothoff (and other contributing authors)
+ (C) 2009-2014 Christian Grothoff (and other contributing authors)
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
* @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);
-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
{
/**
- * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_START
+ * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_START
*/
struct GNUNET_MessageHeader header;
{
/**
- * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT
+ * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_CONNECT
*/
struct GNUNET_MessageHeader header;
{
/**
- * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT
+ * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_DISCONNECT
*/
struct GNUNET_MessageHeader header;
struct GNUNET_MessageHeader header;
/**
- * Connect (GNUNET_YES) or connect (GNUNET_NO).
+ * Connect (#GNUNET_YES) or connect (#GNUNET_NO).
*/
uint32_t connect;
{
/**
- * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA
+ * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_SET_QUOTA
*/
struct GNUNET_MessageHeader header;
{
/**
- * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_RECV
+ * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_RECV
*/
struct GNUNET_MessageHeader header;
{
/**
- * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK
+ * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_SEND_OK
*/
struct GNUNET_MessageHeader header;
/**
- * GNUNET_OK if the transmission succeeded,
- * GNUNET_SYSERR if it failed (i.e. network disconnect);
+ * #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.
*/
uint32_t success GNUNET_PACKED;
-
/**
* Size of message sent
*/
};
+/**
+ * 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 used to notify the transport service about a message
{
/**
- * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING
+ * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_ADDRESS_TO_STRING
*/
struct GNUNET_MessageHeader header;
uint16_t addrlen GNUNET_PACKED;
/**
- * timeout to give up.
+ * timeout to give up (for DNS resolution timeout mostly)
*/
struct GNUNET_TIME_RelativeNBO timeout;
- /* followed by 'addrlen' bytes of the actual address, then
+ /* followed by @e addrlen bytes of the actual address, then
* followed by the 0-terminated name of the transport */
};
*/
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;
};
struct TrafficMetricMessage
{
/**
- * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_TRAFFIC_METRIC
+ * Type will be #GNUNET_MESSAGE_TYPE_TRANSPORT_TRAFFIC_METRIC
*/
struct GNUNET_MessageHeader header;
uint32_t local_address_info GNUNET_PACKED;
/**
- * State this peer is in as #GNUNET_TRANSPORT_PeerState enumeration element
+ * State this peer is in as an `enum GNUNET_TRANSPORT_PeerState`
*/
uint32_t state GNUNET_PACKED;
{
/**
- * Type will be GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_QUERY or
- * GNUNET_MESSAGE_TYPE_TRANSPORT_BLACKLIST_REPLY.
+ * 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)
+ * 0 for the query, #GNUNET_OK (allowed) or #GNUNET_SYSERR (disallowed)
* for the response.
*/
uint32_t is_allowed GNUNET_PACKED;