/*
This file is part of GNUnet
- (C) 2009-2014 Christian Grothoff (and other contributing authors)
+ 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 General Public License as published
- by the Free Software Foundation; either version 3, or (at your
- option) any later version.
+ 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
- General Public License for more details.
+ 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/>.
- You should have received a copy of the GNU General Public License
- along with GNUnet; see the file COPYING. If not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.
+ SPDX-License-Identifier: AGPL3.0-or-later
*/
/**
- * @file include/gnunet_transport_plugin.h
- * @brief API for the transport services. This header
- * specifies the struct that is given to the plugin's entry
- * method and the other struct that must be returned.
- * Note that the destructors of transport plugins will
- * be given the value returned by the constructor
- * and is expected to return a NULL pointer.
* @author Christian Grothoff
+ *
+ * @file
+ * Transport service plugin API
+ *
+ * @defgroup transport-plugin Transport Service plugin API
+ *
+ * Specifies the struct that is given to the plugin's entry method and the other
+ * struct that must be returned. Note that the destructors of transport plugins
+ * will be given the value returned by the constructor and is expected to return
+ * a NULL pointer.
+ *
+ * @{
*/
#ifndef PLUGIN_TRANSPORT_H
#define PLUGIN_TRANSPORT_H
* 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'
+ * Each 'struct GNUNET_ATS_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 GNUNET_ATS_Session;
/**
typedef void
(*GNUNET_TRANSPORT_SessionEnd) (void *cls,
const struct GNUNET_HELLO_Address *address,
- struct Session *session);
+ struct GNUNET_ATS_Session *session);
/**
* @param cls unused
* @param address the address
* @param session the new session
- * @param ats ats information
- * @param ats_count number of @a ats information
+ * @param net network information
*/
typedef void
(*GNUNET_TRANSPORT_SessionStart) (void *cls,
- struct GNUNET_HELLO_Address *address,
- struct Session *session,
- const struct GNUNET_ATS_Information *ats,
- uint32_t ats_count);
+ const struct GNUNET_HELLO_Address *address,
+ struct GNUNET_ATS_Session *session,
+ enum GNUNET_NetworkType net);
+
/**
* Function called by the transport for each received message.
typedef struct GNUNET_TIME_Relative
(*GNUNET_TRANSPORT_PluginReceiveCallback) (void *cls,
const struct GNUNET_HELLO_Address *address,
- struct Session *session,
+ struct GNUNET_ATS_Session *session,
const struct GNUNET_MessageHeader *message);
/**
- * Function that will be called to figure if an address is an
- * loopback, LAN, WAN etc. address
+ * Function that can be called by plugins to figure if an address is
+ * an loopback, LAN or WAN address. Ultimately invokes
+ * #GNUNET_ATS_address_get_type().
*
* @param cls closure
* @param addr binary address
* @param addrlen length of the @a addr
* @return type of the network the address belongs to
*/
-typedef enum GNUNET_ATS_Network_Type
+typedef enum GNUNET_NetworkType
(*GNUNET_TRANSPORT_AddressToType) (void *cls,
const struct sockaddr *addr,
size_t addrlen);
/**
- * Function called when quality properties of an address change.
+ * Function called when distance of an address changes.
*
* @param cls closure
* @param peer peer
- * @param address address
- * @param address_len length of the @a address
- * @param session session
- * @param ats ATS information
- * @param ats_count number entries in the @a ats array
+ * @param distance new distance
*/
typedef void
-(*GNUNET_TRANSPORT_UpdateAddressMetrics) (void *cls,
- const struct GNUNET_HELLO_Address *address,
- struct Session *session,
- const struct GNUNET_ATS_Information *ats,
- uint32_t ats_count);
+(*GNUNET_TRANSPORT_UpdateAddressDistance) (void *cls,
+ const struct GNUNET_HELLO_Address *address,
+ uint32_t distance);
+
/**
* Function that will be called for each address the transport
size_t amount_recved);
-/**
- * Function to be called by the plugin to be notified about changes to the quota
- * for a specific peer, plugin and session
- *
- * @param cls closure
- * @param peer the peer to be notified about
- * @param plugin the plugin to be notified about
- * @param session the session for include in the notification
- *
- */
-typedef void
-(*GNUNET_TRANSPORT_RegisterQuotaNotification) (void *cls,
- const struct GNUNET_PeerIdentity *peer,
- const char *plugin,
- struct Session *session);
-
-
-/**
- * Function to be called by the plugin to stop notification about changes to the quota
- * for a specific peer, plugin and session
- *
- * @param cls closure
- * @param peer the peer to be notified about
- * @param plugin the plugin to be notified about
- * @param session the session for include in the notification
- */
-typedef void
-(*GNUNET_TRANSPORT_UnregisterQuotaNotification) (void *cls,
- const struct GNUNET_PeerIdentity *peer,
- const char *plugin,
- struct Session *session);
-
/**
* Function that returns a HELLO message.
*
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;
-
- /**
- * FIXME: document!
+ * Function that will be called by DV to update distance for
+ * an address.
*/
- GNUNET_TRANSPORT_RegisterQuotaNotification register_quota_notification;
-
- /**
- * FIXME: document!
- */
- GNUNET_TRANSPORT_UnregisterQuotaNotification unregister_quota_notification;
+ GNUNET_TRANSPORT_UpdateAddressDistance update_address_distance;
/**
* What is the maximum number of connections that this transport
*/
typedef ssize_t
(*GNUNET_TRANSPORT_TransmitFunction) (void *cls,
- struct Session *session,
+ struct GNUNET_ATS_Session *session,
const char *msgbuf,
size_t msgbuf_size,
unsigned int priority,
*/
typedef int
(*GNUNET_TRANSPORT_DisconnectSessionFunction) (void *cls,
- struct Session *session);
+ struct GNUNET_ATS_Session *session);
/**
* @param address the hello address
* @return the session if the address is valid, NULL otherwise
*/
-typedef struct Session *
+typedef struct GNUNET_ATS_Session *
(*GNUNET_TRANSPORT_CreateSession) (void *cls,
const struct GNUNET_HELLO_Address *address);
typedef void
(*GNUNET_TRANSPORT_UpdateSessionTimeout) (void *cls,
const struct GNUNET_PeerIdentity *peer,
- struct Session *session);
-
+ struct GNUNET_ATS_Session *session);
/**
typedef void
(*GNUNET_TRANSPORT_UpdateInboundDelay) (void *cls,
const struct GNUNET_PeerIdentity *peer,
- struct Session *session,
+ struct GNUNET_ATS_Session *session,
struct GNUNET_TIME_Relative delay);
+
/**
* Function called for a quick conversion of the binary address to
* a numeric address. Note that the caller must not free the
/**
* Function to obtain the network type for a session
*
- * @param cls closure ('struct Plugin*')
+ * @param cls closure (`struct Plugin *`)
* @param session the session
* @return the network type
*/
-typedef enum GNUNET_ATS_Network_Type
+typedef enum GNUNET_NetworkType
(*GNUNET_TRANSPORT_GetNetworkType) (void *cls,
- struct Session *session);
+ struct GNUNET_ATS_Session *session);
+
+
+/**
+ * Function to obtain the network type for an address.
+ *
+ * @param cls closure (`struct Plugin *`)
+ * @param address the address
+ * @return the network type
+ */
+typedef enum GNUNET_NetworkType
+(*GNUNET_TRANSPORT_GetNetworkTypeForAddress) (void *cls,
+ const struct GNUNET_HELLO_Address *address);
/**
*/
typedef void
(*GNUNET_TRANSPORT_SessionInfoCallback) (void *cls,
- struct Session *session,
+ struct GNUNET_ATS_Session *session,
const struct GNUNET_TRANSPORT_SessionInfo *info);
/**
* Function that will be called tell the plugin to create a session
- * object
+ * object.
*/
GNUNET_TRANSPORT_CreateSession get_session;
*/
GNUNET_TRANSPORT_GetNetworkType get_network;
+ /**
+ * Function to obtain the network type for an address
+ */
+ GNUNET_TRANSPORT_GetNetworkTypeForAddress get_network_for_address;
+
/**
* Function to monitor the sessions managed by the plugin.
*/
/*#ifndef PLUGIN_TRANSPORT_H*/
#endif
+
+/** @} */ /* end of group */
+
/* end of gnunet_transport_plugin.h */
projects / oweals / gnunet.git / blobdiff