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
28 #include "gnunet_common.h"
29 #include "gnunet_connection_lib.h"
30 #include "gnunet_scheduler_lib.h"
31 #include "gnunet_server_lib.h"
32 #include "gnunet_time_lib.h"
33 #include "gnunet_disk_lib.h"
34 #include "gnunet_protocols.h"
36 #define DEBUG_SERVER GNUNET_NO
39 * List of arrays of message handlers.
44 * This is a linked list.
46 struct HandlerList *next;
49 * NULL-terminated array of handlers.
51 const struct GNUNET_SERVER_MessageHandler *handlers;
56 * List of arrays of message handlers.
61 * This is a linked list.
63 struct NotifyList *next;
68 GNUNET_SERVER_DisconnectCallback callback;
71 * Closure for callback.
78 * @brief handle for a server
80 struct GNUNET_SERVER_Handle
83 * List of handlers for incoming messages.
85 struct HandlerList *handlers;
88 * List of our current clients.
90 struct GNUNET_SERVER_Client *clients;
93 * Linked list of functions to call on disconnects by clients.
95 struct NotifyList *disconnect_notify_list;
98 * Function to call for access control.
100 GNUNET_CONNECTION_AccessCheck access;
103 * Closure for access.
108 * NULL-terminated array of sockets used to listen for new
111 struct GNUNET_NETWORK_Handle **listen_sockets;
114 * After how long should an idle connection time
117 struct GNUNET_TIME_Relative idle_timeout;
120 * Task scheduled to do the listening.
122 GNUNET_SCHEDULER_TaskIdentifier listen_task;
125 * Do we ignore messages of types that we do not understand or do we
126 * require that a handler is found (and if not kill the connection)?
131 * Should all of the clients of this server continue to process
132 * connections as usual even if we get a shutdown request? (the
133 * listen socket always ignores shutdown).
135 int clients_ignore_shutdown;
141 * @brief handle for a client of the server
143 struct GNUNET_SERVER_Client
147 * This is a linked list.
149 struct GNUNET_SERVER_Client *next;
152 * Processing of incoming data.
154 struct GNUNET_SERVER_MessageStreamTokenizer *mst;
157 * Server that this client belongs to.
159 struct GNUNET_SERVER_Handle *server;
162 * Client closure for callbacks.
164 struct GNUNET_CONNECTION_Handle *connection;
167 * ID of task used to restart processing.
169 GNUNET_SCHEDULER_TaskIdentifier restart_task;
172 * Task that warns about missing calls to 'GNUNET_SERVER_receive_done'.
174 GNUNET_SCHEDULER_TaskIdentifier warn_task;
177 * Time when the warn task was started.
179 struct GNUNET_TIME_Absolute warn_start;
182 * Last activity on this socket (used to time it out
183 * if reference_count == 0).
185 struct GNUNET_TIME_Absolute last_activity;
190 GNUNET_CONNECTION_TransmitReadyNotify callback;
198 * After how long should an idle connection time
201 struct GNUNET_TIME_Relative idle_timeout;
204 * Number of external entities with a reference to
205 * this client object.
207 unsigned int reference_count;
210 * Was processing if incoming messages suspended while
211 * we were still processing data already received?
212 * This is a counter saying how often processing was
213 * suspended (once per handler invoked).
215 unsigned int suspended;
218 * Are we currently in the "process_client_buffer" function (and
219 * will hence restart the receive job on exit if suspended == 0 once
220 * we are done?). If this is set, then "receive_done" will
221 * essentially only decrement suspended; if this is not set, then
222 * "receive_done" may need to restart the receive process (either
223 * from the side-buffer or via select/recv).
225 int in_process_client_buffer;
228 * We're about to close down this client due to some serious
234 * Are we currently trying to receive? (YES if we are, NO if we are not,
235 * SYSERR if data is already available in MST).
240 * Persist the file handle for this client no matter what happens,
241 * force the OS to close once the process actually dies. Should only
242 * be used in special cases!
247 * Type of last message processed (for warn_no_receive_done).
254 * Scheduler says our listen socket is ready. Process it!
256 * @param cls handle to our server for which we are processing the listen
258 * @param tc reason why we are running right now
261 process_listen_socket (void *cls,
262 const struct GNUNET_SCHEDULER_TaskContext *tc)
264 struct GNUNET_SERVER_Handle *server = cls;
265 struct GNUNET_CONNECTION_Handle *sock;
266 struct GNUNET_SERVER_Client *client;
267 struct GNUNET_NETWORK_FDSet *r;
270 server->listen_task = GNUNET_SCHEDULER_NO_TASK;
271 r = GNUNET_NETWORK_fdset_create ();
273 while (NULL != server->listen_sockets[i])
274 GNUNET_NETWORK_fdset_set (r, server->listen_sockets[i++]);
275 if (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN))
277 /* ignore shutdown, someone else will take care of it! */
278 server->listen_task = GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_HIGH,
279 GNUNET_SCHEDULER_NO_TASK,
280 GNUNET_TIME_UNIT_FOREVER_REL,
282 &process_listen_socket,
284 GNUNET_NETWORK_fdset_destroy (r);
288 while (NULL != server->listen_sockets[i])
290 if (GNUNET_NETWORK_fdset_isset
291 (tc->read_ready, server->listen_sockets[i]))
294 GNUNET_CONNECTION_create_from_accept (server->access,
296 server->listen_sockets[i]);
300 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
301 "Server accepted incoming connection.\n");
303 client = GNUNET_SERVER_connect_socket (server, sock);
304 GNUNET_CONNECTION_ignore_shutdown (sock,
305 server->clients_ignore_shutdown);
306 /* decrement reference count, we don't keep "client" alive */
307 GNUNET_SERVER_client_drop (client);
312 /* listen for more! */
313 server->listen_task = GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_HIGH,
314 GNUNET_SCHEDULER_NO_TASK,
315 GNUNET_TIME_UNIT_FOREVER_REL,
317 &process_listen_socket,
319 GNUNET_NETWORK_fdset_destroy (r);
324 * Create and initialize a listen socket for the server.
326 * @param serverAddr address to listen on
327 * @param socklen length of address
328 * @return NULL on error, otherwise the listen socket
330 static struct GNUNET_NETWORK_Handle *
331 open_listen_socket (const struct sockaddr *serverAddr, socklen_t socklen)
333 const static int on = 1;
334 struct GNUNET_NETWORK_Handle *sock;
338 switch (serverAddr->sa_family)
341 port = ntohs (((const struct sockaddr_in *) serverAddr)->sin_port);
344 port = ntohs (((const struct sockaddr_in6 *) serverAddr)->sin6_port);
354 sock = GNUNET_NETWORK_socket_create (serverAddr->sa_family, SOCK_STREAM, 0);
357 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "socket");
363 if (GNUNET_NETWORK_socket_setsockopt
364 (sock, SOL_SOCKET, SO_REUSEADDR, &on, sizeof (on)) != GNUNET_OK)
365 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
368 if ( (serverAddr->sa_family == AF_INET6) &&
369 (GNUNET_NETWORK_socket_setsockopt
370 (sock, IPPROTO_IPV6, IPV6_V6ONLY, &on, sizeof (on)) != GNUNET_OK) )
371 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
375 /* bind the socket */
376 if (GNUNET_NETWORK_socket_bind (sock, serverAddr, socklen) != GNUNET_OK)
379 if (errno != EADDRINUSE)
381 /* we don't log 'EADDRINUSE' here since an IPv4 bind may
382 fail if we already took the port on IPv6; if both IPv4 and
383 IPv6 binds fail, then our caller will log using the
384 errno preserved in 'eno' */
385 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "bind");
387 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
389 ("`%s' failed for port %d (%s).\n"),
391 (serverAddr->sa_family == AF_INET) ? "IPv4" : "IPv6");
397 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
399 ("`%s' failed for port %d (%s): address already in use\n"),
401 (serverAddr->sa_family == AF_INET) ? "IPv4" : "IPv6");
402 else if (serverAddr->sa_family == AF_UNIX)
403 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
405 ("`%s' failed for `%s': address already in use\n"),
407 ((const struct sockaddr_un*) serverAddr)->sun_path);
410 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (sock));
414 if (GNUNET_OK != GNUNET_NETWORK_socket_listen (sock, 5))
416 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "listen");
417 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (sock));
423 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
424 "Server starts to listen on port %u.\n", port);
431 * Create a new server.
433 * @param access function for access control
434 * @param access_cls closure for access
435 * @param lsocks NULL-terminated array of listen sockets
436 * @param idle_timeout after how long should we timeout idle connections?
437 * @param require_found if YES, connections sending messages of unknown type
439 * @return handle for the new server, NULL on error
440 * (typically, "port" already in use)
442 struct GNUNET_SERVER_Handle *
443 GNUNET_SERVER_create_with_sockets (GNUNET_CONNECTION_AccessCheck access, void *access_cls,
444 struct GNUNET_NETWORK_Handle **lsocks,
445 struct GNUNET_TIME_Relative
449 struct GNUNET_SERVER_Handle *ret;
450 struct GNUNET_NETWORK_FDSet *r;
453 ret = GNUNET_malloc (sizeof (struct GNUNET_SERVER_Handle));
454 ret->idle_timeout = idle_timeout;
455 ret->listen_sockets = lsocks;
456 ret->access = access;
457 ret->access_cls = access_cls;
458 ret->require_found = require_found;
461 r = GNUNET_NETWORK_fdset_create ();
463 while (NULL != ret->listen_sockets[i])
464 GNUNET_NETWORK_fdset_set (r, ret->listen_sockets[i++]);
465 ret->listen_task = GNUNET_SCHEDULER_add_select (GNUNET_SCHEDULER_PRIORITY_HIGH,
466 GNUNET_SCHEDULER_NO_TASK,
467 GNUNET_TIME_UNIT_FOREVER_REL,
469 &process_listen_socket,
471 GNUNET_NETWORK_fdset_destroy (r);
478 * Create a new server.
480 * @param access function for access control
481 * @param access_cls closure for access
482 * @param serverAddr address to listen on (including port), NULL terminated array
483 * @param socklen length of serverAddr
484 * @param idle_timeout after how long should we timeout idle connections?
485 * @param require_found if YES, connections sending messages of unknown type
487 * @return handle for the new server, NULL on error
488 * (typically, "port" already in use)
490 struct GNUNET_SERVER_Handle *
491 GNUNET_SERVER_create (GNUNET_CONNECTION_AccessCheck access,
493 struct sockaddr *const *serverAddr,
494 const socklen_t * socklen,
495 struct GNUNET_TIME_Relative
496 idle_timeout, int require_found)
498 struct GNUNET_NETWORK_Handle **lsocks;
503 while (serverAddr[i] != NULL)
508 GNUNET_malloc (sizeof (struct GNUNET_NETWORK_Handle *) * (i + 1));
511 while (serverAddr[i] != NULL)
513 lsocks[j] = open_listen_socket (serverAddr[i], socklen[i]);
514 if (lsocks[j] != NULL)
521 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "bind");
522 GNUNET_free (lsocks);
530 return GNUNET_SERVER_create_with_sockets (access, access_cls,
538 * Free resources held by this server.
540 * @param s server to destroy
543 GNUNET_SERVER_destroy (struct GNUNET_SERVER_Handle *s)
545 struct HandlerList *hpos;
546 struct NotifyList *npos;
550 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Server shutting down.\n");
552 if (GNUNET_SCHEDULER_NO_TASK != s->listen_task)
554 GNUNET_SCHEDULER_cancel (s->listen_task);
555 s->listen_task = GNUNET_SCHEDULER_NO_TASK;
557 if (s->listen_sockets != NULL)
560 while (s->listen_sockets[i] != NULL)
561 GNUNET_break (GNUNET_OK ==
562 GNUNET_NETWORK_socket_close (s->listen_sockets[i++]));
563 GNUNET_free (s->listen_sockets);
564 s->listen_sockets = NULL;
566 while (s->clients != NULL)
567 GNUNET_SERVER_client_disconnect (s->clients);
568 while (NULL != (hpos = s->handlers))
570 s->handlers = hpos->next;
573 while (NULL != (npos = s->disconnect_notify_list))
575 npos->callback (npos->callback_cls, NULL);
576 s->disconnect_notify_list = npos->next;
584 * Add additional handlers to an existing server.
586 * @param server the server to add handlers to
587 * @param handlers array of message handlers for
588 * incoming messages; the last entry must
589 * have "NULL" for the "callback"; multiple
590 * entries for the same type are allowed,
591 * they will be called in order of occurence.
592 * These handlers can be removed later;
593 * the handlers array must exist until removed
594 * (or server is destroyed).
597 GNUNET_SERVER_add_handlers (struct GNUNET_SERVER_Handle *server,
598 const struct GNUNET_SERVER_MessageHandler
601 struct HandlerList *p;
603 p = GNUNET_malloc (sizeof (struct HandlerList));
604 p->handlers = handlers;
605 p->next = server->handlers;
606 server->handlers = p;
611 * Task run to warn about missing calls to 'GNUNET_SERVER_receive_done'.
613 * @param cls our 'struct GNUNET_SERVER_Client*' to process more requests from
614 * @param tc scheduler context (unused)
617 warn_no_receive_done (void *cls,
618 const struct GNUNET_SCHEDULER_TaskContext *tc)
620 struct GNUNET_SERVER_Client *client = cls;
622 client->warn_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
623 &warn_no_receive_done,
625 if (0 == (GNUNET_SCHEDULER_REASON_SHUTDOWN & tc->reason))
626 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
627 _("Processing code for message of type %u did not call GNUNET_SERVER_receive_done after %llums\n"),
628 (unsigned int) client->warn_type,
629 (unsigned long long) GNUNET_TIME_absolute_get_duration (client->warn_start).rel_value);
634 * Disable the warning the server issues if a message is not acknowledged
635 * in a timely fashion. Use this call if a client is intentionally delayed
636 * for a while. Only applies to the current message.
638 * @param client client for which to disable the warning
641 GNUNET_SERVER_disable_receive_done_warning (struct GNUNET_SERVER_Client *client)
643 if (GNUNET_SCHEDULER_NO_TASK != client->warn_task)
645 GNUNET_SCHEDULER_cancel (client->warn_task);
646 client->warn_task = GNUNET_SCHEDULER_NO_TASK;
652 * Inject a message into the server, pretend it came
653 * from the specified client. Delivery of the message
654 * will happen instantly (if a handler is installed;
655 * otherwise the call does nothing).
657 * @param server the server receiving the message
658 * @param sender the "pretended" sender of the message
660 * @param message message to transmit
661 * @return GNUNET_OK if the message was OK and the
662 * connection can stay open
663 * GNUNET_SYSERR if the connection to the
664 * client should be shut down
667 GNUNET_SERVER_inject (struct GNUNET_SERVER_Handle *server,
668 struct GNUNET_SERVER_Client *sender,
669 const struct GNUNET_MessageHeader *message)
671 struct HandlerList *pos;
672 const struct GNUNET_SERVER_MessageHandler *mh;
678 type = ntohs (message->type);
679 size = ntohs (message->size);
682 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
683 "Server schedules transmission of %u-byte message of type %u to client.\n",
686 pos = server->handlers;
691 while (pos->handlers[i].callback != NULL)
693 mh = &pos->handlers[i];
694 if ( (mh->type == type) ||
695 (mh->type == GNUNET_MESSAGE_TYPE_ALL) )
697 if ((mh->expected_size != 0) && (mh->expected_size != size))
699 #if GNUNET8_NETWORK_IS_DEAD
700 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
701 "Expected %u bytes for message of type %u, got %u\n",
707 return GNUNET_SYSERR;
711 if (0 == sender->suspended)
713 sender->warn_start = GNUNET_TIME_absolute_get ();
714 sender->warn_task = GNUNET_SCHEDULER_add_delayed (GNUNET_TIME_UNIT_MINUTES,
715 &warn_no_receive_done,
717 sender->warn_type = type;
721 mh->callback (mh->callback_cls, sender, message);
728 if (found == GNUNET_NO)
730 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG | GNUNET_ERROR_TYPE_BULK,
731 "Received message of unknown type %d\n",
733 if (server->require_found == GNUNET_YES)
734 return GNUNET_SYSERR;
741 * We are receiving an incoming message. Process it.
743 * @param cls our closure (handle for the client)
744 * @param buf buffer with data received from network
745 * @param available number of bytes available in buf
746 * @param addr address of the sender
747 * @param addrlen length of addr
748 * @param errCode code indicating errors receiving, 0 for success
751 process_incoming (void *cls,
754 const struct sockaddr *addr,
755 socklen_t addrlen, int errCode);
759 * Process messages from the client's message tokenizer until either
760 * the tokenizer is empty (and then schedule receiving more), or
761 * until some handler is not immediately done (then wait for restart_processing)
764 * @param client the client to process, RC must have already been increased
765 * using GNUNET_SERVER_client_keep and will be decreased by one in this
767 * @param ret GNUNET_NO to start processing from the buffer,
768 * GNUNET_OK if the mst buffer is drained and we should instantly go back to receiving
769 * GNUNET_SYSERR if we should instantly abort due to error in a previous step
772 process_mst (struct GNUNET_SERVER_Client *client,
775 while ( (ret != GNUNET_SYSERR) &&
776 (client->server != NULL) &&
777 (GNUNET_YES != client->shutdown_now) &&
778 (0 == client->suspended) )
780 if (ret == GNUNET_OK)
782 client->receive_pending = GNUNET_YES;
784 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
785 "Server re-enters receive loop, timeout: %llu.\n", client->idle_timeout.rel_value);
787 GNUNET_CONNECTION_receive (client->connection,
788 GNUNET_SERVER_MAX_MESSAGE_SIZE - 1,
789 client->idle_timeout,
790 &process_incoming, client);
794 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Server processes additional messages instantly.\n");
796 ret = GNUNET_SERVER_mst_receive (client->mst, client, NULL, 0, GNUNET_NO, GNUNET_YES);
799 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
800 "Server leaves instant processing loop: ret = %d, server = %p, shutdown = %d, suspended = %u\n",
803 client->shutdown_now,
807 if (ret == GNUNET_NO)
810 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
811 "Server has more data pending but is suspended.\n");
813 client->receive_pending = GNUNET_SYSERR; /* data pending */
815 if ( (ret == GNUNET_SYSERR) ||
816 (GNUNET_YES == client->shutdown_now) )
817 GNUNET_SERVER_client_disconnect (client);
818 GNUNET_SERVER_client_drop (client);
823 * We are receiving an incoming message. Process it.
825 * @param cls our closure (handle for the client)
826 * @param buf buffer with data received from network
827 * @param available number of bytes available in buf
828 * @param addr address of the sender
829 * @param addrlen length of addr
830 * @param errCode code indicating errors receiving, 0 for success
833 process_incoming (void *cls,
836 const struct sockaddr *addr,
837 socklen_t addrlen, int errCode)
839 struct GNUNET_SERVER_Client *client = cls;
840 struct GNUNET_SERVER_Handle *server = client->server;
841 struct GNUNET_TIME_Absolute end;
842 struct GNUNET_TIME_Absolute now;
845 GNUNET_assert (client->receive_pending == GNUNET_YES);
846 client->receive_pending = GNUNET_NO;
847 now = GNUNET_TIME_absolute_get ();
848 end = GNUNET_TIME_absolute_add (client->last_activity,
849 client->idle_timeout);
851 if ( (buf == NULL) && (available == 0) && (addr == NULL) && (errCode == 0) &&
852 (client->shutdown_now != GNUNET_YES) &&
854 (GNUNET_YES == GNUNET_CONNECTION_check (client->connection)) &&
855 (end.abs_value > now.abs_value) )
857 /* wait longer, timeout changed (i.e. due to us sending) */
859 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
860 "Receive time out, but no disconnect due to sending (%p)\n",
861 GNUNET_a2s (addr, addrlen));
863 client->receive_pending = GNUNET_YES;
864 GNUNET_CONNECTION_receive (client->connection,
865 GNUNET_SERVER_MAX_MESSAGE_SIZE - 1,
866 GNUNET_TIME_absolute_get_remaining (end),
867 &process_incoming, client);
874 (client->shutdown_now == GNUNET_YES) ||
875 (GNUNET_YES != GNUNET_CONNECTION_check (client->connection)))
877 /* other side closed connection, error connecting, etc. */
878 GNUNET_SERVER_client_disconnect (client);
882 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
883 "Server receives %u bytes from `%s'.\n",
884 (unsigned int) available,
885 GNUNET_a2s (addr, addrlen));
887 GNUNET_SERVER_client_keep (client);
888 client->last_activity = now;
889 ret = GNUNET_SERVER_mst_receive (client->mst, client, buf, available, GNUNET_NO, GNUNET_YES);
890 process_mst (client, ret);
895 * Task run to start again receiving from the network
896 * and process requests.
898 * @param cls our 'struct GNUNET_SERVER_Client*' to process more requests from
899 * @param tc scheduler context (unused)
902 restart_processing (void *cls,
903 const struct GNUNET_SCHEDULER_TaskContext *tc)
905 struct GNUNET_SERVER_Client *client = cls;
906 struct GNUNET_SERVER_Handle *server = client->server;
908 client->restart_task = GNUNET_SCHEDULER_NO_TASK;
909 if ( (0 != (tc->reason & GNUNET_SCHEDULER_REASON_SHUTDOWN)) &&
910 (GNUNET_NO == server->clients_ignore_shutdown) )
912 GNUNET_SERVER_client_disconnect (client);
915 if (client->receive_pending == GNUNET_NO)
918 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
919 "Server begins to read again from client.\n");
921 client->receive_pending = GNUNET_YES;
922 GNUNET_CONNECTION_receive (client->connection,
923 GNUNET_SERVER_MAX_MESSAGE_SIZE - 1,
924 client->idle_timeout, &process_incoming, client);
928 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
929 "Server continues processing messages still in the buffer.\n");
931 GNUNET_SERVER_client_keep (client);
932 client->receive_pending = GNUNET_NO;
933 process_mst (client, GNUNET_NO);
938 * This function is called whenever our inbound message tokenizer has
939 * received a complete message.
941 * @param cls closure (struct GNUNET_SERVER_Handle)
942 * @param client identification of the client (struct GNUNET_SERVER_Client*)
943 * @param message the actual message
946 client_message_tokenizer_callback (void *cls,
948 const struct GNUNET_MessageHeader *message)
950 struct GNUNET_SERVER_Handle *server = cls;
951 struct GNUNET_SERVER_Client *sender = client;
956 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
957 "Tokenizer gives server message of type %u from client\n",
958 ntohs (message->type));
960 sender->in_process_client_buffer = GNUNET_YES;
961 ret = GNUNET_SERVER_inject (server, sender, message);
962 sender->in_process_client_buffer = GNUNET_NO;
963 if (GNUNET_OK != ret)
964 GNUNET_SERVER_client_disconnect (sender);
969 * Add a TCP socket-based connection to the set of handles managed by
970 * this server. Use this function for outgoing (P2P) connections that
971 * we initiated (and where this server should process incoming
974 * @param server the server to use
975 * @param connection the connection to manage (client must
976 * stop using this connection from now on)
977 * @return the client handle (client should call
978 * "client_drop" on the return value eventually)
980 struct GNUNET_SERVER_Client *
981 GNUNET_SERVER_connect_socket (struct
984 struct GNUNET_CONNECTION_Handle *connection)
986 struct GNUNET_SERVER_Client *client;
988 client = GNUNET_malloc (sizeof (struct GNUNET_SERVER_Client));
989 client->connection = connection;
990 client->mst = GNUNET_SERVER_mst_create (&client_message_tokenizer_callback,
992 client->reference_count = 1;
993 client->server = server;
994 client->last_activity = GNUNET_TIME_absolute_get ();
995 client->next = server->clients;
996 client->idle_timeout = server->idle_timeout;
997 server->clients = client;
998 client->receive_pending = GNUNET_YES;
999 client->callback = NULL;
1000 client->callback_cls = NULL;
1001 GNUNET_CONNECTION_receive (client->connection,
1002 GNUNET_SERVER_MAX_MESSAGE_SIZE - 1,
1003 client->idle_timeout, &process_incoming, client);
1009 * Change the timeout for a particular client. Decreasing the timeout
1010 * may not go into effect immediately (only after the previous timeout
1011 * times out or activity happens on the socket).
1013 * @param client the client to update
1014 * @param timeout new timeout for activities on the socket
1017 GNUNET_SERVER_client_set_timeout (struct GNUNET_SERVER_Client *client,
1018 struct GNUNET_TIME_Relative timeout)
1020 client->idle_timeout = timeout;
1025 * Notify the server that the given client handle should
1026 * be kept (keeps the connection up if possible, increments
1027 * the internal reference counter).
1029 * @param client the client to keep
1032 GNUNET_SERVER_client_keep (struct GNUNET_SERVER_Client *client)
1034 client->reference_count++;
1039 * Notify the server that the given client handle is no
1040 * longer required. Decrements the reference counter. If
1041 * that counter reaches zero an inactive connection maybe
1044 * @param client the client to drop
1047 GNUNET_SERVER_client_drop (struct GNUNET_SERVER_Client *client)
1049 GNUNET_assert (client->reference_count > 0);
1050 client->reference_count--;
1051 if ( (client->shutdown_now == GNUNET_YES) &&
1052 (client->reference_count == 0) )
1053 GNUNET_SERVER_client_disconnect (client);
1058 * Obtain the network address of the other party.
1060 * @param client the client to get the address for
1061 * @param addr where to store the address
1062 * @param addrlen where to store the length of the address
1063 * @return GNUNET_OK on success
1066 GNUNET_SERVER_client_get_address (struct GNUNET_SERVER_Client *client,
1067 void **addr, size_t * addrlen)
1069 return GNUNET_CONNECTION_get_address (client->connection,
1075 * Ask the server to notify us whenever a client disconnects.
1076 * This function is called whenever the actual network connection
1077 * is closed; the reference count may be zero or larger than zero
1080 * @param server the server manageing the clients
1081 * @param callback function to call on disconnect
1082 * @param callback_cls closure for callback
1085 GNUNET_SERVER_disconnect_notify (struct GNUNET_SERVER_Handle *server,
1086 GNUNET_SERVER_DisconnectCallback callback,
1089 struct NotifyList *n;
1091 n = GNUNET_malloc (sizeof (struct NotifyList));
1092 n->callback = callback;
1093 n->callback_cls = callback_cls;
1094 n->next = server->disconnect_notify_list;
1095 server->disconnect_notify_list = n;
1100 * Ask the server to stop notifying us whenever a client disconnects.
1102 * @param server the server manageing the clients
1103 * @param callback function to call on disconnect
1104 * @param callback_cls closure for callback
1107 GNUNET_SERVER_disconnect_notify_cancel (struct GNUNET_SERVER_Handle *server,
1108 GNUNET_SERVER_DisconnectCallback callback,
1111 struct NotifyList *pos;
1112 struct NotifyList *prev;
1115 pos = server->disconnect_notify_list;
1118 if ( (pos->callback == callback) &&
1119 (pos->callback_cls == callback_cls ) )
1130 server->disconnect_notify_list = pos->next;
1132 prev->next = pos->next;
1138 * Ask the server to disconnect from the given client.
1139 * This is the same as returning GNUNET_SYSERR from a message
1140 * handler, except that it allows dropping of a client even
1141 * when not handling a message from that client.
1143 * @param client the client to disconnect from
1146 GNUNET_SERVER_client_disconnect (struct GNUNET_SERVER_Client *client)
1148 struct GNUNET_SERVER_Client *prev;
1149 struct GNUNET_SERVER_Client *pos;
1150 struct GNUNET_SERVER_Handle *server;
1151 struct NotifyList *n;
1155 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1156 "Client is being disconnected from the server.\n");
1158 if (client->restart_task != GNUNET_SCHEDULER_NO_TASK)
1160 GNUNET_SCHEDULER_cancel (client->restart_task);
1161 client->restart_task = GNUNET_SCHEDULER_NO_TASK;
1163 if (client->warn_task != GNUNET_SCHEDULER_NO_TASK)
1165 GNUNET_SCHEDULER_cancel (client->warn_task);
1166 client->warn_task = GNUNET_SCHEDULER_NO_TASK;
1168 if (GNUNET_YES == client->receive_pending)
1170 GNUNET_CONNECTION_receive_cancel (client->connection);
1171 client->receive_pending = GNUNET_NO;
1174 rc = client->reference_count;
1175 if (client->server != NULL)
1177 server = client->server;
1178 client->server = NULL;
1179 client->shutdown_now = GNUNET_YES;
1181 pos = server->clients;
1182 while ((pos != NULL) && (pos != client))
1187 GNUNET_assert (pos != NULL);
1189 server->clients = pos->next;
1191 prev->next = pos->next;
1192 if (client->restart_task != GNUNET_SCHEDULER_NO_TASK)
1194 GNUNET_SCHEDULER_cancel (client->restart_task);
1195 client->restart_task = GNUNET_SCHEDULER_NO_TASK;
1197 if (client->warn_task != GNUNET_SCHEDULER_NO_TASK)
1199 GNUNET_SCHEDULER_cancel (client->warn_task);
1200 client->warn_task = GNUNET_SCHEDULER_NO_TASK;
1202 n = server->disconnect_notify_list;
1205 n->callback (n->callback_cls, client);
1212 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1213 "RC still positive, not destroying everything.\n");
1217 if (client->in_process_client_buffer == GNUNET_YES)
1220 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1221 "Still processing inputs, not destroying everything.\n");
1226 if (client->persist == GNUNET_YES)
1227 GNUNET_CONNECTION_persist_ (client->connection);
1228 GNUNET_CONNECTION_destroy (client->connection, GNUNET_NO);
1229 GNUNET_SERVER_mst_destroy (client->mst);
1230 GNUNET_free (client);
1235 * Disable the "CORK" feature for communication with the given client,
1236 * forcing the OS to immediately flush the buffer on transmission
1237 * instead of potentially buffering multiple messages.
1239 * @param client handle to the client
1240 * @return GNUNET_OK on success
1243 GNUNET_SERVER_client_disable_corking (struct GNUNET_SERVER_Client *client)
1245 return GNUNET_CONNECTION_disable_corking (client->connection);
1250 * Wrapper for transmission notification that calls the original
1251 * callback and update the last activity time for our connection.
1253 * @param cls the 'struct GNUNET_SERVER_Client'
1254 * @param size number of bytes we can transmit
1255 * @param buf where to copy the message
1256 * @return number of bytes actually transmitted
1259 transmit_ready_callback_wrapper (void *cls, size_t size, void *buf)
1261 struct GNUNET_SERVER_Client *client = cls;
1264 ret = client->callback (client->callback_cls, size, buf);
1266 client->last_activity = GNUNET_TIME_absolute_get();
1272 * Notify us when the server has enough space to transmit
1273 * a message of the given size to the given client.
1275 * @param client client to transmit message to
1276 * @param size requested amount of buffer space
1277 * @param timeout after how long should we give up (and call
1278 * notify with buf NULL and size 0)?
1279 * @param callback function to call when space is available
1280 * @param callback_cls closure for callback
1281 * @return non-NULL if the notify callback was queued; can be used
1282 * to cancel the request using
1283 * GNUNET_CONNECTION_notify_transmit_ready_cancel.
1284 * NULL if we are already going to notify someone else (busy)
1286 struct GNUNET_CONNECTION_TransmitHandle *
1287 GNUNET_SERVER_notify_transmit_ready (struct GNUNET_SERVER_Client *client,
1289 struct GNUNET_TIME_Relative timeout,
1290 GNUNET_CONNECTION_TransmitReadyNotify
1291 callback, void *callback_cls)
1293 client->callback_cls = callback_cls;
1294 client->callback = callback;
1295 return GNUNET_CONNECTION_notify_transmit_ready (client->connection,
1298 &transmit_ready_callback_wrapper, client);
1303 * Set the persistent flag on this client, used to setup client connection
1304 * to only be killed when the service it's connected to is actually dead.
1306 * @param client the client to set the persistent flag on
1309 GNUNET_SERVER_client_persist_ (struct GNUNET_SERVER_Client *client)
1311 client->persist = GNUNET_YES;
1316 * Resume receiving from this client, we are done processing the
1317 * current request. This function must be called from within each
1318 * GNUNET_SERVER_MessageCallback (or its respective continuations).
1320 * @param client client we were processing a message of
1321 * @param success GNUNET_OK to keep the connection open and
1322 * continue to receive
1323 * GNUNET_NO to close the connection (normal behavior)
1324 * GNUNET_SYSERR to close the connection (signal
1328 GNUNET_SERVER_receive_done (struct GNUNET_SERVER_Client *client, int success)
1332 GNUNET_assert (client->suspended > 0);
1333 client->suspended--;
1334 if (success != GNUNET_OK)
1337 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1338 "GNUNET_SERVER_receive_done called with failure indication\n");
1340 GNUNET_SERVER_client_disconnect (client);
1343 if (client->suspended > 0)
1346 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1347 "GNUNET_SERVER_receive_done called, but more clients pending\n");
1351 if (GNUNET_SCHEDULER_NO_TASK != client->warn_task)
1353 GNUNET_SCHEDULER_cancel (client->warn_task);
1354 client->warn_task = GNUNET_SCHEDULER_NO_TASK;
1356 if (client->in_process_client_buffer == GNUNET_YES)
1359 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1360 "GNUNET_SERVER_receive_done called while still in processing loop\n");
1364 if (client->server == NULL)
1366 GNUNET_SERVER_client_disconnect (client);
1370 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
1371 "GNUNET_SERVER_receive_done causes restart in reading from the socket\n");
1373 GNUNET_assert (GNUNET_SCHEDULER_NO_TASK == client->restart_task);
1374 client->restart_task = GNUNET_SCHEDULER_add_now (&restart_processing,
1380 * Configure this server's connections to continue handling client
1381 * requests as usual even after we get a shutdown signal. The change
1382 * only applies to clients that connect to the server from the outside
1383 * using TCP after this call. Clients managed previously or those
1384 * added using GNUNET_SERVER_connect_socket and
1385 * GNUNET_SERVER_connect_callback are not affected by this option.
1387 * @param h server handle
1388 * @param do_ignore GNUNET_YES to ignore, GNUNET_NO to restore default
1391 GNUNET_SERVER_ignore_shutdown (struct GNUNET_SERVER_Handle *h, int do_ignore)
1393 h->clients_ignore_shutdown = do_ignore;
1396 /* end of server.c */