2 This file is part of GNUnet.
3 (C) 2009 Christian Grothoff (and other contributing authors)
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.
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.
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.
23 * @brief library for building GNUnet network servers
24 * @author Christian Grothoff
27 * - fix inefficient memmove in message processing
31 #include "gnunet_common.h"
32 #include "gnunet_connection_lib.h"
33 #include "gnunet_scheduler_lib.h"
34 #include "gnunet_server_lib.h"
35 #include "gnunet_time_lib.h"
36 #include "gnunet_disk_lib.h"
38 #define DEBUG_SERVER GNUNET_NO
41 * List of arrays of message handlers.
46 * This is a linked list.
48 struct HandlerList *next;
51 * NULL-terminated array of handlers.
53 const struct GNUNET_SERVER_MessageHandler *handlers;
58 * List of arrays of message handlers.
63 * This is a linked list.
65 struct NotifyList *next;
70 GNUNET_SERVER_DisconnectCallback callback;
73 * Closure for callback.
80 * @brief handle for a server
82 struct GNUNET_SERVER_Handle
87 struct GNUNET_SCHEDULER_Handle *sched;
90 * List of handlers for incoming messages.
92 struct HandlerList *handlers;
95 * List of our current clients.
97 struct GNUNET_SERVER_Client *clients;
100 * Linked list of functions to call on disconnects by clients.
102 struct NotifyList *disconnect_notify_list;
105 * Function to call for access control.
107 GNUNET_CONNECTION_AccessCheck access;
110 * Closure for access.
115 * After how long should an idle connection time
118 struct GNUNET_TIME_Relative idle_timeout;
121 * maximum write buffer size for accepted sockets
126 * Pipe used to signal shutdown of the server.
128 struct GNUNET_DISK_PipeHandle *shutpipe;
131 * Socket used to listen for new connections. Set to
132 * "-1" by GNUNET_SERVER_destroy to initiate shutdown.
134 struct GNUNET_NETWORK_Handle *listen_socket;
137 * Set to GNUNET_YES if we are shutting down.
142 * Do we ignore messages of types that we do not
143 * understand or do we require that a handler
144 * is found (and if not kill the connection)?
152 * @brief handle for a client of the server
154 struct GNUNET_SERVER_Client
158 * Size of the buffer for incoming data. Should be
159 * first so we get nice alignment.
161 char incoming_buffer[GNUNET_SERVER_MAX_MESSAGE_SIZE];
164 * This is a linked list.
166 struct GNUNET_SERVER_Client *next;
169 * Server that this client belongs to.
171 struct GNUNET_SERVER_Handle *server;
174 * Client closure for callbacks.
176 void *client_closure;
179 * Callback to receive from client.
181 GNUNET_SERVER_ReceiveCallback receive;
184 * Callback to cancel receive from client.
186 GNUNET_SERVER_ReceiveCancelCallback receive_cancel;
189 * Callback to ask about transmit-ready notification.
191 GNUNET_SERVER_TransmitReadyCallback notify_transmit_ready;
194 * Callback to ask about transmit-ready notification.
196 GNUNET_SERVER_TransmitReadyCancelCallback notify_transmit_ready_cancel;
199 * Callback to check if client is still valid.
201 GNUNET_SERVER_CheckCallback check;
204 * Callback to destroy client.
206 GNUNET_SERVER_DestroyCallback destroy;
209 * Side-buffer for incoming data used when processing
215 * Number of bytes in the side buffer.
217 size_t side_buf_size;
220 * Last activity on this socket (used to time it out
221 * if reference_count == 0).
223 struct GNUNET_TIME_Absolute last_activity;
226 * How many bytes in the "incoming_buffer" are currently
227 * valid? (starting at offset 0).
232 * Number of external entities with a reference to
233 * this client object.
235 unsigned int reference_count;
238 * Was processing if incoming messages suspended while
239 * we were still processing data already received?
240 * This is a counter saying how often processing was
241 * suspended (once per handler invoked).
243 unsigned int suspended;
246 * Are we currently in the "process_client_buffer" function (and
247 * will hence restart the receive job on exit if suspended == 0 once
248 * we are done?). If this is set, then "receive_done" will
249 * essentially only decrement suspended; if this is not set, then
250 * "receive_done" may need to restart the receive process (either
251 * from the side-buffer or via select/recv).
253 int in_process_client_buffer;
256 * We're about to close down this client due to some serious
265 * Server has been asked to shutdown, free resources.
268 destroy_server (struct GNUNET_SERVER_Handle *server)
270 struct GNUNET_SERVER_Client *pos;
271 struct HandlerList *hpos;
272 struct NotifyList *npos;
275 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Server shutting down.\n");
277 GNUNET_assert (server->listen_socket == NULL);
278 if (GNUNET_OK != GNUNET_DISK_pipe_close (server->shutpipe))
279 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "pipe-close");
280 while (server->clients != NULL)
282 pos = server->clients;
283 server->clients = pos->next;
286 while (NULL != (hpos = server->handlers))
288 server->handlers = hpos->next;
291 while (NULL != (npos = server->disconnect_notify_list))
293 server->disconnect_notify_list = npos->next;
296 GNUNET_free (server);
301 * Scheduler says our listen socket is ready.
305 process_listen_socket (void *cls,
306 const struct GNUNET_SCHEDULER_TaskContext *tc)
308 struct GNUNET_SERVER_Handle *server = cls;
309 struct GNUNET_CONNECTION_Handle *sock;
310 struct GNUNET_SERVER_Client *client;
311 struct GNUNET_NETWORK_FDSet *r;
312 const struct GNUNET_DISK_FileHandle *shutpipe;
314 if ((server->do_shutdown) ||
315 ((tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0))
317 /* shutdown was initiated */
318 GNUNET_assert (server->listen_socket != NULL);
319 GNUNET_break (GNUNET_OK ==
320 GNUNET_NETWORK_socket_close (server->listen_socket));
321 server->listen_socket = NULL;
322 if (server->do_shutdown)
323 destroy_server (server);
326 shutpipe = GNUNET_DISK_pipe_handle (server->shutpipe,
327 GNUNET_DISK_PIPE_END_READ);
328 GNUNET_assert (GNUNET_NETWORK_fdset_isset
329 (tc->read_ready, server->listen_socket));
330 GNUNET_assert (!GNUNET_NETWORK_fdset_handle_isset
331 (tc->read_ready, shutpipe));
333 GNUNET_CONNECTION_create_from_accept (tc->sched, server->access,
335 server->listen_socket,
340 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
341 "Server accepted incoming connection.\n");
343 client = GNUNET_SERVER_connect_socket (server, sock);
344 /* decrement reference count, we don't keep "client" alive */
345 GNUNET_SERVER_client_drop (client);
347 /* listen for more! */
348 r = GNUNET_NETWORK_fdset_create ();
349 GNUNET_NETWORK_fdset_set (r, server->listen_socket);
350 GNUNET_NETWORK_fdset_handle_set (r, shutpipe);
351 GNUNET_SCHEDULER_add_select (server->sched,
352 GNUNET_SCHEDULER_PRIORITY_HIGH,
353 GNUNET_SCHEDULER_NO_TASK,
354 GNUNET_TIME_UNIT_FOREVER_REL,
355 r, NULL, &process_listen_socket, server);
356 GNUNET_NETWORK_fdset_destroy (r);
361 * Create and initialize a listen socket for the server.
363 * @return NULL on error, otherwise the listen socket
365 static struct GNUNET_NETWORK_Handle *
366 open_listen_socket (const struct sockaddr *serverAddr, socklen_t socklen)
368 const static int on = 1;
369 struct GNUNET_NETWORK_Handle *sock;
372 switch (serverAddr->sa_family)
375 port = ntohs (((const struct sockaddr_in *) serverAddr)->sin_port);
378 port = ntohs (((const struct sockaddr_in6 *) serverAddr)->sin6_port);
384 sock = GNUNET_NETWORK_socket_create (serverAddr->sa_family, SOCK_STREAM, 0);
387 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "socket");
390 if (GNUNET_NETWORK_socket_setsockopt
391 (sock, SOL_SOCKET, SO_REUSEADDR, &on, sizeof (on)) != GNUNET_OK)
392 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
394 /* bind the socket */
395 if (GNUNET_NETWORK_socket_bind (sock, serverAddr, socklen) != GNUNET_OK)
397 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "bind");
398 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
400 ("`%s' failed for port %d. Is the service already running?\n"),
402 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (sock));
405 if (GNUNET_OK != GNUNET_NETWORK_socket_listen (sock, 5))
407 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "listen");
408 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (sock));
412 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
413 "Server starts to listen on port %u.\n", port);
420 * Create a new server.
422 * @param sched scheduler to use
423 * @param access function for access control
424 * @param access_cls closure for access
425 * @param serverAddr address to listen on (including port), use NULL
426 * for internal server (no listening)
427 * @param socklen length of serverAddr
428 * @param maxbuf maximum write buffer size for accepted sockets
429 * @param idle_timeout after how long should we timeout idle connections?
430 * @param require_found if YES, connections sending messages of unknown type
432 * @return handle for the new server, NULL on error
433 * (typically, "port" already in use)
435 struct GNUNET_SERVER_Handle *
436 GNUNET_SERVER_create (struct GNUNET_SCHEDULER_Handle *sched,
437 GNUNET_CONNECTION_AccessCheck access,
439 const struct sockaddr *serverAddr,
442 struct GNUNET_TIME_Relative
443 idle_timeout, int require_found)
445 struct GNUNET_SERVER_Handle *ret;
446 struct GNUNET_NETWORK_Handle *lsock;
447 struct GNUNET_NETWORK_FDSet *r;
450 if (serverAddr != NULL)
452 lsock = open_listen_socket (serverAddr, socklen);
456 ret = GNUNET_malloc (sizeof (struct GNUNET_SERVER_Handle));
457 if (NULL == (ret->shutpipe = GNUNET_DISK_pipe (GNUNET_NO)))
459 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (lsock));
464 ret->maxbuf = maxbuf;
465 ret->idle_timeout = idle_timeout;
466 ret->listen_socket = lsock;
467 ret->access = access;
468 ret->access_cls = access_cls;
469 ret->require_found = require_found;
472 r = GNUNET_NETWORK_fdset_create ();
473 GNUNET_NETWORK_fdset_set (r, ret->listen_socket);
474 GNUNET_NETWORK_fdset_handle_set (r,
475 GNUNET_DISK_pipe_handle (ret->shutpipe,
476 GNUNET_DISK_PIPE_END_READ));
477 GNUNET_SCHEDULER_add_select (sched,
478 GNUNET_SCHEDULER_PRIORITY_HIGH,
479 GNUNET_SCHEDULER_NO_TASK,
480 GNUNET_TIME_UNIT_FOREVER_REL, r, NULL,
481 &process_listen_socket, ret);
482 GNUNET_NETWORK_fdset_destroy (r);
489 * Free resources held by this server.
492 GNUNET_SERVER_destroy (struct GNUNET_SERVER_Handle *s)
496 GNUNET_assert (s->do_shutdown == GNUNET_NO);
497 s->do_shutdown = GNUNET_YES;
498 if (s->listen_socket == NULL)
502 GNUNET_DISK_file_write (GNUNET_DISK_pipe_handle
504 GNUNET_DISK_PIPE_END_WRITE), &c,
510 * Add additional handlers to an existing server.
512 * @param server the server to add handlers to
513 * @param handlers array of message handlers for
514 * incoming messages; the last entry must
515 * have "NULL" for the "callback"; multiple
516 * entries for the same type are allowed,
517 * they will be called in order of occurence.
518 * These handlers can be removed later;
519 * the handlers array must exist until removed
520 * (or server is destroyed).
523 GNUNET_SERVER_add_handlers (struct GNUNET_SERVER_Handle *server,
524 const struct GNUNET_SERVER_MessageHandler
527 struct HandlerList *p;
529 p = GNUNET_malloc (sizeof (struct HandlerList));
530 p->handlers = handlers;
531 p->next = server->handlers;
532 server->handlers = p;
537 * Inject a message into the server, pretend it came
538 * from the specified client. Delivery of the message
539 * will happen instantly (if a handler is installed;
540 * otherwise the call does nothing).
542 * @param server the server receiving the message
543 * @param sender the "pretended" sender of the message
545 * @param message message to transmit
546 * @return GNUNET_OK if the message was OK and the
547 * connection can stay open
548 * GNUNET_SYSERR if the connection to the
549 * client should be shut down
552 GNUNET_SERVER_inject (struct GNUNET_SERVER_Handle *server,
553 struct GNUNET_SERVER_Client *sender,
554 const struct GNUNET_MessageHeader *message)
556 struct HandlerList *pos;
557 const struct GNUNET_SERVER_MessageHandler *mh;
563 type = ntohs (message->type);
564 size = ntohs (message->size);
566 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
567 "Server schedules transmission of %u-byte message of type %u to client.\n",
570 pos = server->handlers;
575 while (pos->handlers[i].callback != NULL)
577 mh = &pos->handlers[i];
578 if (mh->type == type)
580 if ((mh->expected_size != 0) && (mh->expected_size != size))
583 return GNUNET_SYSERR;
587 mh->callback (mh->callback_cls, sender, message);
594 if (found == GNUNET_NO)
596 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
597 _("Received message of unknown type %d\n"), type);
598 if (server->require_found == GNUNET_YES)
599 return GNUNET_SYSERR;
606 * We're finished with this client and especially its input
607 * processing. If the RC is zero, free all resources otherwise wait
608 * until RC hits zero to do so.
611 shutdown_incoming_processing (struct GNUNET_SERVER_Client *client)
613 struct GNUNET_SERVER_Client *prev;
614 struct GNUNET_SERVER_Client *pos;
615 struct GNUNET_SERVER_Handle *server;
616 struct NotifyList *n;
619 rc = client->reference_count;
620 if (client->server != NULL)
622 server = client->server;
623 client->server = NULL;
625 pos = server->clients;
626 while ((pos != NULL) && (pos != client))
631 GNUNET_assert (pos != NULL);
633 server->clients = pos->next;
635 prev->next = pos->next;
636 n = server->disconnect_notify_list;
639 n->callback (n->callback_cls, client);
643 /* wait for RC to hit zero, then free */
646 client->destroy (client->client_closure);
647 GNUNET_free (client);
652 * Go over the contents of the client buffer; as long as full messages
653 * are available, pass them on for processing. Update the buffer
654 * accordingly. Handles fatal errors by shutting down the connection.
656 * @param client identifies which client receive buffer to process
659 process_client_buffer (struct GNUNET_SERVER_Client *client)
661 struct GNUNET_SERVER_Handle *server;
662 const struct GNUNET_MessageHeader *hdr;
665 client->in_process_client_buffer = GNUNET_YES;
666 server = client->server;
668 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
669 "Private buffer contains %u bytes; client is %s and we are %s\n",
671 client->suspended ? "suspended" : "up",
672 client->shutdown_now ? "in shutdown" : "running");
674 while ((client->receive_pos >= sizeof (struct GNUNET_MessageHeader)) &&
675 (0 == client->suspended) && (GNUNET_YES != client->shutdown_now))
677 hdr = (const struct GNUNET_MessageHeader *) &client->incoming_buffer;
678 msize = ntohs (hdr->size);
679 if (msize > client->receive_pos)
682 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
683 "Total message size is %u, we only have %u bytes; need more data\n",
684 msize, client->receive_pos);
689 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
690 "Passing %u bytes to callback for processing\n", msize);
692 if ((msize < sizeof (struct GNUNET_MessageHeader)) ||
693 (GNUNET_OK != GNUNET_SERVER_inject (server, client, hdr)))
695 client->in_process_client_buffer = GNUNET_NO;
696 shutdown_incoming_processing (client);
699 /* FIXME: this is highly inefficient; we should
700 try to avoid this if the new base address is
701 already nicely aligned. See old handler code... */
702 memmove (client->incoming_buffer,
703 &client->incoming_buffer[msize], client->receive_pos - msize);
704 client->receive_pos -= msize;
706 client->in_process_client_buffer = GNUNET_NO;
707 if (GNUNET_YES == client->shutdown_now)
708 shutdown_incoming_processing (client);
713 * We are receiving an incoming message. Process it.
715 * @param cls our closure (handle for the client)
716 * @param buf buffer with data received from network
717 * @param available number of bytes available in buf
718 * @param addr address of the sender
719 * @param addrlen length of addr
720 * @param errCode code indicating errors receiving, 0 for success
723 process_incoming (void *cls,
726 const struct sockaddr *addr, socklen_t addrlen, int errCode)
728 struct GNUNET_SERVER_Client *client = cls;
729 struct GNUNET_SERVER_Handle *server = client->server;
730 const char *cbuf = buf;
737 (client->shutdown_now == GNUNET_YES) ||
738 (GNUNET_YES != client->check (client->client_closure)))
740 /* other side closed connection, error connecting, etc. */
741 shutdown_incoming_processing (client);
745 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
746 "Server receives %u bytes from `%s'.\n",
747 available, GNUNET_a2s (addr, addrlen));
749 GNUNET_SERVER_client_keep (client);
750 client->last_activity = GNUNET_TIME_absolute_get ();
751 /* process data (if available) */
752 while (available > 0)
755 if (maxcpy > sizeof (client->incoming_buffer) - client->receive_pos)
756 maxcpy = sizeof (client->incoming_buffer) - client->receive_pos;
758 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
759 "Can copy %u bytes to private buffer\n", maxcpy);
761 memcpy (&client->incoming_buffer[client->receive_pos], cbuf, maxcpy);
762 client->receive_pos += maxcpy;
765 if (0 < client->suspended)
770 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
771 "Client has suspended processing; copying %u bytes to side buffer to be used later.\n",
774 GNUNET_assert (client->side_buf_size == 0);
775 GNUNET_assert (client->side_buf == NULL);
776 client->side_buf_size = available;
777 client->side_buf = GNUNET_malloc (available);
778 memcpy (client->side_buf, cbuf, available);
781 break; /* do not run next client iteration! */
784 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
785 "Now processing messages in private buffer\n");
787 process_client_buffer (client);
789 GNUNET_assert (available == 0);
790 if ((client->suspended == 0) &&
791 (GNUNET_YES != client->shutdown_now) && (client->server != NULL))
793 /* Finally, keep receiving! */
794 client->receive (client->client_closure,
795 GNUNET_SERVER_MAX_MESSAGE_SIZE,
796 server->idle_timeout, &process_incoming, client);
798 if (GNUNET_YES == client->shutdown_now)
799 shutdown_incoming_processing (client);
800 GNUNET_SERVER_client_drop (client);
808 restart_processing (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
810 struct GNUNET_SERVER_Client *client = cls;
812 process_client_buffer (client);
813 if (0 == client->suspended)
814 client->receive (client->client_closure,
815 GNUNET_SERVER_MAX_MESSAGE_SIZE,
816 client->server->idle_timeout, &process_incoming, client);
821 * Add a client to the set of our clients and
825 add_client (struct GNUNET_SERVER_Handle *server,
826 struct GNUNET_SERVER_Client *client)
828 client->server = server;
829 client->last_activity = GNUNET_TIME_absolute_get ();
830 client->next = server->clients;
831 server->clients = client;
832 client->receive (client->client_closure,
833 GNUNET_SERVER_MAX_MESSAGE_SIZE,
834 server->idle_timeout, &process_incoming, client);
839 * Create a request for receiving data from a socket.
841 * @param cls identifies the socket to receive from
842 * @param max how much data to read at most
843 * @param timeout when should this operation time out
844 * @param receiver function to call for processing
845 * @param receiver_cls closure for receiver
848 sock_receive (void *cls,
850 struct GNUNET_TIME_Relative timeout,
851 GNUNET_CONNECTION_Receiver receiver, void *receiver_cls)
853 GNUNET_CONNECTION_receive (cls, max, timeout, receiver, receiver_cls);
858 * Wrapper to cancel receiving from a socket.
860 * @param cls handle to the GNUNET_CONNECTION_Handle to cancel
863 sock_receive_cancel (void *cls)
865 GNUNET_CONNECTION_receive_cancel (cls);
873 sock_notify_transmit_ready (void *cls,
875 struct GNUNET_TIME_Relative timeout,
876 GNUNET_CONNECTION_TransmitReadyNotify notify,
879 return GNUNET_CONNECTION_notify_transmit_ready (cls, size, timeout, notify,
888 sock_notify_transmit_ready_cancel (void *cls, void *h)
890 GNUNET_CONNECTION_notify_transmit_ready_cancel (h);
895 * Check if socket is still valid (no fatal errors have happened so far).
897 * @param cls the socket
898 * @return GNUNET_YES if valid, GNUNET_NO otherwise
901 sock_check (void *cls)
903 return GNUNET_CONNECTION_check (cls);
908 * Destroy this socket (free resources).
910 * @param cls the socket
913 sock_destroy (void *cls)
915 GNUNET_CONNECTION_destroy (cls);
920 * Add a TCP socket-based connection to the set of handles managed by
921 * this server. Use this function for outgoing (P2P) connections that
922 * we initiated (and where this server should process incoming
925 * @param server the server to use
926 * @param connection the connection to manage (client must
927 * stop using this connection from now on)
928 * @return the client handle (client should call
929 * "client_drop" on the return value eventually)
931 struct GNUNET_SERVER_Client *
932 GNUNET_SERVER_connect_socket (struct
935 struct GNUNET_CONNECTION_Handle *connection)
937 struct GNUNET_SERVER_Client *client;
939 client = GNUNET_malloc (sizeof (struct GNUNET_SERVER_Client));
940 client->client_closure = connection;
941 client->receive = &sock_receive;
942 client->receive_cancel = &sock_receive_cancel;
943 client->notify_transmit_ready = &sock_notify_transmit_ready;
944 client->notify_transmit_ready_cancel = &sock_notify_transmit_ready_cancel;
945 client->check = &sock_check;
946 client->destroy = &sock_destroy;
947 client->reference_count = 1;
948 add_client (server, client);
954 * Add an arbitrary connection to the set of handles managed by this
955 * server. This can be used if a sending and receiving does not
956 * really go over the network (internal transmission) or for servers
959 * @param server the server to use
960 * @param chandle opaque handle for the connection
961 * @param creceive receive function for the connection
962 * @param ccancel cancel receive function for the connection
963 * @param cnotify transmit notification function for the connection
964 * @param cnotify_cancel transmit notification cancellation function for the connection
965 * @param ccheck function to test if the connection is still up
966 * @param cdestroy function to close and free the connection
967 * @return the client handle (client should call
968 * "client_drop" on the return value eventually)
970 struct GNUNET_SERVER_Client *
971 GNUNET_SERVER_connect_callback (struct
975 GNUNET_SERVER_ReceiveCallback
977 GNUNET_SERVER_ReceiveCancelCallback
979 GNUNET_SERVER_TransmitReadyCallback
981 GNUNET_SERVER_TransmitReadyCancelCallback
983 GNUNET_SERVER_CheckCallback
985 GNUNET_SERVER_DestroyCallback cdestroy)
987 struct GNUNET_SERVER_Client *client;
989 client = GNUNET_malloc (sizeof (struct GNUNET_SERVER_Client));
990 client->client_closure = chandle;
991 client->receive = creceive;
992 client->receive_cancel = ccancel;
993 client->notify_transmit_ready = cnotify;
994 client->notify_transmit_ready_cancel = cnotify_cancel;
995 client->check = ccheck;
996 client->destroy = cdestroy;
997 client->reference_count = 1;
998 add_client (server, client);
1004 * Notify the server that the given client handle should
1005 * be kept (keeps the connection up if possible, increments
1006 * the internal reference counter).
1008 * @param client the client to keep
1011 GNUNET_SERVER_client_keep (struct GNUNET_SERVER_Client *client)
1013 client->reference_count++;
1018 * Notify the server that the given client handle is no
1019 * longer required. Decrements the reference counter. If
1020 * that counter reaches zero an inactive connection maybe
1023 * @param client the client to drop
1026 GNUNET_SERVER_client_drop (struct GNUNET_SERVER_Client *client)
1028 GNUNET_assert (client->reference_count > 0);
1029 client->reference_count--;
1030 if ((client->server == NULL) && (client->reference_count == 0))
1031 shutdown_incoming_processing (client);
1036 * Obtain the network address of the other party.
1038 * @param client the client to get the address for
1039 * @param addr where to store the address
1040 * @param addrlen where to store the length of the address
1041 * @return GNUNET_OK on success
1044 GNUNET_SERVER_client_get_address (struct GNUNET_SERVER_Client *client,
1045 void **addr, size_t * addrlen)
1047 if (client->receive != &sock_receive)
1048 return GNUNET_SYSERR; /* not a network client */
1049 return GNUNET_CONNECTION_get_address (client->client_closure,
1055 * Ask the server to notify us whenever a client disconnects.
1056 * This function is called whenever the actual network connection
1057 * is closed; the reference count may be zero or larger than zero
1060 * @param server the server manageing the clients
1061 * @param callback function to call on disconnect
1062 * @param callback_cls closure for callback
1065 GNUNET_SERVER_disconnect_notify (struct GNUNET_SERVER_Handle *server,
1066 GNUNET_SERVER_DisconnectCallback callback,
1069 struct NotifyList *n;
1071 n = GNUNET_malloc (sizeof (struct NotifyList));
1072 n->callback = callback;
1073 n->callback_cls = callback_cls;
1074 n->next = server->disconnect_notify_list;
1075 server->disconnect_notify_list = n;
1080 * Ask the server to disconnect from the given client.
1081 * This is the same as returning GNUNET_SYSERR from a message
1082 * handler, except that it allows dropping of a client even
1083 * when not handling a message from that client.
1085 * @param client the client to disconnect from
1088 GNUNET_SERVER_client_disconnect (struct GNUNET_SERVER_Client *client)
1090 if (client->server == NULL)
1091 return; /* already disconnected */
1092 client->receive_cancel (client->client_closure);
1093 shutdown_incoming_processing (client);
1098 * Notify us when the server has enough space to transmit
1099 * a message of the given size to the given client.
1101 * @param client client to transmit message to
1102 * @param size requested amount of buffer space
1103 * @param timeout after how long should we give up (and call
1104 * notify with buf NULL and size 0)?
1105 * @param callback function to call when space is available
1106 * @param callback_cls closure for callback
1107 * @return non-NULL if the notify callback was queued; can be used
1108 * to cancel the request using
1109 * GNUNET_CONNECTION_notify_transmit_ready_cancel.
1110 * NULL if we are already going to notify someone else (busy)
1112 struct GNUNET_CONNECTION_TransmitHandle *
1113 GNUNET_SERVER_notify_transmit_ready (struct GNUNET_SERVER_Client *client,
1115 struct GNUNET_TIME_Relative timeout,
1116 GNUNET_CONNECTION_TransmitReadyNotify
1117 callback, void *callback_cls)
1119 return client->notify_transmit_ready (client->client_closure,
1121 timeout, callback, callback_cls);
1126 * Resume receiving from this client, we are done processing the
1127 * current request. This function must be called from within each
1128 * GNUNET_SERVER_MessageCallback (or its respective continuations).
1130 * @param client client we were processing a message of
1131 * @param success GNUNET_OK to keep the connection open and
1132 * continue to receive
1133 * GNUNET_SYSERR to close the connection (signal
1137 GNUNET_SERVER_receive_done (struct GNUNET_SERVER_Client *client, int success)
1143 GNUNET_assert (client->suspended > 0);
1144 client->suspended--;
1145 if (success != GNUNET_OK)
1146 client->shutdown_now = GNUNET_YES;
1147 if (client->suspended > 0)
1149 if (client->in_process_client_buffer == GNUNET_YES)
1151 if (client->side_buf_size > 0)
1153 /* resume processing from side-buf */
1154 sb = client->side_buf;
1155 client->side_buf = NULL;
1156 /* this will also resume the receive job */
1157 if (GNUNET_YES != client->shutdown_now)
1158 process_incoming (client, sb, client->side_buf_size, NULL, 0, 0);
1160 shutdown_incoming_processing (client);
1161 /* finally, free the side-buf */
1165 /* resume receive job */
1166 if (GNUNET_YES != client->shutdown_now)
1168 GNUNET_SCHEDULER_add_continuation (client->server->sched,
1169 &restart_processing,
1171 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
1174 shutdown_incoming_processing (client);
1178 /* end of server.c */