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 DEBUG_TEMPLATE GNUNET_EXTRA_LOGGING
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)
47 * Encapsulation of all of the state of the plugin.
53 * Session handle for connections.
58 * To whom are we talking to (set to our identity
59 * if we are still waiting for the welcome message)
61 struct GNUNET_PeerIdentity sender;
64 * Stored in a linked list.
69 * Pointer to the global plugin struct.
71 struct Plugin *plugin;
74 * The client (used to identify this connection)
79 * Continuation function to call once the transmission buffer
80 * has again space available. NULL if there is no
81 * continuation to call.
83 GNUNET_TRANSPORT_TransmitContinuation transmit_cont;
86 * Closure for transmit_cont.
88 void *transmit_cont_cls;
91 * At what time did we reset last_received last?
93 struct GNUNET_TIME_Absolute last_quota_update;
96 * How many bytes have we received since the "last_quota_update"
99 uint64_t last_received;
102 * Number of bytes per ms that this peer is allowed
110 * Encapsulation of all of the state of the plugin.
117 struct GNUNET_TRANSPORT_PluginEnvironment *env;
120 * List of open sessions.
122 struct Session *sessions;
128 * Function that can be used by the transport service to transmit
129 * a message using the plugin. Note that in the case of a
130 * peer disconnecting, the continuation MUST be called
131 * prior to the disconnect notification itself. This function
132 * will be called with this peer's HELLO message to initiate
133 * a fresh connection to another peer.
136 * @param session which session must be used
137 * @param msgbuf the message to transmit
138 * @param msgbuf_size number of bytes in 'msgbuf'
139 * @param priority how important is the message (most plugins will
140 * ignore message priority and just FIFO)
141 * @param to how long to wait at most for the transmission (does not
142 * require plugins to discard the message after the timeout,
143 * just advisory for the desired delay; most plugins will ignore
145 * @param cont continuation to call once the message has
146 * been transmitted (or if the transport is ready
147 * for the next transmission call; or if the
148 * peer disconnected...); can be NULL
149 * @param cont_cls closure for cont
150 * @return number of bytes used (on the physical network, with overheads);
151 * -1 on hard errors (i.e. address invalid); 0 is a legal value
152 * and does NOT mean that the message was not transmitted (DV)
155 template_plugin_send (void *cls,
156 struct Session *session,
157 const char *msgbuf, size_t msgbuf_size,
158 unsigned int priority,
159 struct GNUNET_TIME_Relative to,
160 GNUNET_TRANSPORT_TransmitContinuation cont, void *cont_cls)
162 struct Plugin *plugin = cls;
165 GNUNET_assert (plugin != NULL);
166 GNUNET_assert (session != NULL);
168 /* struct Plugin *plugin = cls; */
175 * Function that can be used to force the plugin to disconnect
176 * from the given peer and cancel all previous transmissions
177 * (and their continuationc).
180 * @param target peer from which to disconnect
183 template_plugin_disconnect (void *cls, const struct GNUNET_PeerIdentity *target)
185 // struct Plugin *plugin = cls;
191 * Convert the transports address to a nice, human-readable
195 * @param type name of the transport that generated the address
196 * @param addr one of the addresses of the host, NULL for the last address
197 * the specific address format depends on the transport
198 * @param addrlen length of the address
199 * @param numeric should (IP) addresses be displayed in numeric form?
200 * @param timeout after how long should we give up?
201 * @param asc function to call on each string
202 * @param asc_cls closure for asc
205 template_plugin_address_pretty_printer (void *cls, const char *type,
206 const void *addr, size_t addrlen,
208 struct GNUNET_TIME_Relative timeout,
209 GNUNET_TRANSPORT_AddressStringCallback
218 * Another peer has suggested an address for this
219 * peer and transport plugin. Check that this could be a valid
220 * address. If so, consider adding it to the list
224 * @param addr pointer to the address
225 * @param addrlen length of addr
226 * @return GNUNET_OK if this is a plausible address for this peer
230 template_plugin_address_suggested (void *cls, const void *addr, size_t addrlen)
232 /* struct Plugin *plugin = cls; */
234 /* check if the address is plausible; if so,
235 * add it to our list! */
241 * Function called for a quick conversion of the binary address to
242 * a numeric address. Note that the caller must not free the
243 * address and that the next call to this function is allowed
244 * to override the address again.
247 * @param addr binary address
248 * @param addrlen length of the address
249 * @return string representing the same address
252 template_plugin_address_to_string (void *cls, const void *addr, size_t addrlen)
262 * Entry point for the plugin.
265 gnunet_plugin_transport_template_init (void *cls)
267 struct GNUNET_TRANSPORT_PluginEnvironment *env = cls;
268 struct GNUNET_TRANSPORT_PluginFunctions *api;
269 struct Plugin *plugin;
271 plugin = GNUNET_malloc (sizeof (struct Plugin));
273 api = GNUNET_malloc (sizeof (struct GNUNET_TRANSPORT_PluginFunctions));
275 api->send = &template_plugin_send;
276 api->disconnect = &template_plugin_disconnect;
277 api->address_pretty_printer = &template_plugin_address_pretty_printer;
278 api->check_address = &template_plugin_address_suggested;
279 api->address_to_string = &template_plugin_address_to_string;
285 * Exit point from the plugin.
288 gnunet_plugin_transport_template_done (void *cls)
290 struct GNUNET_TRANSPORT_PluginFunctions *api = cls;
291 struct Plugin *plugin = api->cls;
293 GNUNET_free (plugin);
298 /* end of plugin_transport_template.c */