src/include/gnunet_transport_plugin.h

   1 /*
   2      This file is part of GNUnet
   3      Copyright (C) 2009-2014 GNUnet e.V.
   4
   5      GNUnet is free software: you can redistribute it and/or modify it
   6      under the terms of the GNU Affero General Public License as published
   7      by the Free Software Foundation, either version 3 of the License,
   8      or (at your option) any later version.
   9
  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      Affero General Public License for more details.
  14 */
  15
  16 /**
  17  * @author Christian Grothoff
  18  *
  19  * @file
  20  * Transport service plugin API
  21  *
  22  * @defgroup transport-plugin  Transport Service plugin API
  23  *
  24  * Specifies the struct that is given to the plugin's entry method and the other
  25  * struct that must be returned.  Note that the destructors of transport plugins
  26  * will be given the value returned by the constructor and is expected to return
  27  * a NULL pointer.
  28  *
  29  * @{
  30  */
  31 #ifndef PLUGIN_TRANSPORT_H
  32 #define PLUGIN_TRANSPORT_H
  33
  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"
  39
  40 #define TRANSPORT_SESSION_INBOUND_STRING "<inbound>"
  41
  42 /**
  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.
  50  *
  51  * Each 'struct GNUNET_ATS_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).
  54  */
  55 struct GNUNET_ATS_Session;
  56
  57
  58 /**
  59  * Function that will be called whenever the plugin internally
  60  * cleans up a session pointer and hence the service needs to
  61  * discard all of those sessions as well.  Plugins that do not
  62  * use sessions can simply omit calling this function and always
  63  * use NULL wherever a session pointer is needed.  This function
  64  * should be called BEFORE a potential "TransmitContinuation"
  65  * from the "TransmitFunction".
  66  *
  67  * @param cls closure
  68  * @param peer which peer was the session for
  69  * @param session which session is being destroyed
  70  */
  71 typedef void
  72 (*GNUNET_TRANSPORT_SessionEnd) (void *cls,
  73                                 const struct GNUNET_HELLO_Address *address,
  74                                 struct GNUNET_ATS_Session *session);
  75
  76
  77 /**
  78  * Plugin tells transport service about a new inbound session
  79  *
  80  * @param cls unused
  81  * @param address the address
  82  * @param session the new session
  83  * @param net network information
  84  */
  85 typedef void
  86 (*GNUNET_TRANSPORT_SessionStart) (void *cls,
  87                                   const struct GNUNET_HELLO_Address *address,
  88                                   struct GNUNET_ATS_Session *session,
  89                                   enum GNUNET_ATS_Network_Type net);
  90
  91
  92 /**
  93  * Function called by the transport for each received message.
  94  * This function should also be called with "NULL" for the
  95  * message to signal that the other peer disconnected.
  96  *
  97  * @param cls closure
  98  * @param peer (claimed) identity of the other peer
  99  * @param message the message, NULL if we only care about
 100  *                learning about the delay until we should receive again
 101  * @param session identifier used for this session (NULL for plugins
 102  *                that do not offer bi-directional communication to the sender
 103  *                using the same "connection")
 104  * @param sender_address binary address of the sender (if we established the
 105  *                connection or are otherwise sure of it; should be NULL
 106  *                for inbound TCP/UDP connections since it it not clear
 107  *                that we could establish ourselves a connection to that
 108  *                IP address and get the same system)
 109  * @param sender_address_len number of bytes in @a sender_address
 110  * @return how long the plugin should wait until receiving more data;
 111  *         returning #GNUNET_TIME_UNIT_FOREVER_REL means that the
 112  *         connection should be closed
 113  */
 114 typedef struct GNUNET_TIME_Relative
 115 (*GNUNET_TRANSPORT_PluginReceiveCallback) (void *cls,
 116                                            const struct GNUNET_HELLO_Address *address,
 117                                            struct GNUNET_ATS_Session *session,
 118                                            const struct GNUNET_MessageHeader *message);
 119
 120
 121 /**
 122  * Function that can be called by plugins to figure if an address is
 123  * an loopback, LAN or WAN address.   Ultimately invokes
 124  * #GNUNET_ATS_address_get_type().
 125  *
 126  * @param cls closure
 127  * @param addr binary address
 128  * @param addrlen length of the @a addr
 129  * @return type of the network the address belongs to
 130  */
 131 typedef enum GNUNET_ATS_Network_Type
 132 (*GNUNET_TRANSPORT_AddressToType) (void *cls,
 133                                    const struct sockaddr *addr,
 134                                    size_t addrlen);
 135
 136
 137 /**
 138  * Function called when distance of an address changes.
 139  *
 140  * @param cls closure
 141  * @param peer peer
 142  * @param distance new distance
 143  */
 144 typedef void
 145 (*GNUNET_TRANSPORT_UpdateAddressDistance) (void *cls,
 146                                            const struct GNUNET_HELLO_Address *address,
 147                                            uint32_t distance);
 148
 149
 150 /**
 151  * Function that will be called for each address the transport
 152  * is aware that it might be reachable under.
 153  *
 154  * @param cls closure
 155  * @param add_remove should the address added (#GNUNET_YES) or removed (#GNUNET_NO) from the
 156  *                   set of valid addresses?
 157  * @param address the address to add or remove
 158  */
 159 typedef void
 160 (*GNUNET_TRANSPORT_AddressNotification) (void *cls,
 161                                          int add_remove,
 162                                          const struct GNUNET_HELLO_Address *address);
 163
 164
 165 /**
 166  * Function that will be called whenever the plugin receives data over
 167  * the network and wants to determine how long it should wait until
 168  * the next time it reads from the given peer.  Note that some plugins
 169  * (such as UDP) may not be able to wait (for a particular peer), so
 170  * the waiting part is optional.  Plugins that can wait should call
 171  * this function, sleep the given amount of time, and call it again
 172  * (with zero bytes read) UNTIL it returns zero and only then read.
 173  *
 174  * @param cls closure
 175  * @param peer which peer did we read data from
 176  * @param amount_recved number of bytes read (can be zero)
 177  * @return how long to wait until reading more from this peer
 178  *         (to enforce inbound quotas); returning #GNUNET_TIME_UNIT_FOREVER_REL
 179  *         means that the connection should be closed
 180  */
 181 typedef struct GNUNET_TIME_Relative
 182 (*GNUNET_TRANSPORT_TrafficReport) (void *cls,
 183                                    const struct GNUNET_PeerIdentity *peer,
 184                                    size_t amount_recved);
 185
 186
 187 /**
 188  * Function that returns a HELLO message.
 189  *
 190  * @return HELLO message (FIXME with what?)
 191  */
 192 typedef const struct GNUNET_MessageHeader *
 193 (*GNUNET_TRANSPORT_GetHelloCallback) (void);
 194
 195
 196 /**
 197  * The transport service will pass a pointer to a struct
 198  * of this type as the first and only argument to the
 199  * entry point of each transport plugin.
 200  */
 201 struct GNUNET_TRANSPORT_PluginEnvironment
 202 {
 203   /**
 204    * Configuration to use.
 205    */
 206   const struct GNUNET_CONFIGURATION_Handle *cfg;
 207
 208   /**
 209    * Identity of this peer.
 210    */
 211   const struct GNUNET_PeerIdentity *my_identity;
 212
 213   /**
 214    * Closure for the various callbacks.
 215    */
 216   void *cls;
 217
 218   /**
 219    * Handle for reporting statistics.
 220    */
 221   struct GNUNET_STATISTICS_Handle *stats;
 222
 223   /**
 224    * Function that should be called by the transport plugin
 225    * whenever a message is received.  If this field is "NULL",
 226    * the plugin should load in 'stub' mode and NOT fully
 227    * initialize and instead only return an API with the
 228    * @e address_pretty_printer, @e address_to_string and
 229    * @e string_to_address functions.
 230    */
 231   GNUNET_TRANSPORT_PluginReceiveCallback receive;
 232
 233   /**
 234    * Function that returns our HELLO.
 235    */
 236   GNUNET_TRANSPORT_GetHelloCallback get_our_hello;
 237
 238   /**
 239    * Function that must be called by each plugin to notify the
 240    * transport service about the addresses under which the transport
 241    * provided by the plugin can be reached.
 242    */
 243   GNUNET_TRANSPORT_AddressNotification notify_address;
 244
 245   /**
 246    * Function that must be called by the plugin when a non-NULL
 247    * session handle stops being valid (is destroyed).
 248    */
 249   GNUNET_TRANSPORT_SessionEnd session_end;
 250
 251   /**
 252    * Function called by the plugin when a new (incoming) session was created
 253    * not explicitly created using the the get_session function
 254    */
 255   GNUNET_TRANSPORT_SessionStart session_start;
 256
 257   /**
 258    * Function that will be called to figure if an address is an loopback,
 259    * LAN, WAN etc. address
 260    */
 261   GNUNET_TRANSPORT_AddressToType get_address_type;
 262
 263   /**
 264    * Function that will be called by DV to update distance for
 265    * an address.
 266    */
 267   GNUNET_TRANSPORT_UpdateAddressDistance update_address_distance;
 268
 269   /**
 270    * What is the maximum number of connections that this transport
 271    * should allow?  Transports that do not have sessions (such as
 272    * UDP) can ignore this value.
 273    */
 274   uint32_t max_connections;
 275
 276 };
 277
 278
 279 /**
 280  * Function called by the #GNUNET_TRANSPORT_TransmitFunction
 281  * upon "completion".  In the case that a peer disconnects,
 282  * this function must be called for each pending request
 283  * (with a 'failure' indication) AFTER notifying the service
 284  * about the disconnect event (so that the service won't try
 285  * to transmit more messages, believing the connection still
 286  * exists...).
 287  *
 288  * @param cls closure
 289  * @param target who was the recipient of the message?
 290  * @param result #GNUNET_OK on success
 291  *               #GNUNET_SYSERR if the target disconnected;
 292  *               disconnect will ALSO be signalled using
 293  *               the ReceiveCallback.
 294  * @param size_payload bytes of payload from transport service in message
 295  * @param size_on_wire bytes required on wire for transmission,
 296  *               0 if result == #GNUNET_SYSERR
 297  */
 298 typedef void
 299 (*GNUNET_TRANSPORT_TransmitContinuation) (void *cls,
 300                                           const struct GNUNET_PeerIdentity *target,
 301                                           int result,
 302                                           size_t size_payload,
 303                                           size_t size_on_wire);
 304
 305
 306 /**
 307  * The new send function with just the session and no address
 308  *
 309  * Function that can be used by the transport service to transmit
 310  * a message using the plugin.   Note that in the case of a
 311  * peer disconnecting, the continuation MUST be called
 312  * prior to the disconnect notification itself.  This function
 313  * will be called with this peer's HELLO message to initiate
 314  * a fresh connection to another peer.
 315  *
 316  * @param cls closure
 317  * @param session which session must be used
 318  * @param msgbuf the message to transmit
 319  * @param msgbuf_size number of bytes in @a msgbuf
 320  * @param priority how important is the message (most plugins will
 321  *                 ignore message priority and just FIFO)
 322  * @param to how long to wait at most for the transmission (does not
 323  *                require plugins to discard the message after the timeout,
 324  *                just advisory for the desired delay; most plugins will ignore
 325  *                this as well)
 326  * @param cont continuation to call once the message has
 327  *        been transmitted (or if the transport is ready
 328  *        for the next transmission call; or if the
 329  *        peer disconnected...); can be NULL
 330  * @param cont_cls closure for @a cont
 331  * @return number of bytes used (on the physical network, with overheads);
 332  *         -1 on hard errors (i.e. address invalid); 0 is a legal value
 333  *         and does NOT mean that the message was not transmitted (DV)
 334  */
 335 typedef ssize_t
 336 (*GNUNET_TRANSPORT_TransmitFunction) (void *cls,
 337                                       struct GNUNET_ATS_Session *session,
 338                                       const char *msgbuf,
 339                                       size_t msgbuf_size,
 340                                       unsigned int priority,
 341                                       struct GNUNET_TIME_Relative to,
 342                                       GNUNET_TRANSPORT_TransmitContinuation cont,
 343                                       void *cont_cls);
 344
 345
 346 /**
 347  * Function that can be called to force a disconnect from the
 348  * specified neighbour for the given session only.  .  This should
 349  * also cancel all previously scheduled transmissions for this
 350  * session.  Obviously the transmission may have been partially
 351  * completed already, which is OK.  The plugin is supposed to close
 352  * the connection (if applicable).
 353  *
 354  * @param cls closure with the `struct Plugin`
 355  * @param session session to destroy
 356  * @return #GNUNET_OK on success
 357  */
 358 typedef int
 359 (*GNUNET_TRANSPORT_DisconnectSessionFunction) (void *cls,
 360                                                struct GNUNET_ATS_Session *session);
 361
 362
 363 /**
 364  * Function that is called to get the keepalive factor.
 365  * #GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT is divided by this number to
 366  * calculate the interval between keepalive packets.
 367  *
 368  * @param cls closure with the `struct Plugin`
 369  * @return keepalive factor
 370  */
 371 typedef unsigned int
 372 (*GNUNET_TRANSPORT_QueryKeepaliveFactorFunction) (void *cls);
 373
 374
 375 /**
 376  * Function that can be called to force a disconnect from the
 377  * specified neighbour.  This should also cancel all previously
 378  * scheduled transmissions.  Obviously the transmission may have been
 379  * partially completed already, which is OK.  The plugin is supposed
 380  * to close the connection (if applicable) and no longer call the
 381  * transmit continuation(s).
 382  *
 383  * @param cls closure
 384  * @param target peer for which the last transmission is
 385  *        to be cancelled
 386  */
 387 typedef void
 388 (*GNUNET_TRANSPORT_DisconnectPeerFunction) (void *cls,
 389                                             const struct GNUNET_PeerIdentity *target);
 390
 391
 392 /**
 393  * Function called by the pretty printer for the resolved address for
 394  * each human-readable address obtained.  The callback can be called
 395  * several times. The last invocation must be with a @a address of
 396  * NULL and a @a res of #GNUNET_OK.  Thus, to indicate conversion
 397  * errors, the callback might be called first with @a address NULL and
 398  * @a res being #GNUNET_SYSERR.  In that case, there must still be a
 399  * subsequent call later with @a address NULL and @a res #GNUNET_OK.
 400  *
 401  * @param cls closure
 402  * @param address one of the names for the host, NULL on last callback
 403  * @param res #GNUNET_OK if conversion was successful, #GNUNET_SYSERR on failure,
 404  *      #GNUNET_OK on last callback
 405  */
 406 typedef void
 407 (*GNUNET_TRANSPORT_AddressStringCallback) (void *cls,
 408                                            const char *address,
 409                                            int res);
 410
 411
 412 /**
 413  * Convert the transports address to a nice, human-readable
 414  * format.
 415  *
 416  * @param cls closure
 417  * @param type name of the transport that generated the address
 418  * @param addr one of the addresses of the host, NULL for the last address
 419  *        the specific address format depends on the transport
 420  * @param addrlen length of the @a addr
 421  * @param numeric should (IP) addresses be displayed in numeric form?
 422  * @param timeout after how long should we give up?
 423  * @param asc function to call on each string
 424  * @param asc_cls closure for @a asc
 425  */
 426 typedef void
 427 (*GNUNET_TRANSPORT_AddressPrettyPrinter) (void *cls,
 428                                           const char *type,
 429                                           const void *addr,
 430                                           size_t addrlen,
 431                                           int numeric,
 432                                           struct GNUNET_TIME_Relative timeout,
 433                                           GNUNET_TRANSPORT_AddressStringCallback asc,
 434                                           void *asc_cls);
 435
 436
 437 /**
 438  * Another peer has suggested an address for this peer and transport
 439  * plugin.  Check that this could be a valid address.  This function
 440  * is not expected to 'validate' the address in the sense of trying to
 441  * connect to it but simply to see if the binary format is technically
 442  * legal for establishing a connection to this peer (and make sure that
 443  * the address really corresponds to our network connection/settings
 444  * and not some potential man-in-the-middle).
 445  *
 446  * @param addr pointer to the address
 447  * @param addrlen length of @a addr
 448  * @return #GNUNET_OK if this is a plausible address for this peer
 449  *         and transport, #GNUNET_SYSERR if not
 450  */
 451 typedef int
 452 (*GNUNET_TRANSPORT_CheckAddress) (void *cls,
 453                                   const void *addr,
 454                                   size_t addrlen);
 455
 456
 457 /**
 458  * Create a new session to transmit data to the target
 459  * This session will used to send data to this peer and the plugin will
 460  * notify us by calling the env->session_end function
 461  *
 462  * @param cls the plugin
 463  * @param address the hello address
 464  * @return the session if the address is valid, NULL otherwise
 465  */
 466 typedef struct GNUNET_ATS_Session *
 467 (*GNUNET_TRANSPORT_CreateSession) (void *cls,
 468                                    const struct GNUNET_HELLO_Address *address);
 469
 470
 471 /**
 472  * Function that will be called whenever the transport service wants to
 473  * notify the plugin that a session is still active and in use and
 474  * therefore the session timeout for this session has to be updated
 475  *
 476  * @param cls closure
 477  * @param peer which peer was the session for
 478  * @param session which session is being updated
 479  */
 480 typedef void
 481 (*GNUNET_TRANSPORT_UpdateSessionTimeout) (void *cls,
 482                                           const struct GNUNET_PeerIdentity *peer,
 483                                           struct GNUNET_ATS_Session *session);
 484
 485
 486 /**
 487  * Function that will be called whenever the transport service wants to
 488  * notify the plugin that the inbound quota changed and that the plugin
 489  * should update it's delay for the next receive value
 490  *
 491  * @param cls closure
 492  * @param peer which peer was the session for
 493  * @param session which session is being updated
 494  * @param delay new delay to use for receiving
 495  */
 496 typedef void
 497 (*GNUNET_TRANSPORT_UpdateInboundDelay) (void *cls,
 498                                         const struct GNUNET_PeerIdentity *peer,
 499                                         struct GNUNET_ATS_Session *session,
 500                                         struct GNUNET_TIME_Relative delay);
 501
 502
 503 /**
 504  * Function called for a quick conversion of the binary address to
 505  * a numeric address.  Note that the caller must not free the
 506  * address and that the next call to this function is allowed
 507  * to override the address again.
 508  *
 509  * @param cls closure
 510  * @param addr binary address
 511  * @param addr_len length of the @a addr
 512  * @return string representing the same address
 513  */
 514 typedef const char *
 515 (*GNUNET_TRANSPORT_AddressToString) (void *cls,
 516                                      const void *addr,
 517                                      size_t addrlen);
 518
 519
 520 /**
 521  * Function called to convert a string address to
 522  * a binary address.
 523  *
 524  * @param cls closure (`struct Plugin*`)
 525  * @param addr string address
 526  * @param addrlen length of the @a addr including \0 termination
 527  * @param buf location to store the buffer
 528  *        If the function returns #GNUNET_SYSERR, its contents are undefined.
 529  * @param added length of created address
 530  * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
 531  */
 532 typedef int
 533 (*GNUNET_TRANSPORT_StringToAddress) (void *cls,
 534                                      const char *addr,
 535                                      uint16_t addrlen,
 536                                      void **buf,
 537                                      size_t *added);
 538
 539
 540 /**
 541  * Function to obtain the network type for a session
 542  *
 543  * @param cls closure (`struct Plugin *`)
 544  * @param session the session
 545  * @return the network type
 546  */
 547 typedef enum GNUNET_ATS_Network_Type
 548 (*GNUNET_TRANSPORT_GetNetworkType) (void *cls,
 549                                     struct GNUNET_ATS_Session *session);
 550
 551
 552 /**
 553  * Function to obtain the network type for an address.
 554  *
 555  * @param cls closure (`struct Plugin *`)
 556  * @param address the address
 557  * @return the network type
 558  */
 559 typedef enum GNUNET_ATS_Network_Type
 560 (*GNUNET_TRANSPORT_GetNetworkTypeForAddress) (void *cls,
 561                                               const struct GNUNET_HELLO_Address *address);
 562
 563
 564 /**
 565  * Function called by the plugin with information about the
 566  * current sessions managed by the plugin (for monitoring).
 567  *
 568  * @param cls closure
 569  * @param session session handle this information is about,
 570  *        NULL to indicate that we are "in sync" (initial
 571  *        iteration complete)
 572  * @param info information about the state of the session,
 573  *        NULL if @a session is also NULL and we are
 574  *        merely signalling that the initial iteration is over
 575  */
 576 typedef void
 577 (*GNUNET_TRANSPORT_SessionInfoCallback) (void *cls,
 578                                          struct GNUNET_ATS_Session *session,
 579                                          const struct GNUNET_TRANSPORT_SessionInfo *info);
 580
 581
 582 /**
 583  * Begin monitoring sessions of a plugin.  There can only
 584  * be one active monitor per plugin (i.e. if there are
 585  * multiple monitors, the transport service needs to
 586  * multiplex the generated events over all of them).
 587  *
 588  * @param cls closure of the plugin
 589  * @param sic callback to invoke, NULL to disable monitor;
 590  *            plugin will being by iterating over all active
 591  *            sessions immediately and then enter monitor mode
 592  * @param sic_cls closure for @a sic
 593  */
 594 typedef void
 595 (*GNUNET_TRANSPORT_SessionMonitorSetup) (void *cls,
 596                                          GNUNET_TRANSPORT_SessionInfoCallback sic,
 597                                          void *sic_cls);
 598
 599
 600 /**
 601  * Each plugin is required to return a pointer to a struct of this
 602  * type as the return value from its entry point.
 603  */
 604 struct GNUNET_TRANSPORT_PluginFunctions
 605 {
 606
 607   /**
 608    * Closure for all of the callbacks.
 609    */
 610   void *cls;
 611
 612   /**
 613    * Function that the transport service will use to transmit data to
 614    * another peer.  May be NULL for plugins that only support
 615    * receiving data.  After this call, the plugin call the specified
 616    * continuation with success or error before notifying us about the
 617    * target having disconnected.
 618    */
 619   GNUNET_TRANSPORT_TransmitFunction send;
 620
 621   /**
 622    * Function that can be used to force the plugin to disconnect from
 623    * the given peer and cancel all previous transmissions (and their
 624    * continuations).
 625    */
 626   GNUNET_TRANSPORT_DisconnectPeerFunction disconnect_peer;
 627
 628   /**
 629    * Function that can be used to force the plugin to disconnect from
 630    * the given peer and cancel all previous transmissions (and their
 631    * continuations).
 632    */
 633   GNUNET_TRANSPORT_DisconnectSessionFunction disconnect_session;
 634
 635   /**
 636    * Function that will be called whenever the transport service wants to
 637    * notify the plugin that a session is still active and in use and
 638    * therefore the session timeout for this session has to be updated
 639    */
 640   GNUNET_TRANSPORT_UpdateSessionTimeout update_session_timeout;
 641
 642   /**
 643    * Function that will be called whenever the transport service wants to
 644    * notify the plugin that the inbound quota changed and that the plugin
 645    * should update it's delay for the next receive value
 646    */
 647   GNUNET_TRANSPORT_UpdateInboundDelay update_inbound_delay;
 648
 649   /**
 650    * Function that is used to query keepalive factor.
 651    * #GNUNET_CONSTANTS_IDLE_CONNECTION_TIMEOUT is divided by this number to
 652    * calculate the interval between keepalive packets.
 653    */
 654   GNUNET_TRANSPORT_QueryKeepaliveFactorFunction query_keepalive_factor;
 655
 656   /**
 657    * Function to pretty-print addresses.
 658    */
 659   GNUNET_TRANSPORT_AddressPrettyPrinter address_pretty_printer;
 660
 661   /**
 662    * Function that will be called to check if a binary address
 663    * for this plugin is well-formed and corresponds to an
 664    * address for THIS peer (as per our configuration).  Naturally,
 665    * if absolutely necessary, plugins can be a bit conservative in
 666    * their answer, but in general plugins should make sure that the
 667    * address does not redirect traffic to a 3rd party that might
 668    * try to man-in-the-middle our traffic.
 669    */
 670   GNUNET_TRANSPORT_CheckAddress check_address;
 671
 672   /**
 673    * Function that will be called to convert a binary address
 674    * to a string (numeric conversion only).
 675    */
 676   GNUNET_TRANSPORT_AddressToString address_to_string;
 677
 678   /**
 679    * Function that will be called to convert a string address
 680    * to binary (numeric conversion only).
 681    */
 682   GNUNET_TRANSPORT_StringToAddress string_to_address;
 683
 684   /**
 685    * Function that will be called tell the plugin to create a session
 686    * object.
 687    */
 688   GNUNET_TRANSPORT_CreateSession get_session;
 689
 690   /**
 691    * Function to obtain the network type for a session
 692    */
 693   GNUNET_TRANSPORT_GetNetworkType get_network;
 694
 695   /**
 696    * Function to obtain the network type for an address
 697    */
 698   GNUNET_TRANSPORT_GetNetworkTypeForAddress get_network_for_address;
 699
 700   /**
 701    * Function to monitor the sessions managed by the plugin.
 702    */
 703   GNUNET_TRANSPORT_SessionMonitorSetup setup_monitor;
 704 };
 705
 706
 707 /*#ifndef PLUGIN_TRANSPORT_H*/
 708 #endif
 709
 710 /** @} */  /* end of group */
 711
 712 /* end of gnunet_transport_plugin.h */