src/include/gnunet_transport_service.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009, 2010, 2011 Christian Grothoff (and other contributing authors)
   4
   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.
   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      General Public License for more details.
  14
  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.
  19 */
  20
  21 /**
  22  * @file include/gnunet_transport_service.h
  23  * @brief low-level P2P IO
  24  * @author Christian Grothoff
  25  */
  26
  27 #ifndef GNUNET_TRANSPORT_SERVICE_H
  28 #define GNUNET_TRANSPORT_SERVICE_H
  29
  30 #ifdef __cplusplus
  31 extern "C"
  32 {
  33 #if 0                           /* keep Emacsens' auto-indent happy */
  34 }
  35 #endif
  36 #endif
  37
  38 #include "gnunet_util_lib.h"
  39 #include "gnunet_ats_service.h"
  40
  41 /**
  42  * Version number of the transport API.
  43  */
  44 #define GNUNET_TRANSPORT_VERSION 0x00000000
  45
  46
  47 /**
  48  * Function called by the transport for each received message.
  49  *
  50  * @param cls closure
  51  * @param peer (claimed) identity of the other peer
  52  * @param message the message
  53  * @param ats performance data
  54  * @param ats_count number of entries in ats
  55  */
  56 typedef void (*GNUNET_TRANSPORT_ReceiveCallback) (void *cls,
  57                                                   const struct
  58                                                   GNUNET_PeerIdentity * peer,
  59                                                   const struct
  60                                                   GNUNET_MessageHeader *
  61                                                   message,
  62                                                   const struct
  63                                                   GNUNET_ATS_Information * ats,
  64                                                   uint32_t ats_count);
  65
  66
  67 /**
  68  * Opaque handle to the service.
  69  */
  70 struct GNUNET_TRANSPORT_Handle;
  71
  72
  73 /**
  74  * Function called to notify transport users that another
  75  * peer connected to us.
  76  *
  77  * @param cls closure
  78  * @param peer the peer that connected
  79  * @param ats performance data
  80  * @param ats_count number of entries in ats (excluding 0-termination)
  81  */
  82 typedef void (*GNUNET_TRANSPORT_NotifyConnect) (void *cls,
  83                                                 const struct GNUNET_PeerIdentity
  84                                                 * peer,
  85                                                 const struct
  86                                                 GNUNET_ATS_Information * ats,
  87                                                 uint32_t ats_count);
  88
  89 /**
  90  * Function called to notify transport users that another
  91  * peer disconnected from us.
  92  *
  93  * @param cls closure
  94  * @param peer the peer that disconnected
  95  */
  96 typedef void (*GNUNET_TRANSPORT_NotifyDisconnect) (void *cls,
  97                                                    const struct
  98                                                    GNUNET_PeerIdentity * peer);
  99
 100
 101 /**
 102  * Function to call with a textual representation of an address.
 103  * This function will be called several times with different possible
 104  * textual representations, and a last time with NULL to signal the end
 105  * of the iteration.
 106  *
 107  * @param cls closure
 108  * @param address NULL on error or end of iteration,
 109  *        otherwise 0-terminated printable UTF-8 string
 110  */
 111 typedef void (*GNUNET_TRANSPORT_AddressToStringCallback) (void *cls,
 112                                                           const char *address);
 113
 114
 115 /**
 116  * Function to call with a binary format of an address
 117  *
 118  * @param cls closure
 119  * @param peer peer this update is about (never NULL)
 120  * @param address address, NULL for disconnect notification in monitor mode
 121  */
 122 typedef void (*GNUNET_TRANSPORT_PeerIterateCallback) (void *cls,
 123                                                       const struct
 124                                                       GNUNET_PeerIdentity *
 125                                                       peer,
 126                                                       const struct
 127                                                       GNUNET_HELLO_Address *
 128                                                       address);
 129
 130
 131 /**
 132  * Connect to the transport service.  Note that the connection may
 133  * complete (or fail) asynchronously.
 134  *
 135  * @param cfg configuration to use
 136  * @param self our own identity (API should check that it matches
 137  *             the identity found by transport), or NULL (no check)
 138  * @param cls closure for the callbacks
 139  * @param rec receive function to call
 140  * @param nc function to call on connect events
 141  * @param nd function to call on disconnect events
 142  * @return NULL on error
 143  */
 144 struct GNUNET_TRANSPORT_Handle *
 145 GNUNET_TRANSPORT_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
 146                           const struct GNUNET_PeerIdentity *self, void *cls,
 147                           GNUNET_TRANSPORT_ReceiveCallback rec,
 148                           GNUNET_TRANSPORT_NotifyConnect nc,
 149                           GNUNET_TRANSPORT_NotifyDisconnect nd);
 150
 151
 152 /**
 153  * Disconnect from the transport service.
 154  *
 155  * @param handle handle returned from connect
 156  */
 157 void
 158 GNUNET_TRANSPORT_disconnect (struct GNUNET_TRANSPORT_Handle *handle);
 159
 160
 161 /**
 162  * Ask the transport service to establish a connection to
 163  * the given peer.
 164  *
 165  * @param handle connection to transport service
 166  * @param target who we should try to connect to
 167  */
 168 void
 169 GNUNET_TRANSPORT_try_connect (struct GNUNET_TRANSPORT_Handle *handle,
 170                               const struct GNUNET_PeerIdentity *target);
 171
 172
 173 /**
 174  * Opaque handle for a transmission-ready request.
 175  */
 176 struct GNUNET_TRANSPORT_TransmitHandle;
 177
 178
 179 /**
 180  * Check if we could queue a message of the given size for
 181  * transmission.  The transport service will take both its internal
 182  * buffers and bandwidth limits imposed by the other peer into
 183  * consideration when answering this query.
 184  *
 185  * @param handle connection to transport service
 186  * @param target who should receive the message
 187  * @param size how big is the message we want to transmit?
 188  * @param priority how important is the message? @deprecated - remove?
 189  * @param timeout after how long should we give up (and call
 190  *        notify with buf NULL and size 0)?
 191  * @param notify function to call when we are ready to
 192  *        send such a message
 193  * @param notify_cls closure for notify
 194  * @return NULL if someone else is already waiting to be notified
 195  *         non-NULL if the notify callback was queued (can be used to cancel
 196  *         using GNUNET_TRANSPORT_notify_transmit_ready_cancel)
 197  */
 198 struct GNUNET_TRANSPORT_TransmitHandle *
 199 GNUNET_TRANSPORT_notify_transmit_ready (struct GNUNET_TRANSPORT_Handle *handle,
 200                                         const struct GNUNET_PeerIdentity
 201                                         *target, size_t size, uint32_t priority,
 202                                         struct GNUNET_TIME_Relative timeout,
 203                                         GNUNET_CONNECTION_TransmitReadyNotify
 204                                         notify, void *notify_cls);
 205
 206
 207 /**
 208  * Cancel the specified transmission-ready notification.
 209  *
 210  * @param th handle of the transmission notification request to cancel
 211  */
 212 void
 213 GNUNET_TRANSPORT_notify_transmit_ready_cancel (struct
 214                                                GNUNET_TRANSPORT_TransmitHandle
 215                                                *th);
 216
 217
 218
 219 /**
 220  * Function called whenever there is an update to the
 221  * HELLO of this peer.
 222  *
 223  * @param cls closure
 224  * @param hello our updated HELLO
 225  */
 226 typedef void (*GNUNET_TRANSPORT_HelloUpdateCallback) (void *cls,
 227                                                       const struct
 228                                                       GNUNET_MessageHeader *
 229                                                       hello);
 230
 231
 232 /**
 233  * Handle to cancel a 'GNUNET_TRANSPORT_get_hello' operation.
 234  */
 235 struct GNUNET_TRANSPORT_GetHelloHandle;
 236
 237
 238 /**
 239  * Obtain updates on changes to the HELLO message for this peer.
 240  *
 241  * @param handle connection to transport service
 242  * @param rec function to call with the HELLO
 243  * @param rec_cls closure for rec
 244  * @return handle to cancel the operation
 245  */
 246 struct GNUNET_TRANSPORT_GetHelloHandle *
 247 GNUNET_TRANSPORT_get_hello (struct GNUNET_TRANSPORT_Handle *handle,
 248                             GNUNET_TRANSPORT_HelloUpdateCallback rec,
 249                             void *rec_cls);
 250
 251
 252 /**
 253  * Stop receiving updates about changes to our HELLO message.
 254  *
 255  * @param ghh handle returned from 'GNUNET_TRANSPORT_get_hello')
 256  */
 257 void
 258 GNUNET_TRANSPORT_get_hello_cancel (struct GNUNET_TRANSPORT_GetHelloHandle *ghh);
 259
 260
 261 /**
 262  * Offer the transport service the HELLO of another peer.  Note that
 263  * the transport service may just ignore this message if the HELLO is
 264  * malformed or useless due to our local configuration.
 265  *
 266  * @param handle connection to transport service
 267  * @param hello the hello message
 268  * @param cont continuation to call when HELLO has been sent
 269  * @param cls closure for continuation
 270  */
 271 void
 272 GNUNET_TRANSPORT_offer_hello (struct GNUNET_TRANSPORT_Handle *handle,
 273                               const struct GNUNET_MessageHeader *hello,
 274                               GNUNET_SCHEDULER_Task cont, void *cls);
 275
 276
 277 /**
 278  * Handle to cancel a pending address lookup.
 279  */
 280 struct GNUNET_TRANSPORT_AddressToStringContext;
 281
 282
 283 /**
 284  * Convert a binary address into a human readable address.
 285  *
 286  * @param cfg configuration to use
 287  * @param address address to convert (binary format)
 288  * @param addressLen number of bytes in address
 289  * @param numeric should (IP) addresses be displayed in numeric form
 290  *                (otherwise do reverse DNS lookup)
 291  * @param nameTrans name of the transport to which the address belongs
 292  * @param timeout how long is the lookup allowed to take at most
 293  * @param aluc function to call with the results
 294  * @param aluc_cls closure for aluc
 295  * @return handle to cancel the operation, NULL on error
 296  */
 297 struct GNUNET_TRANSPORT_AddressToStringContext *
 298 GNUNET_TRANSPORT_address_to_string (const struct GNUNET_CONFIGURATION_Handle
 299                                     *cfg,
 300                                     const struct GNUNET_HELLO_Address *address,
 301                                     int numeric,
 302                                     struct GNUNET_TIME_Relative timeout,
 303                                     GNUNET_TRANSPORT_AddressToStringCallback
 304                                     aluc, void *aluc_cls);
 305
 306
 307 /**
 308  * Cancel request for address conversion.
 309  *
 310  * @param alc handle for the request to cancel
 311  */
 312 void
 313 GNUNET_TRANSPORT_address_to_string_cancel (struct
 314                                            GNUNET_TRANSPORT_AddressToStringContext
 315                                            *alc);
 316
 317
 318 /**
 319  * Return all the known addresses for a specific peer or all peers.
 320  * Returns continously all address if one_shot is set to GNUNET_NO
 321  *
 322  * CHANGE: Returns the address(es) that we are currently using for this
 323  * peer.  Upon completion, the 'AddressLookUpCallback' is called one more
 324  * time with 'NULL' for the address and the peer.  After this, the operation must no
 325  * longer be explicitly cancelled.
 326  *
 327  * @param cfg configuration to use
 328  * @param peer peer identity to look up the addresses of, CHANGE: allow NULL for all (connected) peers
 329  * @param one_shot GNUNET_YES to return the current state and then end (with NULL+NULL),
 330  *                 GNUNET_NO to monitor the set of addresses used (continuously, must be explicitly canceled, NOT implemented yet!)
 331  * @param timeout how long is the lookup allowed to take at most
 332  * @param peer_address_callback function to call with the results
 333  * @param peer_address_callback_cls closure for peer_address_callback
 334  */
 335 struct GNUNET_TRANSPORT_PeerIterateContext *
 336 GNUNET_TRANSPORT_peer_get_active_addresses (const struct
 337                                             GNUNET_CONFIGURATION_Handle *cfg,
 338                                             const struct GNUNET_PeerIdentity
 339                                             *peer, int one_shot,
 340                                             struct GNUNET_TIME_Relative timeout,
 341                                             GNUNET_TRANSPORT_PeerIterateCallback
 342                                             peer_address_callback,
 343                                             void *peer_address_callback_cls);
 344
 345
 346 /**
 347  * Cancel request for peer lookup.
 348  *
 349  * @param alc handle for the request to cancel
 350  */
 351 void
 352 GNUNET_TRANSPORT_peer_get_active_addresses_cancel (struct
 353                                                    GNUNET_TRANSPORT_PeerIterateContext
 354                                                    *alc);
 355
 356
 357 /**
 358  * Handle for blacklisting peers.
 359  */
 360 struct GNUNET_TRANSPORT_Blacklist;
 361
 362
 363 /**
 364  * Function that decides if a connection is acceptable or not.
 365  *
 366  * @param cls closure
 367  * @param pid peer to approve or disapproave
 368  * @return GNUNET_OK if the connection is allowed
 369  */
 370 typedef int (*GNUNET_TRANSPORT_BlacklistCallback) (void *cls,
 371                                                    const struct
 372                                                    GNUNET_PeerIdentity * pid);
 373
 374
 375 /**
 376  * Install a blacklist callback.  The service will be queried for all
 377  * existing connections as well as any fresh connections to check if
 378  * they are permitted.  If the blacklisting callback is unregistered,
 379  * all hosts that were denied in the past will automatically be
 380  * whitelisted again.  Cancelling the blacklist handle is also the
 381  * only way to re-enable connections from peers that were previously
 382  * blacklisted.
 383  *
 384  * @param cfg configuration to use
 385  * @param cb callback to invoke to check if connections are allowed
 386  * @param cb_cls closure for cb
 387  * @return NULL on error, otherwise handle for cancellation
 388  */
 389 struct GNUNET_TRANSPORT_Blacklist *
 390 GNUNET_TRANSPORT_blacklist (const struct GNUNET_CONFIGURATION_Handle *cfg,
 391                             GNUNET_TRANSPORT_BlacklistCallback cb,
 392                             void *cb_cls);
 393
 394
 395 /**
 396  * Abort the blacklist.  Note that this function is the only way for
 397  * removing a peer from the blacklist.
 398  *
 399  * @param br handle of the request that is to be cancelled
 400  */
 401 void
 402 GNUNET_TRANSPORT_blacklist_cancel (struct GNUNET_TRANSPORT_Blacklist *br);
 403
 404
 405
 406 #if 0                           /* keep Emacsens' auto-indent happy */
 407 {
 408 #endif
 409 #ifdef __cplusplus
 410 }
 411 #endif
 412
 413 /* ifndef GNUNET_TRANSPORT_SERVICE_H */
 414 #endif
 415 /* end of gnunet_transport_service.h */