2 This file is part of GNUnet
3 (C) 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file transport/plugin_transport_template.c
23 * @brief template for a new transport service
24 * @author Christian Grothoff
28 #include "gnunet_protocols.h"
29 #include "gnunet_connection_lib.h"
30 #include "gnunet_server_lib.h"
31 #include "gnunet_service_lib.h"
32 #include "gnunet_statistics_service.h"
33 #include "gnunet_transport_service.h"
34 #include "gnunet_transport_plugin.h"
36 #define LOG(kind,...) GNUNET_log_from (kind, "transport-template",__VA_ARGS__)
39 * After how long do we expire an address that we
40 * learned from another peer if it is not reconfirmed
43 #define LEARNED_ADDRESS_EXPIRATION GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_HOURS, 6)
45 #define PLUGIN_NAME "template"
48 * Encapsulation of all of the state of the plugin.
54 * Session handle for connections.
59 * To whom are we talking to (set to our identity
60 * if we are still waiting for the welcome message)
62 struct GNUNET_PeerIdentity sender;
65 * Stored in a linked list.
70 * Pointer to the global plugin struct.
72 struct Plugin *plugin;
75 * The client (used to identify this connection)
80 * Continuation function to call once the transmission buffer
81 * has again space available. NULL if there is no
82 * continuation to call.
84 GNUNET_TRANSPORT_TransmitContinuation transmit_cont;
87 * Closure for transmit_cont.
89 void *transmit_cont_cls;
92 * At what time did we reset last_received last?
94 struct GNUNET_TIME_Absolute last_quota_update;
97 * How many bytes have we received since the "last_quota_update"
100 uint64_t last_received;
103 * Number of bytes per ms that this peer is allowed
110 #define GNUNET_NETWORK_STRUCT_BEGIN
112 struct TemplateAddress
115 * Address options in NBO
117 uint32_t options GNUNET_PACKED;
119 /* Add address here */
122 GNUNET_NETWORK_STRUCT_END
125 * Encapsulation of all of the state of the plugin.
132 struct GNUNET_TRANSPORT_PluginEnvironment *env;
135 * List of open sessions.
137 struct Session *sessions;
140 * Options in HBO to be used with addresses
147 * Function that can be used by the transport service to transmit
148 * a message using the plugin. Note that in the case of a
149 * peer disconnecting, the continuation MUST be called
150 * prior to the disconnect notification itself. This function
151 * will be called with this peer's HELLO message to initiate
152 * a fresh connection to another peer.
155 * @param session which session must be used
156 * @param msgbuf the message to transmit
157 * @param msgbuf_size number of bytes in 'msgbuf'
158 * @param priority how important is the message (most plugins will
159 * ignore message priority and just FIFO)
160 * @param to how long to wait at most for the transmission (does not
161 * require plugins to discard the message after the timeout,
162 * just advisory for the desired delay; most plugins will ignore
164 * @param cont continuation to call once the message has
165 * been transmitted (or if the transport is ready
166 * for the next transmission call; or if the
167 * peer disconnected...); can be NULL
168 * @param cont_cls closure for cont
169 * @return number of bytes used (on the physical network, with overheads);
170 * -1 on hard errors (i.e. address invalid); 0 is a legal value
171 * and does NOT mean that the message was not transmitted (DV)
174 template_plugin_send (void *cls,
175 struct Session *session,
176 const char *msgbuf, size_t msgbuf_size,
177 unsigned int priority,
178 struct GNUNET_TIME_Relative to,
179 GNUNET_TRANSPORT_TransmitContinuation cont, void *cont_cls)
181 struct Plugin *plugin = cls;
184 GNUNET_assert (plugin != NULL);
185 GNUNET_assert (session != NULL);
187 /* struct Plugin *plugin = cls; */
194 * Function that can be used to force the plugin to disconnect
195 * from the given peer and cancel all previous transmissions
196 * (and their continuationc).
199 * @param target peer from which to disconnect
202 template_plugin_disconnect (void *cls, const struct GNUNET_PeerIdentity *target)
204 // struct Plugin *plugin = cls;
210 * Function obtain the network type for a session
212 * @param cls closure ('struct Plugin*')
213 * @param session the session
214 * @return the network type in HBO or GNUNET_SYSERR
216 static enum GNUNET_ATS_Network_Type
217 template_plugin_get_network (void *cls,
218 struct Session *session)
220 GNUNET_assert (NULL != session);
221 return GNUNET_ATS_NET_UNSPECIFIED; /* Change to correct network type */
226 * Convert the transports address to a nice, human-readable
230 * @param type name of the transport that generated the address
231 * @param addr one of the addresses of the host, NULL for the last address
232 * the specific address format depends on the transport
233 * @param addrlen length of the address
234 * @param numeric should (IP) addresses be displayed in numeric form?
235 * @param timeout after how long should we give up?
236 * @param asc function to call on each string
237 * @param asc_cls closure for asc
240 template_plugin_address_pretty_printer (void *cls, const char *type,
241 const void *addr, size_t addrlen,
243 struct GNUNET_TIME_Relative timeout,
244 GNUNET_TRANSPORT_AddressStringCallback
249 asc (asc_cls, TRANSPORT_SESSION_INBOUND_STRING);
258 * Another peer has suggested an address for this
259 * peer and transport plugin. Check that this could be a valid
260 * address. If so, consider adding it to the list
264 * @param addr pointer to the address
265 * @param addrlen length of addr
266 * @return GNUNET_OK if this is a plausible address for this peer
270 template_plugin_address_suggested (void *cls, const void *addr, size_t addrlen)
272 /* struct Plugin *plugin = cls; */
274 /* check if the address is belonging to the plugin*/
280 * Function called for a quick conversion of the binary address to
281 * a numeric address. Note that the caller must not free the
282 * address and that the next call to this function is allowed
283 * to override the address again.
286 * @param addr binary address
287 * @param addrlen length of the address
288 * @return string representing the same address
291 template_plugin_address_to_string (void *cls, const void *addr, size_t addrlen)
294 * Print address in format template.options.address
299 return TRANSPORT_SESSION_INBOUND_STRING;
308 * Function called to convert a string address to
311 * @param cls closure ('struct Plugin*')
312 * @param addr string address
313 * @param addrlen length of the address
314 * @param buf location to store the buffer
315 * @param added location to store the number of bytes in the buffer.
316 * If the function returns GNUNET_SYSERR, its contents are undefined.
317 * @return GNUNET_OK on success, GNUNET_SYSERR on failure
320 template_plugin_string_to_address (void *cls, const char *addr, uint16_t addrlen,
321 void **buf, size_t *added)
325 * Parse string in format template.options.address
330 return GNUNET_SYSERR;
335 * Create a new session to transmit data to the target
336 * This session will used to send data to this peer and the plugin will
337 * notify us by calling the env->session_end function
340 * @param address pointer to the GNUNET_HELLO_Address
341 * @return the session if the address is valid, NULL otherwise
343 static struct Session *
344 template_plugin_get_session (void *cls,
345 const struct GNUNET_HELLO_Address *address)
352 * Entry point for the plugin.
355 libgnunet_plugin_transport_template_init (void *cls)
357 struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
358 struct GNUNET_TRANSPORT_PluginFunctions *api;
359 struct Plugin *plugin;
361 if (NULL == env->receive)
363 /* run in 'stub' mode (i.e. as part of gnunet-peerinfo), don't fully
364 initialze the plugin or the API */
365 api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
367 api->address_to_string = &template_plugin_address_to_string;
368 api->string_to_address = &template_plugin_string_to_address;
369 api->address_pretty_printer = &template_plugin_address_pretty_printer;
373 plugin = GNUNET_malloc (sizeof (struct Plugin));
375 api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
377 api->send = &template_plugin_send;
378 api->disconnect = &template_plugin_disconnect;
379 api->address_pretty_printer = &template_plugin_address_pretty_printer;
380 api->check_address = &template_plugin_address_suggested;
381 api->address_to_string = &template_plugin_address_to_string;
382 api->string_to_address = &template_plugin_string_to_address;
383 api->get_session = &template_plugin_get_session;
384 api->get_network = &template_plugin_get_network;
385 LOG (GNUNET_ERROR_TYPE_INFO, "Template plugin successfully loaded\n");
391 * Exit point from the plugin.
394 libgnunet_plugin_transport_template_done (void *cls)
396 struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
397 struct Plugin *plugin = api->cls;
399 GNUNET_free (plugin);
404 /* end of plugin_transport_template.c */