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