*/
#include "platform.h"
+#include "gnunet_util_lib.h"
#include "gnunet_protocols.h"
-#include "gnunet_connection_lib.h"
-#include "gnunet_server_lib.h"
-#include "gnunet_service_lib.h"
#include "gnunet_statistics_service.h"
#include "gnunet_transport_service.h"
#include "gnunet_transport_plugin.h"
*/
#define LEARNED_ADDRESS_EXPIRATION GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_HOURS, 6)
+#define PLUGIN_NAME "template"
/**
* Encapsulation of all of the state of the plugin.
};
+GNUNET_NETWORK_STRUCT_BEGIN
+
+struct TemplateAddress
+{
+ /**
+ * Address options in NBO
+ */
+ uint32_t options GNUNET_PACKED;
+
+ /* Add address here */
+};
+
+GNUNET_NETWORK_STRUCT_END
+
/**
* Encapsulation of all of the state of the plugin.
*/
*/
struct Session *sessions;
+ /**
+ * Options in HBO to be used with addresses
+ */
+
};
* @param cls closure
* @param session which session must be used
* @param msgbuf the message to transmit
- * @param msgbuf_size number of bytes in 'msgbuf'
+ * @param msgbuf_size number of bytes in @a msgbuf
* @param priority how important is the message (most plugins will
* ignore message priority and just FIFO)
* @param to how long to wait at most for the transmission (does not
* been transmitted (or if the transport is ready
* for the next transmission call; or if the
* peer disconnected...); can be NULL
- * @param cont_cls closure for cont
+ * @param cont_cls closure for @a cont
* @return number of bytes used (on the physical network, with overheads);
* -1 on hard errors (i.e. address invalid); 0 is a legal value
* and does NOT mean that the message was not transmitted (DV)
}
-
/**
* Function that can be used to force the plugin to disconnect
* from the given peer and cancel all previous transmissions
* @param target peer from which to disconnect
*/
static void
-template_plugin_disconnect (void *cls, const struct GNUNET_PeerIdentity *target)
+template_plugin_disconnect_peer (void *cls,
+ const struct GNUNET_PeerIdentity *target)
{
// struct Plugin *plugin = cls;
// FIXME
}
+/**
+ * Function that can be used to force the plugin to disconnect
+ * from the given peer and cancel all previous transmissions
+ * (and their continuationc).
+ *
+ * @param cls closure
+ * @param session session from which to disconnect
+ * @return #GNUNET_OK on success
+ */
+static int
+template_plugin_disconnect_session (void *cls,
+ struct Session *session)
+{
+ // struct Plugin *plugin = cls;
+ // FIXME
+ return GNUNET_SYSERR;
+}
+
+
+/**
+ * Function that is called to get the keepalive factor.
+ * GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT is divided by this number to
+ * calculate the interval between keepalive packets.
+ *
+ * @param cls closure with the `struct Plugin`
+ * @return keepalive factor
+ */
+static unsigned int
+template_plugin_query_keepalive_factor (void *cls)
+{
+ return 3;
+}
+
+
+/**
+ * Function obtain the network type for a session
+ *
+ * @param cls closure ('struct Plugin*')
+ * @param session the session
+ * @return the network type in HBO or GNUNET_SYSERR
+ */
+static enum GNUNET_ATS_Network_Type
+template_plugin_get_network (void *cls,
+ struct Session *session)
+{
+ GNUNET_assert (NULL != session);
+ return GNUNET_ATS_NET_UNSPECIFIED; /* Change to correct network type */
+}
+
+
/**
* Convert the transports address to a nice, human-readable
* format.
GNUNET_TRANSPORT_AddressStringCallback
asc, void *asc_cls)
{
+ if (0 == addrlen)
+ {
+ asc (asc_cls, TRANSPORT_SESSION_INBOUND_STRING);
+ }
asc (asc_cls, NULL);
}
* @param cls closure
* @param addr pointer to the address
* @param addrlen length of addr
- * @return GNUNET_OK if this is a plausible address for this peer
+ * @return #GNUNET_OK if this is a plausible address for this peer
* and transport
*/
static int
{
/* struct Plugin *plugin = cls; */
- /* check if the address is plausible; if so,
- * add it to our list! */
+ /* check if the address is belonging to the plugin*/
return GNUNET_OK;
}
static const char *
template_plugin_address_to_string (void *cls, const void *addr, size_t addrlen)
{
+ /*
+ * Print address in format template.options.address
+ */
+
+ if (0 == addrlen)
+ {
+ return TRANSPORT_SESSION_INBOUND_STRING;
+ }
+
GNUNET_break (0);
return NULL;
}
*
* @param cls closure ('struct Plugin*')
* @param addr string address
- * @param addrlen length of the address
+ * @param addrlen length of the @a addr
* @param buf location to store the buffer
* @param added location to store the number of bytes in the buffer.
- * If the function returns GNUNET_SYSERR, its contents are undefined.
- * @return GNUNET_OK on success, GNUNET_SYSERR on failure
+ * If the function returns #GNUNET_SYSERR, its contents are undefined.
+ * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
*/
static int
-template_plugin_string_to_address (void *cls, const char *addr, uint16_t addrlen,
- void **buf, size_t *added)
+template_plugin_string_to_address (void *cls,
+ const char *addr,
+ uint16_t addrlen,
+ void **buf, size_t *added)
{
+ /*
+ * Parse string in format template.options.address
+ */
GNUNET_break (0);
return GNUNET_SYSERR;
}
return NULL;
}
+static void
+template_plugin_update_session_timeout (void *cls,
+ const struct GNUNET_PeerIdentity *peer,
+ struct Session *session)
+{
+
+}
+
/**
* Entry point for the plugin.
*/
{
/* run in 'stub' mode (i.e. as part of gnunet-peerinfo), don't fully
initialze the plugin or the API */
- api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
+ api = GNUNET_new (struct GNUNET_TRANSPORT_PluginFunctions);
api->cls = NULL;
api->address_to_string = &template_plugin_address_to_string;
api->string_to_address = &template_plugin_string_to_address;
return api;
}
- plugin = GNUNET_malloc (sizeof (struct Plugin));
+ plugin = GNUNET_new (struct Plugin);
plugin->env = env;
- api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
+ api = GNUNET_new (struct GNUNET_TRANSPORT_PluginFunctions);
api->cls = plugin;
api->send = &template_plugin_send;
- api->disconnect = &template_plugin_disconnect;
+ api->disconnect_peer = &template_plugin_disconnect_peer;
+ api->disconnect_session = &template_plugin_disconnect_session;
+ api->query_keepalive_factor = &template_plugin_query_keepalive_factor;
api->address_pretty_printer = &template_plugin_address_pretty_printer;
api->check_address = &template_plugin_address_suggested;
api->address_to_string = &template_plugin_address_to_string;
api->string_to_address = &template_plugin_string_to_address;
api->get_session = &template_plugin_get_session;
+ api->get_network = &template_plugin_get_network;
+ api->update_session_timeout = &template_plugin_update_session_timeout;
LOG (GNUNET_ERROR_TYPE_INFO, "Template plugin successfully loaded\n");
return api;
}
projects / oweals / gnunet.git / blobdiff