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,
276 "Server shutting down.\n");
278 GNUNET_assert (server->listen_socket == NULL);
279 if (GNUNET_OK != GNUNET_DISK_pipe_close (server->shutpipe))
280 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING,
282 while (server->clients != NULL)
284 pos = server->clients;
285 server->clients = pos->next;
288 while (NULL != (hpos = server->handlers))
290 server->handlers = hpos->next;
293 while (NULL != (npos = server->disconnect_notify_list))
295 server->disconnect_notify_list = npos->next;
298 GNUNET_free (server);
303 * Scheduler says our listen socket is ready.
307 process_listen_socket (void *cls,
308 const struct GNUNET_SCHEDULER_TaskContext *tc)
310 struct GNUNET_SERVER_Handle *server = cls;
311 struct GNUNET_CONNECTION_Handle *sock;
312 struct GNUNET_SERVER_Client *client;
313 struct GNUNET_NETWORK_FDSet *r;
314 const struct GNUNET_DISK_FileHandle *shutpipe;
316 if ((server->do_shutdown) ||
317 ((tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN) != 0))
319 /* shutdown was initiated */
320 GNUNET_assert (server->listen_socket != NULL);
321 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (server->listen_socket));
322 server->listen_socket = NULL;
323 if (server->do_shutdown)
324 destroy_server (server);
327 shutpipe = GNUNET_DISK_pipe_handle (server->shutpipe, 0);
328 GNUNET_assert (GNUNET_NETWORK_fdset_isset (tc->read_ready, server->listen_socket));
329 GNUNET_assert (!GNUNET_NETWORK_fdset_handle_isset (tc->read_ready, shutpipe));
330 sock = GNUNET_CONNECTION_create_from_accept (tc->sched,
333 server->listen_socket,
338 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
339 "Server accepted incoming connection.\n");
341 client = GNUNET_SERVER_connect_socket (server, sock);
342 /* decrement reference count, we don't keep "client" alive */
343 GNUNET_SERVER_client_drop (client);
345 /* listen for more! */
346 r = GNUNET_NETWORK_fdset_create ();
347 GNUNET_NETWORK_fdset_set (r, server->listen_socket);
348 GNUNET_NETWORK_fdset_handle_set (r, shutpipe);
349 GNUNET_SCHEDULER_add_select (server->sched,
351 GNUNET_SCHEDULER_PRIORITY_HIGH,
352 GNUNET_SCHEDULER_NO_TASK,
353 GNUNET_TIME_UNIT_FOREVER_REL,
355 &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_socket (serverAddr->sa_family, SOCK_STREAM, 0);
387 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "socket");
391 if (GNUNET_OK != GNUNET_NETWORK_socket_set_inheritable (sock))
392 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
395 if (GNUNET_NETWORK_socket_setsockopt (sock, SOL_SOCKET, SO_REUSEADDR, &on, sizeof (on)) != GNUNET_OK)
396 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
398 /* bind the socket */
399 if (GNUNET_NETWORK_socket_bind (sock, serverAddr, socklen) != GNUNET_OK)
401 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "bind");
402 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
404 ("`%s' failed for port %d. Is the service already running?\n"),
406 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (sock));
409 if (GNUNET_OK != GNUNET_NETWORK_socket_listen (sock, 5))
411 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "listen");
412 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (sock));
416 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
417 "Server starts to listen on port %u.\n",
425 * Create a new server.
427 * @param sched scheduler to use
428 * @param access function for access control
429 * @param access_cls closure for access
430 * @param serverAddr address to listen on (including port), use NULL
431 * for internal server (no listening)
432 * @param socklen length of serverAddr
433 * @param maxbuf maximum write buffer size for accepted sockets
434 * @param idle_timeout after how long should we timeout idle connections?
435 * @param require_found if YES, connections sending messages of unknown type
437 * @return handle for the new server, NULL on error
438 * (typically, "port" already in use)
440 struct GNUNET_SERVER_Handle *
441 GNUNET_SERVER_create (struct GNUNET_SCHEDULER_Handle *sched,
442 GNUNET_CONNECTION_AccessCheck access,
444 const struct sockaddr *serverAddr,
447 struct GNUNET_TIME_Relative
448 idle_timeout, int require_found)
450 struct GNUNET_SERVER_Handle *ret;
451 struct GNUNET_NETWORK_Handle *lsock;
452 struct GNUNET_NETWORK_FDSet *r;
455 if (serverAddr != NULL)
457 lsock = open_listen_socket (serverAddr, socklen);
461 ret = GNUNET_malloc (sizeof (struct GNUNET_SERVER_Handle));
462 ret->shutpipe = GNUNET_malloc (sizeof (struct GNUNET_DISK_FileDescriptor *[2]));
463 if (NULL == (ret->shutpipe = GNUNET_DISK_pipe (GNUNET_NO)))
465 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (lsock));
466 GNUNET_free (ret->shutpipe);
471 ret->maxbuf = maxbuf;
472 ret->idle_timeout = idle_timeout;
473 ret->listen_socket = lsock;
474 ret->access = access;
475 ret->access_cls = access_cls;
476 ret->require_found = require_found;
479 r = GNUNET_NETWORK_fdset_create ();
480 GNUNET_NETWORK_fdset_set (r, ret->listen_socket);
481 GNUNET_NETWORK_fdset_handle_set (r, GNUNET_DISK_pipe_handle (ret->shutpipe, 0));
482 GNUNET_SCHEDULER_add_select (sched,
484 GNUNET_SCHEDULER_PRIORITY_HIGH,
485 GNUNET_SCHEDULER_NO_TASK,
486 GNUNET_TIME_UNIT_FOREVER_REL,
488 NULL, &process_listen_socket, ret);
489 GNUNET_NETWORK_fdset_destroy (r);
496 * Free resources held by this server.
499 GNUNET_SERVER_destroy (struct GNUNET_SERVER_Handle *s)
503 GNUNET_assert (s->do_shutdown == GNUNET_NO);
504 s->do_shutdown = GNUNET_YES;
505 if (s->listen_socket == NULL)
508 GNUNET_break (1 == GNUNET_DISK_file_write (GNUNET_DISK_pipe_handle (s->shutpipe, 1), &c, 1));
513 * Add additional handlers to an existing server.
515 * @param server the server to add handlers to
516 * @param handlers array of message handlers for
517 * incoming messages; the last entry must
518 * have "NULL" for the "callback"; multiple
519 * entries for the same type are allowed,
520 * they will be called in order of occurence.
521 * These handlers can be removed later;
522 * the handlers array must exist until removed
523 * (or server is destroyed).
526 GNUNET_SERVER_add_handlers (struct GNUNET_SERVER_Handle *server,
527 const struct GNUNET_SERVER_MessageHandler
530 struct HandlerList *p;
532 p = GNUNET_malloc (sizeof (struct HandlerList));
533 p->handlers = handlers;
534 p->next = server->handlers;
535 server->handlers = p;
540 * Inject a message into the server, pretend it came
541 * from the specified client. Delivery of the message
542 * will happen instantly (if a handler is installed;
543 * otherwise the call does nothing).
545 * @param server the server receiving the message
546 * @param sender the "pretended" sender of the message
548 * @param message message to transmit
549 * @return GNUNET_OK if the message was OK and the
550 * connection can stay open
551 * GNUNET_SYSERR if the connection to the
552 * client should be shut down
555 GNUNET_SERVER_inject (struct GNUNET_SERVER_Handle *server,
556 struct GNUNET_SERVER_Client *sender,
557 const struct GNUNET_MessageHeader *message)
559 struct HandlerList *pos;
560 const struct GNUNET_SERVER_MessageHandler *mh;
566 type = ntohs (message->type);
567 size = ntohs (message->size);
569 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
570 "Server schedules transmission of %u-byte message of type %u to client.\n",
574 pos = server->handlers;
579 while (pos->handlers[i].callback != NULL)
581 mh = &pos->handlers[i];
582 if (mh->type == type)
584 if ((mh->expected_size != 0) && (mh->expected_size != size))
587 return GNUNET_SYSERR;
591 mh->callback (mh->callback_cls, sender, message);
598 if (found == GNUNET_NO)
600 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
601 _("Received message of unknown type %d\n"), type);
602 if (server->require_found == GNUNET_YES)
603 return GNUNET_SYSERR;
610 * We're finished with this client and especially its input
611 * processing. If the RC is zero, free all resources otherwise wait
612 * until RC hits zero to do so.
615 shutdown_incoming_processing (struct GNUNET_SERVER_Client *client)
617 struct GNUNET_SERVER_Client *prev;
618 struct GNUNET_SERVER_Client *pos;
619 struct GNUNET_SERVER_Handle *server;
620 struct NotifyList *n;
623 rc = client->reference_count;
624 if (client->server != NULL)
626 server = client->server;
627 client->server = NULL;
629 pos = server->clients;
630 while ((pos != NULL) && (pos != client))
635 GNUNET_assert (pos != NULL);
637 server->clients = pos->next;
639 prev->next = pos->next;
640 n = server->disconnect_notify_list;
643 n->callback (n->callback_cls, client);
647 /* wait for RC to hit zero, then free */
650 client->destroy (client->client_closure);
651 GNUNET_free (client);
656 * Go over the contents of the client buffer; as long as full messages
657 * are available, pass them on for processing. Update the buffer
658 * accordingly. Handles fatal errors by shutting down the connection.
660 * @param client identifies which client receive buffer to process
663 process_client_buffer (struct GNUNET_SERVER_Client *client)
665 struct GNUNET_SERVER_Handle *server;
666 const struct GNUNET_MessageHeader *hdr;
669 client->in_process_client_buffer = GNUNET_YES;
670 server = client->server;
672 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
673 "Private buffer contains %u bytes; client is %s and we are %s\n",
675 client->suspended ? "suspended" : "up",
676 client->shutdown_now ? "in shutdown" : "running");
678 while ((client->receive_pos >= sizeof (struct GNUNET_MessageHeader)) &&
679 (0 == client->suspended) && (GNUNET_YES != client->shutdown_now))
681 hdr = (const struct GNUNET_MessageHeader *) &client->incoming_buffer;
682 msize = ntohs (hdr->size);
683 if (msize > client->receive_pos)
686 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
687 "Total message size is %u, we only have %u bytes; need more data\n",
689 client->receive_pos);
694 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
695 "Passing %u bytes to callback for processing\n",
698 if ((msize < sizeof (struct GNUNET_MessageHeader)) ||
699 (GNUNET_OK != GNUNET_SERVER_inject (server, client, hdr)))
701 client->in_process_client_buffer = GNUNET_NO;
702 shutdown_incoming_processing (client);
705 /* FIXME: this is highly inefficient; we should
706 try to avoid this if the new base address is
707 already nicely aligned. See old handler code... */
708 memmove (client->incoming_buffer,
709 &client->incoming_buffer[msize], client->receive_pos - msize);
710 client->receive_pos -= msize;
712 client->in_process_client_buffer = GNUNET_NO;
713 if (GNUNET_YES == client->shutdown_now)
714 shutdown_incoming_processing (client);
719 * We are receiving an incoming message. Process it.
721 * @param cls our closure (handle for the client)
722 * @param buf buffer with data received from network
723 * @param available number of bytes available in buf
724 * @param addr address of the sender
725 * @param addrlen length of addr
726 * @param errCode code indicating errors receiving, 0 for success
729 process_incoming (void *cls,
732 const struct sockaddr *addr,
736 struct GNUNET_SERVER_Client *client = cls;
737 struct GNUNET_SERVER_Handle *server = client->server;
738 const char *cbuf = buf;
745 (client->shutdown_now == GNUNET_YES) ||
746 (GNUNET_YES != client->check (client->client_closure)))
748 /* other side closed connection, error connecting, etc. */
749 shutdown_incoming_processing (client);
753 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
754 "Server receives %u bytes from `%s'.\n",
756 GNUNET_a2s(addr, addrlen));
758 GNUNET_SERVER_client_keep (client);
759 client->last_activity = GNUNET_TIME_absolute_get ();
760 /* process data (if available) */
761 while (available > 0)
764 if (maxcpy > sizeof (client->incoming_buffer) - client->receive_pos)
765 maxcpy = sizeof (client->incoming_buffer) - client->receive_pos;
767 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
768 "Can copy %u bytes to private buffer\n",
771 memcpy (&client->incoming_buffer[client->receive_pos], cbuf, maxcpy);
772 client->receive_pos += maxcpy;
775 if (0 < client->suspended)
780 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
781 "Client has suspended processing; copying %u bytes to side buffer to be used later.\n",
784 GNUNET_assert (client->side_buf_size == 0);
785 GNUNET_assert (client->side_buf == NULL);
786 client->side_buf_size = available;
787 client->side_buf = GNUNET_malloc (available);
788 memcpy (client->side_buf, cbuf, available);
791 break; /* do not run next client iteration! */
794 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
795 "Now processing messages in private buffer\n");
797 process_client_buffer (client);
799 GNUNET_assert (available == 0);
800 if ((client->suspended == 0) &&
801 (GNUNET_YES != client->shutdown_now) && (client->server != NULL))
803 /* Finally, keep receiving! */
804 client->receive (client->client_closure,
805 GNUNET_SERVER_MAX_MESSAGE_SIZE,
806 server->idle_timeout,
807 &process_incoming, client);
809 if (GNUNET_YES == client->shutdown_now)
810 shutdown_incoming_processing (client);
811 GNUNET_SERVER_client_drop (client);
819 restart_processing (void *cls, const struct GNUNET_SCHEDULER_TaskContext *tc)
821 struct GNUNET_SERVER_Client *client = cls;
823 process_client_buffer (client);
824 if (0 == client->suspended)
825 client->receive (client->client_closure,
826 GNUNET_SERVER_MAX_MESSAGE_SIZE,
827 client->server->idle_timeout,
828 &process_incoming, client);
833 * Add a client to the set of our clients and
837 add_client (struct GNUNET_SERVER_Handle *server,
838 struct GNUNET_SERVER_Client *client)
840 client->server = server;
841 client->last_activity = GNUNET_TIME_absolute_get ();
842 client->next = server->clients;
843 server->clients = client;
844 client->receive (client->client_closure,
845 GNUNET_SERVER_MAX_MESSAGE_SIZE,
846 server->idle_timeout,
847 &process_incoming, client);
852 * Create a request for receiving data from a socket.
854 * @param cls identifies the socket to receive from
855 * @param max how much data to read at most
856 * @param timeout when should this operation time out
857 * @param receiver function to call for processing
858 * @param receiver_cls closure for receiver
861 sock_receive (void *cls,
863 struct GNUNET_TIME_Relative timeout,
864 GNUNET_CONNECTION_Receiver receiver, void *receiver_cls)
866 GNUNET_CONNECTION_receive (cls, max, timeout, receiver, receiver_cls);
871 * Wrapper to cancel receiving from a socket.
873 * @param cls handle to the GNUNET_CONNECTION_Handle to cancel
876 sock_receive_cancel (void *cls)
878 GNUNET_CONNECTION_receive_cancel (cls);
886 sock_notify_transmit_ready (void *cls,
888 struct GNUNET_TIME_Relative timeout,
889 GNUNET_CONNECTION_TransmitReadyNotify notify,
892 return GNUNET_CONNECTION_notify_transmit_ready (cls, size, timeout, notify,
901 sock_notify_transmit_ready_cancel (void *cls, void *h)
903 GNUNET_CONNECTION_notify_transmit_ready_cancel (h);
908 * Check if socket is still valid (no fatal errors have happened so far).
910 * @param cls the socket
911 * @return GNUNET_YES if valid, GNUNET_NO otherwise
914 sock_check (void *cls)
916 return GNUNET_CONNECTION_check (cls);
921 * Destroy this socket (free resources).
923 * @param cls the socket
926 sock_destroy (void *cls)
928 GNUNET_CONNECTION_destroy (cls);
933 * Add a TCP socket-based connection to the set of handles managed by
934 * this server. Use this function for outgoing (P2P) connections that
935 * we initiated (and where this server should process incoming
938 * @param server the server to use
939 * @param connection the connection to manage (client must
940 * stop using this connection from now on)
941 * @return the client handle (client should call
942 * "client_drop" on the return value eventually)
944 struct GNUNET_SERVER_Client *
945 GNUNET_SERVER_connect_socket (struct
948 struct GNUNET_CONNECTION_Handle *connection)
950 struct GNUNET_SERVER_Client *client;
952 client = GNUNET_malloc (sizeof (struct GNUNET_SERVER_Client));
953 client->client_closure = connection;
954 client->receive = &sock_receive;
955 client->receive_cancel = &sock_receive_cancel;
956 client->notify_transmit_ready = &sock_notify_transmit_ready;
957 client->notify_transmit_ready_cancel = &sock_notify_transmit_ready_cancel;
958 client->check = &sock_check;
959 client->destroy = &sock_destroy;
960 client->reference_count = 1;
961 add_client (server, client);
967 * Add an arbitrary connection to the set of handles managed by this
968 * server. This can be used if a sending and receiving does not
969 * really go over the network (internal transmission) or for servers
972 * @param server the server to use
973 * @param chandle opaque handle for the connection
974 * @param creceive receive function for the connection
975 * @param ccancel cancel receive function for the connection
976 * @param cnotify transmit notification function for the connection
977 * @param cnotify_cancel transmit notification cancellation function for the connection
978 * @param ccheck function to test if the connection is still up
979 * @param cdestroy function to close and free the connection
980 * @return the client handle (client should call
981 * "client_drop" on the return value eventually)
983 struct GNUNET_SERVER_Client *
984 GNUNET_SERVER_connect_callback (struct
988 GNUNET_SERVER_ReceiveCallback
990 GNUNET_SERVER_ReceiveCancelCallback
992 GNUNET_SERVER_TransmitReadyCallback
994 GNUNET_SERVER_TransmitReadyCancelCallback
996 GNUNET_SERVER_CheckCallback
998 GNUNET_SERVER_DestroyCallback cdestroy)
1000 struct GNUNET_SERVER_Client *client;
1002 client = GNUNET_malloc (sizeof (struct GNUNET_SERVER_Client));
1003 client->client_closure = chandle;
1004 client->receive = creceive;
1005 client->receive_cancel = ccancel;
1006 client->notify_transmit_ready = cnotify;
1007 client->notify_transmit_ready_cancel = cnotify_cancel;
1008 client->check = ccheck;
1009 client->destroy = cdestroy;
1010 client->reference_count = 1;
1011 add_client (server, client);
1017 * Notify the server that the given client handle should
1018 * be kept (keeps the connection up if possible, increments
1019 * the internal reference counter).
1021 * @param client the client to keep
1024 GNUNET_SERVER_client_keep (struct GNUNET_SERVER_Client *client)
1026 client->reference_count++;
1031 * Notify the server that the given client handle is no
1032 * longer required. Decrements the reference counter. If
1033 * that counter reaches zero an inactive connection maybe
1036 * @param client the client to drop
1039 GNUNET_SERVER_client_drop (struct GNUNET_SERVER_Client *client)
1041 GNUNET_assert (client->reference_count > 0);
1042 client->reference_count--;
1043 if ((client->server == NULL) && (client->reference_count == 0))
1044 shutdown_incoming_processing (client);
1049 * Obtain the network address of the other party.
1051 * @param client the client to get the address for
1052 * @param addr where to store the address
1053 * @param addrlen where to store the length of the address
1054 * @return GNUNET_OK on success
1057 GNUNET_SERVER_client_get_address (struct GNUNET_SERVER_Client *client,
1058 void **addr, size_t * addrlen)
1060 if (client->receive != &sock_receive)
1061 return GNUNET_SYSERR; /* not a network client */
1062 return GNUNET_CONNECTION_get_address (client->client_closure,
1068 * Ask the server to notify us whenever a client disconnects.
1069 * This function is called whenever the actual network connection
1070 * is closed; the reference count may be zero or larger than zero
1073 * @param server the server manageing the clients
1074 * @param callback function to call on disconnect
1075 * @param callback_cls closure for callback
1078 GNUNET_SERVER_disconnect_notify (struct GNUNET_SERVER_Handle *server,
1079 GNUNET_SERVER_DisconnectCallback callback,
1082 struct NotifyList *n;
1084 n = GNUNET_malloc (sizeof (struct NotifyList));
1085 n->callback = callback;
1086 n->callback_cls = callback_cls;
1087 n->next = server->disconnect_notify_list;
1088 server->disconnect_notify_list = n;
1093 * Ask the server to disconnect from the given client.
1094 * This is the same as returning GNUNET_SYSERR from a message
1095 * handler, except that it allows dropping of a client even
1096 * when not handling a message from that client.
1098 * @param client the client to disconnect from
1101 GNUNET_SERVER_client_disconnect (struct GNUNET_SERVER_Client *client)
1103 if (client->server == NULL)
1104 return; /* already disconnected */
1105 client->receive_cancel (client->client_closure);
1106 shutdown_incoming_processing (client);
1111 * Notify us when the server has enough space to transmit
1112 * a message of the given size to the given client.
1114 * @param client client to transmit message to
1115 * @param size requested amount of buffer space
1116 * @param timeout after how long should we give up (and call
1117 * notify with buf NULL and size 0)?
1118 * @param callback function to call when space is available
1119 * @param callback_cls closure for callback
1120 * @return non-NULL if the notify callback was queued; can be used
1121 * to cancel the request using
1122 * GNUNET_CONNECTION_notify_transmit_ready_cancel.
1123 * NULL if we are already going to notify someone else (busy)
1125 struct GNUNET_CONNECTION_TransmitHandle *
1126 GNUNET_SERVER_notify_transmit_ready (struct GNUNET_SERVER_Client *client,
1128 struct GNUNET_TIME_Relative timeout,
1129 GNUNET_CONNECTION_TransmitReadyNotify
1130 callback, void *callback_cls)
1132 return client->notify_transmit_ready (client->client_closure,
1134 timeout, callback, callback_cls);
1139 * Resume receiving from this client, we are done processing the
1140 * current request. This function must be called from within each
1141 * GNUNET_SERVER_MessageCallback (or its respective continuations).
1143 * @param client client we were processing a message of
1144 * @param success GNUNET_OK to keep the connection open and
1145 * continue to receive
1146 * GNUNET_SYSERR to close the connection (signal
1150 GNUNET_SERVER_receive_done (struct GNUNET_SERVER_Client *client, int success)
1156 GNUNET_assert (client->suspended > 0);
1157 client->suspended--;
1158 if (success != GNUNET_OK)
1159 client->shutdown_now = GNUNET_YES;
1160 if (client->suspended > 0)
1162 if (client->in_process_client_buffer == GNUNET_YES)
1164 if (client->side_buf_size > 0)
1166 /* resume processing from side-buf */
1167 sb = client->side_buf;
1168 client->side_buf = NULL;
1169 /* this will also resume the receive job */
1170 if (GNUNET_YES != client->shutdown_now)
1171 process_incoming (client, sb, client->side_buf_size, NULL, 0, 0);
1173 shutdown_incoming_processing (client);
1174 /* finally, free the side-buf */
1178 /* resume receive job */
1179 if (GNUNET_YES != client->shutdown_now)
1181 GNUNET_SCHEDULER_add_continuation (client->server->sched,
1183 &restart_processing,
1185 GNUNET_SCHEDULER_REASON_PREREQ_DONE);
1188 shutdown_incoming_processing (client);
1192 /* end of server.c */