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