src/include/gnunet_server_lib.h

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