src/include/gnunet_server_lib.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009, 2010 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 2, 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_server_lib.h
  23  * @brief library for building GNUnet network servers
  24  *
  25  * @author Christian Grothoff
  26  */
  27
  28 #ifndef GNUNET_SERVER_LIB_H
  29 #define GNUNET_SERVER_LIB_H
  30
  31 #ifdef __cplusplus
  32 extern "C"
  33 {
  34 #if 0                           /* keep Emacsens' auto-indent happy */
  35 }
  36 #endif
  37 #endif
  38
  39 #include "gnunet_common.h"
  40 #include "gnunet_connection_lib.h"
  41
  42
  43 /**
  44  * Largest supported message.
  45  */
  46 #define GNUNET_SERVER_MAX_MESSAGE_SIZE 65536
  47
  48 /**
  49  * Smallest supported message.
  50  */
  51 #define GNUNET_SERVER_MIN_BUFFER_SIZE sizeof (struct GNUNET_MessageHeader)
  52
  53 /**
  54  * @brief handle for a server
  55  */
  56 struct GNUNET_SERVER_Handle;
  57
  58 /**
  59  * @brief opaque handle for a client of the server
  60  */
  61 struct GNUNET_SERVER_Client;
  62
  63 /**
  64  * @brief opaque handle server returns for aborting transmission to a client.
  65  */
  66 struct GNUNET_SERVER_TransmitHandle;
  67
  68
  69 /**
  70  * Functions with this signature are called whenever a message is
  71  * received.
  72  *
  73  * @param cls closure
  74  * @param client identification of the client
  75  * @param message the actual message
  76  */
  77 typedef void (*GNUNET_SERVER_MessageCallback) (void *cls,
  78                                                struct GNUNET_SERVER_Client *
  79                                                client,
  80                                                const struct GNUNET_MessageHeader
  81                                                * message);
  82
  83
  84
  85 /**
  86  * Message handler.  Each struct specifies how to handle on particular
  87  * type of message received.
  88  */
  89 struct GNUNET_SERVER_MessageHandler
  90 {
  91   /**
  92    * Function to call for messages of "type".
  93    */
  94   GNUNET_SERVER_MessageCallback callback;
  95
  96   /**
  97    * Closure argument for "callback".
  98    */
  99   void *callback_cls;
 100
 101   /**
 102    * Type of the message this handler covers.
 103    */
 104   uint16_t type;
 105
 106   /**
 107    * Expected size of messages of this type.  Use 0 for
 108    * variable-size.  If non-zero, messages of the given
 109    * type will be discarded (and the connection closed)
 110    * if they do not have the right size.
 111    */
 112   uint16_t expected_size;
 113
 114 };
 115
 116
 117 /**
 118  * Create a new server.
 119  *
 120  * @param access function for access control
 121  * @param access_cls closure for access
 122  * @param lsocks NULL-terminated array of listen sockets
 123  * @param idle_timeout after how long should we timeout idle connections?
 124  * @param require_found if YES, connections sending messages of unknown type
 125  *        will be closed
 126  * @return handle for the new server, NULL on error
 127  *         (typically, "port" already in use)
 128  */
 129 struct GNUNET_SERVER_Handle *
 130 GNUNET_SERVER_create_with_sockets (GNUNET_CONNECTION_AccessCheck access,
 131                                    void *access_cls,
 132                                    struct GNUNET_NETWORK_Handle **lsocks,
 133                                    struct GNUNET_TIME_Relative idle_timeout,
 134                                    int require_found);
 135
 136 /**
 137  * Create a new server.
 138  *
 139  * @param access function for access control
 140  * @param access_cls closure for access
 141  * @param serverAddr address toes listen on (including port), NULL terminated array
 142  * @param socklen lengths of respective serverAddr
 143  * @param idle_timeout after how long should we timeout idle connections?
 144  * @param require_found if YES, connections sending messages of unknown type
 145  *        will be closed
 146  * @return handle for the new server, NULL on error
 147  *         (typically, "port" already in use)
 148  */
 149 struct GNUNET_SERVER_Handle *
 150 GNUNET_SERVER_create (GNUNET_CONNECTION_AccessCheck access, void *access_cls,
 151                       struct sockaddr *const *serverAddr,
 152                       const socklen_t * socklen,
 153                       struct GNUNET_TIME_Relative idle_timeout,
 154                       int require_found);
 155
 156
 157 /**
 158  * Free resources held by this server.
 159  *
 160  * @param server server to destroy
 161  */
 162 void
 163 GNUNET_SERVER_destroy (struct GNUNET_SERVER_Handle *server);
 164
 165
 166 /**
 167  * Add additional handlers to an existing server.
 168  *
 169  * @param server the server to add handlers to
 170  * @param handlers array of message handlers for
 171  *        incoming messages; the last entry must
 172  *        have "NULL" for the "callback"; multiple
 173  *        entries for the same type are allowed,
 174  *        they will be called in order of occurence.
 175  *        These handlers can be removed later;
 176  *        the handlers array must exist until removed
 177  *        (or server is destroyed).
 178  */
 179 void
 180 GNUNET_SERVER_add_handlers (struct GNUNET_SERVER_Handle *server,
 181                             const struct GNUNET_SERVER_MessageHandler
 182                             *handlers);
 183
 184
 185 /**
 186  * Notify us when the server has enough space to transmit
 187  * a message of the given size to the given client.
 188  *
 189  * @param client client to transmit message to
 190  * @param size requested amount of buffer space
 191  * @param timeout after how long should we give up (and call
 192  *        notify with buf NULL and size 0)?
 193  * @param callback function to call when space is available
 194  * @param callback_cls closure for callback
 195  * @return non-NULL if the notify callback was queued; can be used
 196  *           to cancel the request using
 197  *           GNUNET_SERVER_notify_transmit_ready_cancel.
 198  *         NULL if we are already going to notify someone else (busy)
 199  */
 200 struct GNUNET_SERVER_TransmitHandle *
 201 GNUNET_SERVER_notify_transmit_ready (struct GNUNET_SERVER_Client *client,
 202                                      size_t size,
 203                                      struct GNUNET_TIME_Relative timeout,
 204                                      GNUNET_CONNECTION_TransmitReadyNotify
 205                                      callback, void *callback_cls);
 206
 207
 208 /**
 209  * Abort transmission request.
 210  *
 211  * @param th request to abort
 212  */
 213 void
 214 GNUNET_SERVER_notify_transmit_ready_cancel (struct GNUNET_SERVER_TransmitHandle *th);
 215
 216
 217 /**
 218  * Set the persistent flag on this client, used to setup client connection
 219  * to only be killed when the service it's connected to is actually dead.
 220  *
 221  * @param client the client to set the persistent flag on
 222  */
 223 void
 224 GNUNET_SERVER_client_persist_ (struct GNUNET_SERVER_Client *client);
 225
 226
 227 /**
 228  * Resume receiving from this client, we are done processing the
 229  * current request.  This function must be called from within each
 230  * GNUNET_SERVER_MessageCallback (or its respective continuations).
 231  *
 232  * @param client client we were processing a message of
 233  * @param success GNUNET_OK to keep the connection open and
 234  *                          continue to receive
 235  *                GNUNET_NO to close the connection (normal behavior)
 236  *                GNUNET_SYSERR to close the connection (signal
 237  *                          serious error)
 238  */
 239 void
 240 GNUNET_SERVER_receive_done (struct GNUNET_SERVER_Client *client, int success);
 241
 242
 243 /**
 244  * Change the timeout for a particular client.  Decreasing the timeout
 245  * may not go into effect immediately (only after the previous timeout
 246  * times out or activity happens on the socket).
 247  *
 248  * @param client the client to update
 249  * @param timeout new timeout for activities on the socket
 250  */
 251 void
 252 GNUNET_SERVER_client_set_timeout (struct GNUNET_SERVER_Client *client,
 253                                   struct GNUNET_TIME_Relative timeout);
 254
 255
 256 /**
 257  * Disable the warning the server issues if a message is not acknowledged
 258  * in a timely fashion.  Use this call if a client is intentionally delayed
 259  * for a while.  Only applies to the current message.
 260  *
 261  * @param client client for which to disable the warning
 262  */
 263 void
 264 GNUNET_SERVER_disable_receive_done_warning (struct GNUNET_SERVER_Client
 265                                             *client);
 266
 267
 268 /**
 269  * Inject a message into the server, pretend it came
 270  * from the specified client.  Delivery of the message
 271  * will happen instantly (if a handler is installed;
 272  * otherwise the call does nothing).
 273  *
 274  * @param server the server receiving the message
 275  * @param sender the "pretended" sender of the message
 276  *        can be NULL!
 277  * @param message message to transmit
 278  * @return GNUNET_OK if the message was OK and the
 279  *                   connection can stay open
 280  *         GNUNET_SYSERR if the connection to the
 281  *         client should be shut down
 282  */
 283 int
 284 GNUNET_SERVER_inject (struct GNUNET_SERVER_Handle *server,
 285                       struct GNUNET_SERVER_Client *sender,
 286                       const struct GNUNET_MessageHeader *message);
 287
 288
 289 /**
 290  * Add a TCP socket-based connection to the set of handles managed by
 291  * this server.  Use this function for outgoing (P2P) connections that
 292  * we initiated (and where this server should process incoming
 293  * messages).
 294  *
 295  * @param server the server to use
 296  * @param connection the connection to manage (client must
 297  *        stop using this connection from now on)
 298  * @return the client handle (client should call
 299  *         "client_drop" on the return value eventually)
 300  */
 301 struct GNUNET_SERVER_Client *
 302 GNUNET_SERVER_connect_socket (struct GNUNET_SERVER_Handle *server,
 303                               struct GNUNET_CONNECTION_Handle *connection);
 304
 305
 306 /**
 307  * Notify the server that the given client handle should
 308  * be kept (keeps the connection up if possible, increments
 309  * the internal reference counter).
 310  *
 311  * @param client the client to keep
 312  */
 313 void
 314 GNUNET_SERVER_client_keep (struct GNUNET_SERVER_Client *client);
 315
 316
 317 /**
 318  * Notify the server that the given client handle is no
 319  * longer required.  Decrements the reference counter.  If
 320  * that counter reaches zero an inactive connection maybe
 321  * closed.
 322  *
 323  * @param client the client to drop
 324  */
 325 void
 326 GNUNET_SERVER_client_drop (struct GNUNET_SERVER_Client *client);
 327
 328
 329 /**
 330  * Obtain the network address of the other party.
 331  *
 332  * @param client the client to get the address for
 333  * @param addr where to store the address
 334  * @param addrlen where to store the length of the address
 335  * @return GNUNET_OK on success
 336  */
 337 int
 338 GNUNET_SERVER_client_get_address (struct GNUNET_SERVER_Client *client,
 339                                   void **addr, size_t * addrlen);
 340
 341
 342 /**
 343  * Functions with this signature are called whenever a client
 344  * is disconnected on the network level.
 345  *
 346  * @param cls closure
 347  * @param client identification of the client; NULL
 348  *        for the last call when the server is destroyed
 349  */
 350 typedef void (*GNUNET_SERVER_DisconnectCallback) (void *cls,
 351                                                   struct GNUNET_SERVER_Client *
 352                                                   client);
 353
 354
 355 /**
 356  * Ask the server to notify us whenever a client disconnects.
 357  * This function is called whenever the actual network connection
 358  * is closed; the reference count may be zero or larger than zero
 359  * at this point.  If the server is destroyed before this
 360  * notification is explicitly cancelled, the 'callback' will
 361  * once be called with a 'client' argument of NULL to indicate
 362  * that the server itself is now gone (and that the callback
 363  * won't be called anymore and also can no longer be cancelled).
 364  *
 365  * @param server the server manageing the clients
 366  * @param callback function to call on disconnect
 367  * @param callback_cls closure for callback
 368  */
 369 void
 370 GNUNET_SERVER_disconnect_notify (struct GNUNET_SERVER_Handle *server,
 371                                  GNUNET_SERVER_DisconnectCallback callback,
 372                                  void *callback_cls);
 373
 374
 375 /**
 376  * Ask the server to stop notifying us whenever a client disconnects.
 377  *
 378  * @param server the server manageing the clients
 379  * @param callback function to call on disconnect
 380  * @param callback_cls closure for callback
 381  */
 382 void
 383 GNUNET_SERVER_disconnect_notify_cancel (struct GNUNET_SERVER_Handle *server,
 384                                         GNUNET_SERVER_DisconnectCallback
 385                                         callback, void *callback_cls);
 386
 387
 388 /**
 389  * Ask the server to disconnect from the given client.
 390  * This is the same as returning GNUNET_SYSERR from a message
 391  * handler, except that it allows dropping of a client even
 392  * when not handling a message from that client.
 393  *
 394  * @param client the client to disconnect from
 395  */
 396 void
 397 GNUNET_SERVER_client_disconnect (struct GNUNET_SERVER_Client *client);
 398
 399
 400 /**
 401  * Disable the "CORK" feature for communication with the given client,
 402  * forcing the OS to immediately flush the buffer on transmission
 403  * instead of potentially buffering multiple messages.
 404  *
 405  * @param client handle to the client
 406  * @return GNUNET_OK on success
 407  */
 408 int
 409 GNUNET_SERVER_client_disable_corking (struct GNUNET_SERVER_Client *client);
 410
 411
 412 /**
 413  * The tansmit context is the key datastructure for a conveniance API
 414  * used for transmission of complex results to the client followed
 415  * ONLY by signaling receive_done with success or error
 416  */
 417 struct GNUNET_SERVER_TransmitContext;
 418
 419
 420 /**
 421  * Create a new transmission context for the
 422  * given client.
 423  *
 424  * @param client client to create the context for.
 425  * @return NULL on error
 426  */
 427 struct GNUNET_SERVER_TransmitContext *
 428 GNUNET_SERVER_transmit_context_create (struct GNUNET_SERVER_Client *client);
 429
 430
 431 /**
 432  * Append a message to the transmission context.
 433  * All messages in the context will be sent by
 434  * the transmit_context_run method.
 435  *
 436  * @param tc context to use
 437  * @param data what to append to the result message
 438  * @param length length of data
 439  * @param type type of the message
 440  */
 441 void
 442 GNUNET_SERVER_transmit_context_append_data (struct GNUNET_SERVER_TransmitContext
 443                                             *tc, const void *data,
 444                                             size_t length, uint16_t type);
 445
 446
 447 /**
 448  * Append a message to the transmission context.
 449  * All messages in the context will be sent by
 450  * the transmit_context_run method.
 451  *
 452  * @param tc context to use
 453  * @param msg message to append
 454  */
 455 void
 456 GNUNET_SERVER_transmit_context_append_message (struct
 457                                                GNUNET_SERVER_TransmitContext
 458                                                *tc,
 459                                                const struct GNUNET_MessageHeader
 460                                                *msg);
 461
 462
 463 /**
 464  * Execute a transmission context.  If there is an error in the
 465  * transmission, the receive_done method will be called with an error
 466  * code (GNUNET_SYSERR), otherwise with GNUNET_OK.
 467  *
 468  * @param tc transmission context to use
 469  * @param timeout when to time out and abort the transmission
 470  */
 471 void
 472 GNUNET_SERVER_transmit_context_run (struct GNUNET_SERVER_TransmitContext *tc,
 473                                     struct GNUNET_TIME_Relative timeout);
 474
 475
 476 /**
 477  * Destroy a transmission context.  This function must not be called
 478  * after 'GNUNET_SERVER_transmit_context_run'.
 479  *
 480  * @param tc transmission context to destroy
 481  * @param success code to give to 'GNUNET_SERVER_receive_done' for
 482  *        the client:  GNUNET_OK to keep the connection open and
 483  *                          continue to receive
 484  *                GNUNET_NO to close the connection (normal behavior)
 485  *                GNUNET_SYSERR to close the connection (signal
 486  *                          serious error)
 487  */
 488 void
 489 GNUNET_SERVER_transmit_context_destroy (struct GNUNET_SERVER_TransmitContext
 490                                         *tc, int success);
 491
 492
 493 /**
 494  * The notification context is the key datastructure for a conveniance
 495  * API used for transmission of notifications to the client until the
 496  * client disconnects (or the notification context is destroyed, in
 497  * which case we disconnect these clients).  Essentially, all
 498  * (notification) messages are queued up until the client is able to
 499  * read them.
 500  */
 501 struct GNUNET_SERVER_NotificationContext;
 502
 503
 504 /**
 505  * Create a new notification context.
 506  *
 507  * @param server server for which this function creates the context
 508  * @param queue_length maximum number of messages to keep in
 509  *        the notification queue; optional messages are dropped
 510  *        if the queue gets longer than this number of messages
 511  * @return handle to the notification context
 512  */
 513 struct GNUNET_SERVER_NotificationContext *
 514 GNUNET_SERVER_notification_context_create (struct GNUNET_SERVER_Handle *server,
 515                                            unsigned int queue_length);
 516
 517
 518 /**
 519  * Destroy the context, force disconnect for all clients.
 520  *
 521  * @param nc context to destroy.
 522  */
 523 void
 524 GNUNET_SERVER_notification_context_destroy (struct
 525                                             GNUNET_SERVER_NotificationContext
 526                                             *nc);
 527
 528
 529 /**
 530  * Add a client to the notification context.
 531  *
 532  * @param nc context to modify
 533  * @param client client to add
 534  */
 535 void
 536 GNUNET_SERVER_notification_context_add (struct GNUNET_SERVER_NotificationContext
 537                                         *nc,
 538                                         struct GNUNET_SERVER_Client *client);
 539
 540
 541 /**
 542  * Send a message to a particular client; must have
 543  * already been added to the notification context.
 544  *
 545  * @param nc context to modify
 546  * @param client client to transmit to
 547  * @param msg message to send
 548  * @param can_drop can this message be dropped due to queue length limitations
 549  */
 550 void
 551 GNUNET_SERVER_notification_context_unicast (struct
 552                                             GNUNET_SERVER_NotificationContext
 553                                             *nc,
 554                                             struct GNUNET_SERVER_Client *client,
 555                                             const struct GNUNET_MessageHeader
 556                                             *msg, int can_drop);
 557
 558
 559 /**
 560  * Send a message to all clients of this context.
 561  *
 562  * @param nc context to modify
 563  * @param msg message to send
 564  * @param can_drop can this message be dropped due to queue length limitations
 565  */
 566 void
 567 GNUNET_SERVER_notification_context_broadcast (struct
 568                                               GNUNET_SERVER_NotificationContext
 569                                               *nc,
 570                                               const struct GNUNET_MessageHeader
 571                                               *msg, int can_drop);
 572
 573
 574
 575 /**
 576  * Handle to a message stream tokenizer.
 577  */
 578 struct GNUNET_SERVER_MessageStreamTokenizer;
 579
 580 /**
 581  * Functions with this signature are called whenever a
 582  * complete message is received by the tokenizer.
 583  *
 584  * @param cls closure
 585  * @param client identification of the client
 586  * @param message the actual message
 587  */
 588 typedef void (*GNUNET_SERVER_MessageTokenizerCallback) (void *cls, void *client,
 589                                                         const struct
 590                                                         GNUNET_MessageHeader *
 591                                                         message);
 592
 593
 594 /**
 595  * Create a message stream tokenizer.
 596  *
 597  * @param cb function to call on completed messages
 598  * @param cb_cls closure for cb
 599  * @return handle to tokenizer
 600  */
 601 struct GNUNET_SERVER_MessageStreamTokenizer *
 602 GNUNET_SERVER_mst_create (GNUNET_SERVER_MessageTokenizerCallback cb,
 603                           void *cb_cls);
 604
 605
 606 /**
 607  * Add incoming data to the receive buffer and call the
 608  * callback for all complete messages.
 609  *
 610  * @param mst tokenizer to use
 611  * @param client_identity ID of client for which this is a buffer,
 612  *        can be NULL (will be passed back to 'cb')
 613  * @param buf input data to add
 614  * @param size number of bytes in buf
 615  * @param purge should any excess bytes in the buffer be discarded
 616  *       (i.e. for packet-based services like UDP)
 617  * @param one_shot only call callback once, keep rest of message in buffer
 618  * @return GNUNET_OK if we are done processing (need more data)
 619  *         GNUNET_NO if one_shot was set and we have another message ready
 620  *         GNUNET_SYSERR if the data stream is corrupt
 621  */
 622 int
 623 GNUNET_SERVER_mst_receive (struct GNUNET_SERVER_MessageStreamTokenizer *mst,
 624                            void *client_identity, const char *buf, size_t size,
 625                            int purge, int one_shot);
 626
 627
 628 /**
 629  * Destroys a tokenizer.
 630  *
 631  * @param mst tokenizer to destroy
 632  */
 633 void
 634 GNUNET_SERVER_mst_destroy (struct GNUNET_SERVER_MessageStreamTokenizer *mst);
 635
 636
 637 /**
 638  * Signature of a function to create a custom tokenizer.
 639  *
 640  * @param cls closure from 'GNUNET_SERVER_set_callbacks'
 641  * @param client handle to client the tokenzier will be used for
 642  * @return handle to custom tokenizer ('mst')
 643  */
 644 typedef void* (*GNUNET_SERVER_MstCreateCallback) (void *cls,
 645                                                   struct GNUNET_SERVER_Client *client);
 646
 647 /**
 648  * Signature of a function to destroy a custom tokenizer.
 649  *
 650  * @param cls closure from 'GNUNET_SERVER_set_callbacks'
 651  * @param mst custom tokenizer handle
 652  */
 653 typedef void (*GNUNET_SERVER_MstDestroyCallback) (void *cls, void *mst);
 654
 655 /**
 656  * Signature of a function to destroy a custom tokenizer.
 657  *
 658  * @param cls closure from 'GNUNET_SERVER_set_callbacks'
 659  * @param mst custom tokenizer handle
 660  * @param client_identity ID of client for which this is a buffer,
 661  *        can be NULL (will be passed back to 'cb')
 662  * @param buf input data to add
 663  * @param size number of bytes in buf
 664  * @param purge should any excess bytes in the buffer be discarded
 665  *       (i.e. for packet-based services like UDP)
 666  * @param one_shot only call callback once, keep rest of message in buffer
 667  * @return GNUNET_OK if we are done processing (need more data)
 668  *         GNUNET_NO if one_shot was set and we have another message ready
 669  *         GNUNET_SYSERR if the data stream is corrupt
 670  */
 671 typedef int (*GNUNET_SERVER_MstReceiveCallback) (void *cls, void *mst,
 672                                                  struct GNUNET_SERVER_Client *client,
 673                                                  const char *buf, size_t size,
 674                                                  int purge, int one_shot);
 675
 676
 677 /**
 678  * Change functions used by the server to tokenize the message stream.
 679  * (very rarely used).
 680  *
 681  * @param server server to modify
 682  * @param create new tokenizer initialization function
 683  * @param destroy new tokenizer destruction function
 684  * @param receive new tokenizer receive function
 685  * @param cls closure for 'create', 'receive', 'destroy'
 686  */
 687 void
 688 GNUNET_SERVER_set_callbacks (struct GNUNET_SERVER_Handle *server,
 689                              GNUNET_SERVER_MstCreateCallback create,
 690                              GNUNET_SERVER_MstDestroyCallback destroy,
 691                              GNUNET_SERVER_MstReceiveCallback receive,
 692                              void *cls);
 693
 694
 695 #if 0                           /* keep Emacsens' auto-indent happy */
 696 {
 697 #endif
 698 #ifdef __cplusplus
 699 }
 700 #endif
 701
 702
 703 /* ifndef GNUNET_SERVER_LIB_H */
 704 #endif
 705 /* end of gnunet_server_lib.h */