2 This file is part of GNUnet
3 (C) 2009-2014 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 include/gnunet_transport_plugin.h
23 * @brief API for the transport services. This header
24 * specifies the struct that is given to the plugin's entry
25 * method and the other struct that must be returned.
26 * Note that the destructors of transport plugins will
27 * be given the value returned by the constructor
28 * and is expected to return a NULL pointer.
29 * @author Christian Grothoff
31 #ifndef PLUGIN_TRANSPORT_H
32 #define PLUGIN_TRANSPORT_H
34 #include "gnunet_configuration_lib.h"
35 #include "gnunet_scheduler_lib.h"
36 #include "gnunet_statistics_service.h"
37 #include "gnunet_transport_service.h"
38 #include "gnunet_ats_service.h"
40 #define TRANSPORT_SESSION_INBOUND_STRING "<inbound>"
43 * Opaque pointer that plugins can use to distinguish specific
44 * connections to a given peer. Typically used by stateful plugins to
45 * allow the service to refer to specific streams instead of a more
46 * general notion of "some connection" to the given peer. This is
47 * useful since sometimes (i.e. for inbound TCP connections) a
48 * connection may not have an address that can be used for meaningful
49 * distinction between sessions to the same peer.
51 * Each 'struct Session' MUST start with the 'struct GNUNET_PeerIdentity'
52 * of the peer the session is for (which will be used for some error
53 * checking by the ATS code).
58 * Every 'struct Session' must begin with this header.
67 * Function that will be called whenever the plugin internally
68 * cleans up a session pointer and hence the service needs to
69 * discard all of those sessions as well. Plugins that do not
70 * use sessions can simply omit calling this function and always
71 * use NULL wherever a session pointer is needed. This function
72 * should be called BEFORE a potential "TransmitContinuation"
73 * from the "TransmitFunction".
76 * @param peer which peer was the session for
77 * @param session which session is being destroyed
80 (*GNUNET_TRANSPORT_SessionEnd) (void *cls,
81 const struct GNUNET_HELLO_Address *address,
82 struct Session *session);
85 * Plugin tells transport service about a new inbound session
88 * @param address the address
89 * @param session the new session
90 * @param ats ats information
91 * @param ats_count number of @a ats information
94 (*GNUNET_TRANSPORT_SessionStart) (void *cls,
95 struct GNUNET_HELLO_Address *address,
96 struct Session *session,
97 const struct GNUNET_ATS_Information *ats,
101 * Function called by the transport for each received message.
102 * This function should also be called with "NULL" for the
103 * message to signal that the other peer disconnected.
106 * @param peer (claimed) identity of the other peer
107 * @param message the message, NULL if we only care about
108 * learning about the delay until we should receive again
109 * @param session identifier used for this session (NULL for plugins
110 * that do not offer bi-directional communication to the sender
111 * using the same "connection")
112 * @param sender_address binary address of the sender (if we established the
113 * connection or are otherwise sure of it; should be NULL
114 * for inbound TCP/UDP connections since it it not clear
115 * that we could establish ourselves a connection to that
116 * IP address and get the same system)
117 * @param sender_address_len number of bytes in @a sender_address
118 * @return how long the plugin should wait until receiving more data;
119 * returning #GNUNET_TIME_UNIT_FOREVER_REL means that the
120 * connection should be closed
122 typedef struct GNUNET_TIME_Relative
123 (*GNUNET_TRANSPORT_PluginReceiveCallback) (void *cls,
124 const struct GNUNET_HELLO_Address *address,
125 struct Session *session,
126 const struct GNUNET_MessageHeader *message);
130 * Function that will be called to figure if an address is an loopback,
131 * LAN, WAN etc. address
134 * @param addr binary address
135 * @param addrlen length of the @a addr
136 * @return ATS Information containing the network type
138 typedef struct GNUNET_ATS_Information
139 (*GNUNET_TRANSPORT_AddressToType) (void *cls,
140 const struct sockaddr *addr,
145 * Function called when quality properties of an address change.
149 * @param address address
150 * @param address_len length of the @a address
151 * @param session session
152 * @param ats ATS information
153 * @param ats_count number entries in the @a ats array
156 (*GNUNET_TRANSPORT_UpdateAddressMetrics) (void *cls,
157 const struct GNUNET_HELLO_Address *address,
158 struct Session *session,
159 const struct GNUNET_ATS_Information *ats,
163 * Function that will be called for each address the transport
164 * is aware that it might be reachable under.
167 * @param add_remove should the address added (#GNUNET_YES) or removed (#GNUNET_NO) from the
168 * set of valid addresses?
169 * @param address the address to add or remove
172 (*GNUNET_TRANSPORT_AddressNotification) (void *cls, int add_remove,
173 const struct GNUNET_HELLO_Address *address);
177 * Function that will be called whenever the plugin receives data over
178 * the network and wants to determine how long it should wait until
179 * the next time it reads from the given peer. Note that some plugins
180 * (such as UDP) may not be able to wait (for a particular peer), so
181 * the waiting part is optional. Plugins that can wait should call
182 * this function, sleep the given amount of time, and call it again
183 * (with zero bytes read) UNTIL it returns zero and only then read.
186 * @param peer which peer did we read data from
187 * @param amount_recved number of bytes read (can be zero)
188 * @return how long to wait until reading more from this peer
189 * (to enforce inbound quotas); returning #GNUNET_TIME_UNIT_FOREVER_REL
190 * means that the connection should be closed
192 typedef struct GNUNET_TIME_Relative
193 (*GNUNET_TRANSPORT_TrafficReport) (void *cls,
194 const struct GNUNET_PeerIdentity *peer,
195 size_t amount_recved);
201 (*GNUNET_TRANSPORT_RegisterQuotaNotification) (void *cls,
202 const struct GNUNET_PeerIdentity *peer,
204 struct Session *session);
210 (*GNUNET_TRANSPORT_UnregisterQuotaNotification) (void *cls,
211 const struct GNUNET_PeerIdentity *peer,
213 struct Session *session);
216 * Function that returns a HELLO message.
218 * @return HELLO message (FIXME with what?)
220 typedef const struct GNUNET_MessageHeader *
221 (*GNUNET_TRANSPORT_GetHelloCallback) (void);
225 * The transport service will pass a pointer to a struct
226 * of this type as the first and only argument to the
227 * entry point of each transport plugin.
229 struct GNUNET_TRANSPORT_PluginEnvironment
232 * Configuration to use.
234 const struct GNUNET_CONFIGURATION_Handle *cfg;
237 * Identity of this peer.
239 const struct GNUNET_PeerIdentity *my_identity;
242 * Closure for the various callbacks.
247 * Handle for reporting statistics.
249 struct GNUNET_STATISTICS_Handle *stats;
252 * Function that should be called by the transport plugin
253 * whenever a message is received. If this field is "NULL",
254 * the plugin should load in 'stub' mode and NOT fully
255 * initialize and instead only return an API with the
256 * 'address_pretty_printer', 'address_to_string' and
257 * 'string_to_address' functions.
259 GNUNET_TRANSPORT_PluginReceiveCallback receive;
262 * Function that returns our HELLO.
264 GNUNET_TRANSPORT_GetHelloCallback get_our_hello;
267 * Function that must be called by each plugin to notify the
268 * transport service about the addresses under which the transport
269 * provided by the plugin can be reached.
271 GNUNET_TRANSPORT_AddressNotification notify_address;
274 * Function that must be called by the plugin when a non-NULL
275 * session handle stops being valid (is destroyed).
277 GNUNET_TRANSPORT_SessionEnd session_end;
280 * Function called by the plugin when a new (incoming) session was created
281 * not explicitly created using the the get_session function
283 GNUNET_TRANSPORT_SessionStart session_start;
286 * Function that will be called to figure if an address is an loopback,
287 * LAN, WAN etc. address
289 GNUNET_TRANSPORT_AddressToType get_address_type;
292 * Function that will be called to figure if an address is an loopback,
293 * LAN, WAN etc. address
295 GNUNET_TRANSPORT_UpdateAddressMetrics update_address_metrics;
300 GNUNET_TRANSPORT_RegisterQuotaNotification register_quota_notification;
305 GNUNET_TRANSPORT_UnregisterQuotaNotification unregister_quota_notification;
308 * What is the maximum number of connections that this transport
309 * should allow? Transports that do not have sessions (such as
310 * UDP) can ignore this value.
312 uint32_t max_connections;
318 * Function called by the #GNUNET_TRANSPORT_TransmitFunction
319 * upon "completion". In the case that a peer disconnects,
320 * this function must be called for each pending request
321 * (with a 'failure' indication) AFTER notifying the service
322 * about the disconnect event (so that the service won't try
323 * to transmit more messages, believing the connection still
327 * @param target who was the recipient of the message?
328 * @param result #GNUNET_OK on success
329 * #GNUNET_SYSERR if the target disconnected;
330 * disconnect will ALSO be signalled using
331 * the ReceiveCallback.
332 * @param size_payload bytes of payload from transport service in message
333 * @param size_on_wire bytes required on wire for transmission,
334 * 0 if result == #GNUNET_SYSERR
337 (*GNUNET_TRANSPORT_TransmitContinuation) (void *cls,
338 const struct GNUNET_PeerIdentity *target,
341 size_t size_on_wire);
345 * The new send function with just the session and no address
347 * Function that can be used by the transport service to transmit
348 * a message using the plugin. Note that in the case of a
349 * peer disconnecting, the continuation MUST be called
350 * prior to the disconnect notification itself. This function
351 * will be called with this peer's HELLO message to initiate
352 * a fresh connection to another peer.
355 * @param session which session must be used
356 * @param msgbuf the message to transmit
357 * @param msgbuf_size number of bytes in @a msgbuf
358 * @param priority how important is the message (most plugins will
359 * ignore message priority and just FIFO)
360 * @param to how long to wait at most for the transmission (does not
361 * require plugins to discard the message after the timeout,
362 * just advisory for the desired delay; most plugins will ignore
364 * @param cont continuation to call once the message has
365 * been transmitted (or if the transport is ready
366 * for the next transmission call; or if the
367 * peer disconnected...); can be NULL
368 * @param cont_cls closure for @a cont
369 * @return number of bytes used (on the physical network, with overheads);
370 * -1 on hard errors (i.e. address invalid); 0 is a legal value
371 * and does NOT mean that the message was not transmitted (DV)
374 (*GNUNET_TRANSPORT_TransmitFunction) (void *cls,
375 struct Session *session,
378 unsigned int priority,
379 struct GNUNET_TIME_Relative to,
380 GNUNET_TRANSPORT_TransmitContinuation cont,
385 * Function that can be called to force a disconnect from the
386 * specified neighbour for the given session only. . This should
387 * also cancel all previously scheduled transmissions for this
388 * session. Obviously the transmission may have been partially
389 * completed already, which is OK. The plugin is supposed to close
390 * the connection (if applicable).
392 * @param cls closure with the `struct Plugin`
393 * @param session session to destroy
394 * @return #GNUNET_OK on success
397 (*GNUNET_TRANSPORT_DisconnectSessionFunction) (void *cls,
398 struct Session *session);
401 * Function that is called to get the keepalive factor.
402 * GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT is divided by this number to
403 * calculate the interval between keepalive packets.
405 * @param cls closure with the `struct Plugin`
406 * @return keepalive factor
409 (*GNUNET_TRANSPORT_QueryKeepaliveFactorFunction) (void *cls);
413 * Function that can be called to force a disconnect from the
414 * specified neighbour. This should also cancel all previously
415 * scheduled transmissions. Obviously the transmission may have been
416 * partially completed already, which is OK. The plugin is supposed
417 * to close the connection (if applicable) and no longer call the
418 * transmit continuation(s).
421 * @param target peer for which the last transmission is
425 (*GNUNET_TRANSPORT_DisconnectPeerFunction) (void *cls,
426 const struct GNUNET_PeerIdentity *target);
430 * Function called by the pretty printer for the resolved address for
431 * each human-readable address obtained. The callback can be called
432 * several times. The last invocation must be with a @a address of
433 * NULL and a @a res of #GNUNET_OK. Thus, to indicate conversion
434 * errors, the callback might be called first with @a address NULL and
435 * @a res being #GNUNET_SYSERR. In that case, there must still be a
436 * subsequent call later with @a address NULL and @a res #GNUNET_OK.
439 * @param address one of the names for the host, NULL on last callback
440 * @param res #GNUNET_OK if conversion was successful, #GNUNET_SYSERR on failure,
441 * #GNUNET_OK on last callback
444 (*GNUNET_TRANSPORT_AddressStringCallback) (void *cls,
450 * Convert the transports address to a nice, human-readable
454 * @param type name of the transport that generated the address
455 * @param addr one of the addresses of the host, NULL for the last address
456 * the specific address format depends on the transport
457 * @param addrlen length of the @a addr
458 * @param numeric should (IP) addresses be displayed in numeric form?
459 * @param timeout after how long should we give up?
460 * @param asc function to call on each string
461 * @param asc_cls closure for @a asc
464 (*GNUNET_TRANSPORT_AddressPrettyPrinter) (void *cls,
469 struct GNUNET_TIME_Relative timeout,
470 GNUNET_TRANSPORT_AddressStringCallback asc,
475 * Another peer has suggested an address for this peer and transport
476 * plugin. Check that this could be a valid address. This function
477 * is not expected to 'validate' the address in the sense of trying to
478 * connect to it but simply to see if the binary format is technically
479 * legal for establishing a connection to this peer (and make sure that
480 * the address really corresponds to our network connection/settings
481 * and not some potential man-in-the-middle).
483 * @param addr pointer to the address
484 * @param addrlen length of @a addr
485 * @return #GNUNET_OK if this is a plausible address for this peer
486 * and transport, #GNUNET_SYSERR if not
489 (*GNUNET_TRANSPORT_CheckAddress) (void *cls,
495 * Create a new session to transmit data to the target
496 * This session will used to send data to this peer and the plugin will
497 * notify us by calling the env->session_end function
499 * @param cls the plugin
500 * @param address the hello address
501 * @return the session if the address is valid, NULL otherwise
503 typedef struct Session *
504 (*GNUNET_TRANSPORT_CreateSession) (void *cls,
505 const struct GNUNET_HELLO_Address *address);
509 * Function that will be called whenever the transport service wants to
510 * notify the plugin that a session is still active and in use and
511 * therefore the session timeout for this session has to be updated
514 * @param peer which peer was the session for
515 * @param session which session is being updated
518 (*GNUNET_TRANSPORT_UpdateSessionTimeout) (void *cls,
519 const struct GNUNET_PeerIdentity *peer,
520 struct Session *session);
525 (*GNUNET_TRANSPORT_UpdateInboundDelay) (void *cls,
526 const struct GNUNET_PeerIdentity *peer,
527 struct Session *session,
528 struct GNUNET_TIME_Relative delay);
531 * Function called for a quick conversion of the binary address to
532 * a numeric address. Note that the caller must not free the
533 * address and that the next call to this function is allowed
534 * to override the address again.
537 * @param addr binary address
538 * @param addr_len length of the @a addr
539 * @return string representing the same address
542 (*GNUNET_TRANSPORT_AddressToString) (void *cls,
548 * Function called to convert a string address to
551 * @param cls closure (`struct Plugin*`)
552 * @param addr string address
553 * @param addrlen length of the @a addr including \0 termination
554 * @param buf location to store the buffer
555 * If the function returns #GNUNET_SYSERR, its contents are undefined.
556 * @param added length of created address
557 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
560 (*GNUNET_TRANSPORT_StringToAddress) (void *cls,
568 * Function to obtain the network type for a session
570 * @param cls closure ('struct Plugin*')
571 * @param session the session
572 * @return the network type
574 typedef enum GNUNET_ATS_Network_Type
575 (*GNUNET_TRANSPORT_GetNetworkType) (void *cls,
576 struct Session *session);
580 * Each plugin is required to return a pointer to a struct of this
581 * type as the return value from its entry point.
583 struct GNUNET_TRANSPORT_PluginFunctions
587 * Closure for all of the callbacks.
592 * Function that the transport service will use to transmit data to
593 * another peer. May be NULL for plugins that only support
594 * receiving data. After this call, the plugin call the specified
595 * continuation with success or error before notifying us about the
596 * target having disconnected.
598 GNUNET_TRANSPORT_TransmitFunction send;
601 * Function that can be used to force the plugin to disconnect from
602 * the given peer and cancel all previous transmissions (and their
605 GNUNET_TRANSPORT_DisconnectPeerFunction disconnect_peer;
608 * Function that can be used to force the plugin to disconnect from
609 * the given peer and cancel all previous transmissions (and their
612 GNUNET_TRANSPORT_DisconnectSessionFunction disconnect_session;
615 * Function that will be called whenever the transport service wants to
616 * notify the plugin that a session is still active and in use and
617 * therefore the session timeout for this session has to be updated
619 GNUNET_TRANSPORT_UpdateSessionTimeout update_session_timeout;
621 GNUNET_TRANSPORT_UpdateInboundDelay update_inbound_delay;
624 * Function that will be called whenever the transport service wants to
625 * notify the plugin that the inbound quota changed and that the plugin
626 * should update it's delay for the next receive value
628 //GNUNET_TRANSPORT_UpdateNextReceiveTimeout update_next_receive_timeout;
631 * Function that is used to query keepalive factor.
632 * GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT is divided by this number to
633 * calculate the interval between keepalive packets.
635 GNUNET_TRANSPORT_QueryKeepaliveFactorFunction query_keepalive_factor;
638 * Function to pretty-print addresses.
640 GNUNET_TRANSPORT_AddressPrettyPrinter address_pretty_printer;
643 * Function that will be called to check if a binary address
644 * for this plugin is well-formed and corresponds to an
645 * address for THIS peer (as per our configuration). Naturally,
646 * if absolutely necessary, plugins can be a bit conservative in
647 * their answer, but in general plugins should make sure that the
648 * address does not redirect traffic to a 3rd party that might
649 * try to man-in-the-middle our traffic.
651 GNUNET_TRANSPORT_CheckAddress check_address;
654 * Function that will be called to convert a binary address
655 * to a string (numeric conversion only).
657 GNUNET_TRANSPORT_AddressToString address_to_string;
660 * Function that will be called to convert a string address
661 * to binary (numeric conversion only).
663 GNUNET_TRANSPORT_StringToAddress string_to_address;
666 * Function that will be called tell the plugin to create a session
669 GNUNET_TRANSPORT_CreateSession get_session;
672 * Function to obtain the network type for a session
674 GNUNET_TRANSPORT_GetNetworkType get_network;
678 /*#ifndef PLUGIN_TRANSPORT_H*/
680 /* end of gnunet_transport_plugin.h */