#include "gnunet_scheduler_lib.h"
#include "gnunet_statistics_service.h"
#include "gnunet_transport_service.h"
+#include "gnunet_ats_service.h"
+
+#define TRANSPORT_SESSION_INBOUND_STRING "<inbound>"
/**
* Opaque pointer that plugins can use to distinguish specific
* useful since sometimes (i.e. for inbound TCP connections) a
* connection may not have an address that can be used for meaningful
* distinction between sessions to the same peer.
+ *
+ * Each 'struct Session' MUST start with the 'struct GNUNET_PeerIdentity'
+ * of the peer the session is for (which will be used for some error
+ * checking by the ATS code).
*/
struct Session;
*/
struct SessionHeader
{
-
- /**
- * Cached signature for PONG generation for the session. Do not use
- * in the plugin!
- */
- struct GNUNET_CRYPTO_RsaSignature pong_signature;
-
- /**
- * Expiration time for signature. Do not use in the plugin!
- */
- struct GNUNET_TIME_Absolute pong_sig_expires;
-
+ /* empty, for now */
};
/**
* @param session which session is being destoyed
*/
typedef void (*GNUNET_TRANSPORT_SessionEnd) (void *cls,
- const struct GNUNET_PeerIdentity *
- peer, struct Session * session);
+ const struct GNUNET_PeerIdentity *peer,
+ struct Session * session);
+/**
+ * Function that will be called whenever the plugin internally
+ * creates a new session and hence transport need to tell ATS.
+ * This happens when we have a inbound connection we did not
+ * initiate.
+ *
+ * @param cls closure
+ * @param peer peer
+ * @param plugin plugin
+ * @param address address
+ * @param address_len length of the address
+ * @param session session
+ * @param ats ATS information
+ * @param ats_count number of ATS information contained
+ */
+typedef void
+(*GNUNET_TRANSPORT_SessionStart) (void *cls,
+ const struct GNUNET_PeerIdentity *peer,
+ const char *plugin,
+ const void *address,
+ uint16_t address_len,
+ struct Session *session,
+ const struct GNUNET_ATS_Information *ats,
+ uint32_t ats_count);
+
/**
* Function called by the transport for each received message.
* This function should also be called with "NULL" for the
*/
typedef struct
GNUNET_TIME_Relative (*GNUNET_TRANSPORT_PluginReceiveCallback) (void *cls,
- const struct
- GNUNET_PeerIdentity
- * peer,
- const struct
- GNUNET_MessageHeader
- * message,
- const struct
- GNUNET_ATS_Information
- * ats,
- uint32_t
- ats_count,
- struct
- Session *
- session,
- const char
- *sender_address,
- uint16_t
- sender_address_len);
+ const struct GNUNET_PeerIdentity *peer,
+ const struct GNUNET_MessageHeader *message,
+ struct Session *session,
+ const char *sender_address,
+ uint16_t sender_address_len);
/**
* @param addrlen length of the address
* @return ATS Information containing the network type
*/
-typedef const struct GNUNET_ATS_Information
+typedef struct GNUNET_ATS_Information
(*GNUNET_TRANSPORT_AddressToType) (void *cls,
const struct sockaddr *addr,
size_t addrlen);
+
+/**
+ * Function called when quality properties of an address change.
+ *
+ * @param cls closure
+ * @param peer peer
+ * @param address address
+ * @param address_len length of the address
+ * @param session session
+ * @param ats ATS information
+ * @param ats_count number of ATS information contained
+ */
+typedef void
+(*GNUNET_TRANSPORT_UpdateAddressMetrics) (void *cls,
+ const struct GNUNET_PeerIdentity *peer,
+ const void *address,
+ uint16_t address_len,
+ struct Session *session,
+ const struct GNUNET_ATS_Information *ats,
+ uint32_t ats_count);
+
/**
* Function that will be called for each address the transport
* is aware that it might be reachable under.
* @param addr one of the addresses of the host
* the specific address format depends on the transport
* @param addrlen length of the address
+ * @param dest_plugin plugin to use this address with
*/
-typedef void (*GNUNET_TRANSPORT_AddressNotification) (void *cls, int add_remove,
+typedef void (*GNUNET_TRANSPORT_AddressNotification) (void *cls,
+ int add_remove,
const void *addr,
- size_t addrlen);
+ size_t addrlen,
+ const char *dest_plugin);
/**
* @return how long to wait until reading more from this peer
* (to enforce inbound quotas)
*/
-typedef struct GNUNET_TIME_Relative (*GNUNET_TRANSPORT_TrafficReport) (void
- *cls,
- const
- struct
- GNUNET_PeerIdentity
- * peer,
- size_t
- amount_recved);
+typedef struct GNUNET_TIME_Relative (*GNUNET_TRANSPORT_TrafficReport) (void *cls,
+ const struct GNUNET_PeerIdentity* peer,
+ size_t amount_recved);
/**
* Function that returns a HELLO message.
*/
-typedef const struct GNUNET_MessageHeader
- *(*GNUNET_TRANSPORT_GetHelloCallback) (void);
+typedef const struct GNUNET_MessageHeader *
+ (*GNUNET_TRANSPORT_GetHelloCallback) (void);
/**
* Function that should be called by the transport plugin
* whenever a message is received. If this field is "NULL",
* the plugin should load in 'stub' mode and NOT fully
- * initialize and instead only return an API with the
+ * initialize and instead only return an API with the
* 'address_pretty_printer', 'address_to_string' and
* 'string_to_address' functions.
*/
*/
GNUNET_TRANSPORT_SessionEnd session_end;
+ /**
+ * Function called by the plugin when a new (incoming) session was created
+ * not explicitly created using the the get_session function
+ */
+ GNUNET_TRANSPORT_SessionStart session_start;
+
/**
* Function that will be called to figure if an address is an loopback,
* LAN, WAN etc. address
*/
GNUNET_TRANSPORT_AddressToType get_address_type;
+ /**
+ * Function that will be called to figure if an address is an loopback,
+ * LAN, WAN etc. address
+ */
+ GNUNET_TRANSPORT_UpdateAddressMetrics update_address_metrics;
+
/**
* What is the maximum number of connections that this transport
* GNUNET_SYSERR if the target disconnected;
* disconnect will ALSO be signalled using
* the ReceiveCallback.
+ * @param size_payload bytes of payload from transport service in message
+ * @param size_on_wire bytes required on wire for transmission,
+ * 0 if result == GNUNET_SYSERR
*/
typedef void (*GNUNET_TRANSPORT_TransmitContinuation) (void *cls,
- const struct
- GNUNET_PeerIdentity *
- target, int result);
+ const struct GNUNET_PeerIdentity *target,
+ int result,
+ size_t size_payload,
+ size_t size_on_wire);
/**
* The new send function with just the session and no address
* @param msgbuf_size number of bytes in 'msgbuf'
* @param priority how important is the message (most plugins will
* ignore message priority and just FIFO)
- * @param timeout how long to wait at most for the transmission (does not
+ * @param to how long to wait at most for the transmission (does not
* require plugins to discard the message after the timeout,
* just advisory for the desired delay; most plugins will ignore
* this as well)
* and does NOT mean that the message was not transmitted (DV)
*/
typedef ssize_t (*GNUNET_TRANSPORT_TransmitFunction) (void *cls,
- struct Session *session,
- const char *msgbuf, size_t msgbuf_size,
- unsigned int priority,
- struct GNUNET_TIME_Relative to,
- GNUNET_TRANSPORT_TransmitContinuation cont, void *cont_cls);
+ struct Session *session,
+ const char *msgbuf,
+ size_t msgbuf_size,
+ unsigned int priority,
+ struct GNUNET_TIME_Relative to,
+ GNUNET_TRANSPORT_TransmitContinuation cont,
+ void *cont_cls);
/**
* to be cancelled
*/
typedef void (*GNUNET_TRANSPORT_DisconnectFunction) (void *cls,
- const struct
- GNUNET_PeerIdentity *
- target);
+ const struct GNUNET_PeerIdentity *target);
/**
* each human-readable address obtained.
*
* @param cls closure
- * @param hostname one of the names for the host, NULL
+ * @param address one of the names for the host, NULL
* on the last call to the callback
*/
typedef void (*GNUNET_TRANSPORT_AddressStringCallback) (void *cls,
* format.
*
* @param cls closure
- * @param name name of the transport that generated the address
+ * @param type name of the transport that generated the address
* @param addr one of the addresses of the host, NULL for the last address
* the specific address format depends on the transport
* @param addrlen length of the address
* @param asc_cls closure for asc
*/
typedef void (*GNUNET_TRANSPORT_AddressPrettyPrinter) (void *cls,
- const char *type,
- const void *addr,
- size_t addrlen,
- int numeric,
- struct
- GNUNET_TIME_Relative
- timeout,
- GNUNET_TRANSPORT_AddressStringCallback
- asc, void *asc_cls);
+ const char *type,
+ const void *addr,
+ size_t addrlen,
+ int numeric,
+ struct GNUNET_TIME_Relative timeout,
+ GNUNET_TRANSPORT_AddressStringCallback asc,
+ void *asc_cls);
/**
* @return GNUNET_OK if this is a plausible address for this peer
* and transport, GNUNET_SYSERR if not
*/
-typedef int (*GNUNET_TRANSPORT_CheckAddress) (void *cls, const void *addr,
+typedef int (*GNUNET_TRANSPORT_CheckAddress) (void *cls,
+ const void *addr,
size_t addrlen);
/**
* notify us by calling the env->session_end function
*
* @param cls the plugin
- * @param target the neighbour id
- * @param addr pointer to the address
- * @param addrlen length of addr
+ * @param address the hello address
* @return the session if the address is valid, NULL otherwise
*/
typedef struct Session * (*GNUNET_TRANSPORT_CreateSession) (void *cls,
*
* @param cls closure ('struct Plugin*')
* @param addr string address
- * @param addrlen length of the address
+ * @param addrlen length of the address including \0 termination
* @param buf location to store the buffer
* If the function returns GNUNET_SYSERR, its contents are undefined.
* @param added length of created address
size_t *added);
+/**
+ * Function to obtain the network type for a session
+ *
+ * @param cls closure ('struct Plugin*')
+ * @param session the session
+ * @return the network type
+ */
+typedef enum GNUNET_ATS_Network_Type (*GNUNET_TRANSPORT_GetNetworkType) (void *cls,
+ struct Session *session);
+
+
/**
* Each plugin is required to return a pointer to a struct of this
* type as the return value from its entry point.
* object
*/
GNUNET_TRANSPORT_CreateSession get_session;
+
+ /**
+ * Function to obtain the network type for a session
+ */
+ GNUNET_TRANSPORT_GetNetworkType get_network;
};
projects / oweals / gnunet.git / blobdiff