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