GNUnet  0.10.x
Data Structures | Macros | Functions
tcp_server_legacy.c File Reference
#include "platform.h"
#include "gnunet_util_lib.h"
#include "gnunet_protocols.h"
Include dependency graph for tcp_server_legacy.c:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  HandlerList
 List of arrays of message handlers. More...
 
struct  NotifyList
 List of arrays of message handlers. More...
 
struct  GNUNET_SERVER_Handle
 handle for a server More...
 
struct  GNUNET_SERVER_TransmitHandle
 Handle server returns for aborting transmission to a client. More...
 
struct  GNUNET_SERVER_Client
 handle for a client of the server More...
 

Macros

#define LOG_STRERROR_FILE(kind, syscall, filename)   GNUNET_log_from_strerror_file(kind, "util-server", syscall, filename)
 

Functions

void * GNUNET_SERVER_client_get_user_context_ (struct GNUNET_SERVER_Client *client, size_t size)
 Return user context associated with the given client. More...
 
void GNUNET_SERVER_client_set_user_context_ (struct GNUNET_SERVER_Client *client, void *ptr, size_t size)
 Set user context to be associated with the given client. More...
 
static void process_listen_socket (void *cls)
 Scheduler says our listen socket is ready. More...
 
static struct GNUNET_NETWORK_Handleopen_listen_socket (const struct sockaddr *server_addr, socklen_t socklen)
 Create and initialize a listen socket for the server. More...
 
struct GNUNET_SERVER_HandleGNUNET_SERVER_create_with_sockets (GNUNET_CONNECTION_AccessCheck access_cb, void *access_cb_cls, struct GNUNET_NETWORK_Handle **lsocks, struct GNUNET_TIME_Relative idle_timeout, int require_found)
 Create a new server. More...
 
struct GNUNET_SERVER_HandleGNUNET_SERVER_create (GNUNET_CONNECTION_AccessCheck access_cb, void *access_cb_cls, struct sockaddr *const *server_addr, const socklen_t *socklen, struct GNUNET_TIME_Relative idle_timeout, int require_found)
 Create a new server. More...
 
void GNUNET_SERVER_client_mark_monitor (struct GNUNET_SERVER_Client *client)
 Set the 'monitor' flag on this client. More...
 
static void do_destroy (void *cls)
 Helper function for test_monitor_clients() to trigger GNUNET_SERVER_destroy() after the stack has unwound. More...
 
static void test_monitor_clients (struct GNUNET_SERVER_Handle *server)
 Check if only 'monitor' clients are left. More...
 
void GNUNET_SERVER_suspend (struct GNUNET_SERVER_Handle *server)
 Suspend accepting connections from the listen socket temporarily. More...
 
void GNUNET_SERVER_resume (struct GNUNET_SERVER_Handle *server)
 Resume accepting connections from the listen socket. More...
 
void GNUNET_SERVER_stop_listening (struct GNUNET_SERVER_Handle *server)
 Stop the listen socket and get ready to shutdown the server once only 'monitor' clients are left. More...
 
void GNUNET_SERVER_destroy (struct GNUNET_SERVER_Handle *server)
 Free resources held by this server. More...
 
void GNUNET_SERVER_add_handlers (struct GNUNET_SERVER_Handle *server, const struct GNUNET_SERVER_MessageHandler *handlers)
 Add additional handlers to an existing server. More...
 
void GNUNET_SERVER_set_callbacks (struct GNUNET_SERVER_Handle *server, GNUNET_SERVER_MstCreateCallback create, GNUNET_SERVER_MstDestroyCallback destroy, GNUNET_SERVER_MstReceiveCallback receive, void *cls)
 Change functions used by the server to tokenize the message stream. More...
 
static void warn_no_receive_done (void *cls)
 Task run to warn about missing calls to GNUNET_SERVER_receive_done. More...
 
void GNUNET_SERVER_disable_receive_done_warning (struct GNUNET_SERVER_Client *client)
 Disable the warning the server issues if a message is not acknowledged in a timely fashion. More...
 
int GNUNET_SERVER_inject (struct GNUNET_SERVER_Handle *server, struct GNUNET_SERVER_Client *sender, const struct GNUNET_MessageHeader *message)
 Inject a message into the server, pretend it came from the specified client. More...
 
static void process_incoming (void *cls, const void *buf, size_t available, const struct sockaddr *addr, socklen_t addrlen, int errCode)
 We are receiving an incoming message. More...
 
static void process_mst (struct GNUNET_SERVER_Client *client, int ret)
 Process messages from the client's message tokenizer until either the tokenizer is empty (and then schedule receiving more), or until some handler is not immediately done (then wait for restart_processing) or shutdown. More...
 
static void restart_processing (void *cls)
 Task run to start again receiving from the network and process requests. More...
 
static int client_message_tokenizer_callback (void *cls, void *client, const struct GNUNET_MessageHeader *message)
 This function is called whenever our inbound message tokenizer has received a complete message. More...
 
struct GNUNET_SERVER_ClientGNUNET_SERVER_connect_socket (struct GNUNET_SERVER_Handle *server, struct GNUNET_CONNECTION_Handle *connection)
 Add a TCP socket-based connection to the set of handles managed by this server. More...
 
void GNUNET_SERVER_client_set_timeout (struct GNUNET_SERVER_Client *client, struct GNUNET_TIME_Relative timeout)
 Change the timeout for a particular client. More...
 
void GNUNET_SERVER_client_keep (struct GNUNET_SERVER_Client *client)
 Notify the server that the given client handle should be kept (keeps the connection up if possible, increments the internal reference counter). More...
 
void GNUNET_SERVER_client_drop (struct GNUNET_SERVER_Client *client)
 Notify the server that the given client handle is no longer required. More...
 
int GNUNET_SERVER_client_get_address (struct GNUNET_SERVER_Client *client, void **addr, size_t *addrlen)
 Obtain the network address of the other party. More...
 
void GNUNET_SERVER_disconnect_notify (struct GNUNET_SERVER_Handle *server, GNUNET_SERVER_DisconnectCallback callback, void *callback_cls)
 Ask the server to notify us whenever a client disconnects. More...
 
void GNUNET_SERVER_connect_notify (struct GNUNET_SERVER_Handle *server, GNUNET_SERVER_ConnectCallback callback, void *callback_cls)
 Ask the server to notify us whenever a client connects. More...
 
void GNUNET_SERVER_disconnect_notify_cancel (struct GNUNET_SERVER_Handle *server, GNUNET_SERVER_DisconnectCallback callback, void *callback_cls)
 Ask the server to stop notifying us whenever a client connects. More...
 
void GNUNET_SERVER_connect_notify_cancel (struct GNUNET_SERVER_Handle *server, GNUNET_SERVER_ConnectCallback callback, void *callback_cls)
 Ask the server to stop notifying us whenever a client disconnects. More...
 
void GNUNET_SERVER_client_disconnect (struct GNUNET_SERVER_Client *client)
 Ask the server to disconnect from the given client. More...
 
int GNUNET_SERVER_client_disable_corking (struct GNUNET_SERVER_Client *client)
 Disable the "CORK" feature for communication with the given client, forcing the OS to immediately flush the buffer on transmission instead of potentially buffering multiple messages. More...
 
static size_t transmit_ready_callback_wrapper (void *cls, size_t size, void *buf)
 Wrapper for transmission notification that calls the original callback and update the last activity time for our connection. More...
 
struct GNUNET_SERVER_TransmitHandleGNUNET_SERVER_notify_transmit_ready (struct GNUNET_SERVER_Client *client, size_t size, struct GNUNET_TIME_Relative timeout, GNUNET_CONNECTION_TransmitReadyNotify callback, void *callback_cls)
 Notify us when the server has enough space to transmit a message of the given size to the given client. More...
 
void GNUNET_SERVER_notify_transmit_ready_cancel (struct GNUNET_SERVER_TransmitHandle *th)
 Abort transmission request. More...
 
void GNUNET_SERVER_client_persist_ (struct GNUNET_SERVER_Client *client)
 Set the persistent flag on this client, used to setup client connection to only be killed when the service it's connected to is actually dead. More...
 
void GNUNET_SERVER_receive_done (struct GNUNET_SERVER_Client *client, int success)
 Resume receiving from this client, we are done processing the current request. More...
 

Macro Definition Documentation

◆ LOG_STRERROR_FILE

#define LOG_STRERROR_FILE (   kind,
  syscall,
  filename 
)    GNUNET_log_from_strerror_file(kind, "util-server", syscall, filename)

Definition at line 31 of file tcp_server_legacy.c.

Function Documentation

◆ GNUNET_SERVER_client_get_user_context_()

void* GNUNET_SERVER_client_get_user_context_ ( struct GNUNET_SERVER_Client client,
size_t  size 
)

Return user context associated with the given client.

Note: you should probably use the macro (call without the underscore).

Parameters
clientclient to query
sizenumber of bytes in user context struct (for verification only)
Returns
pointer to user context

Definition at line 341 of file tcp_server_legacy.c.

References GNUNET_assert, GNUNET_SERVER_Client::user_context, and GNUNET_SERVER_Client::user_context_size.

343 {
344  if ((0 == client->user_context_size) &&
345  (NULL == client->user_context))
346  return NULL; /* never set */
348  return client->user_context;
349 }
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
void * user_context
User context value, manipulated using 'GNUNET_SERVER_client_{get/set}_user_context' functions...
size_t user_context_size
Last size given when user context was initialized; used for sanity check.
static unsigned int size
Size of the "table".
Definition: peer.c:66

◆ GNUNET_SERVER_client_set_user_context_()

void GNUNET_SERVER_client_set_user_context_ ( struct GNUNET_SERVER_Client client,
void *  ptr,
size_t  size 
)

Set user context to be associated with the given client.

Note: you should probably use the macro (call without the underscore).

Parameters
clientclient to query
ptrpointer to user context
sizenumber of bytes in user context struct (for verification only)

Definition at line 361 of file tcp_server_legacy.c.

References size, GNUNET_SERVER_Client::user_context, and GNUNET_SERVER_Client::user_context_size.

364 {
365  if (NULL == ptr)
366  {
367  client->user_context_size = 0;
368  client->user_context = ptr;
369  return;
370  }
371  client->user_context_size = size;
372  client->user_context = ptr;
373 }
void * user_context
User context value, manipulated using 'GNUNET_SERVER_client_{get/set}_user_context' functions...
size_t user_context_size
Last size given when user context was initialized; used for sanity check.
static unsigned int size
Size of the "table".
Definition: peer.c:66

◆ process_listen_socket()

static void process_listen_socket ( void *  cls)
static

Scheduler says our listen socket is ready.

Process it!

Parameters
clshandle to our server for which we are processing the listen socket

Definition at line 383 of file tcp_server_legacy.c.

References GNUNET_SERVER_Handle::access_cb, GNUNET_SERVER_Handle::access_cb_cls, GNUNET_CONNECTION_create_from_accept(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_NETWORK_fdset_isset(), GNUNET_SCHEDULER_get_task_context(), GNUNET_SERVER_connect_socket(), GNUNET_SERVER_resume(), GNUNET_SERVER_Handle::listen_sockets, GNUNET_SERVER_Handle::listen_task, LOG, GNUNET_SCHEDULER_TaskContext::read_ready, GNUNET_CONNECTION_Handle::sock, and tc.

Referenced by GNUNET_SERVER_resume().

384 {
385  struct GNUNET_SERVER_Handle *server = cls;
386  const struct GNUNET_SCHEDULER_TaskContext *tc;
388  unsigned int i;
389 
390  server->listen_task = NULL;
392  for (i = 0; NULL != server->listen_sockets[i]; i++)
393  {
395  server->listen_sockets[i]))
396  {
397  sock =
399  server->access_cb_cls,
400  server->listen_sockets[i]);
401  if (NULL != sock)
402  {
404  "Server accepted incoming connection.\n");
405  (void)GNUNET_SERVER_connect_socket(server,
406  sock);
407  }
408  }
409  }
410  /* listen for more! */
411  GNUNET_SERVER_resume(server);
412 }
const struct GNUNET_SCHEDULER_TaskContext * GNUNET_SCHEDULER_get_task_context(void)
Obtain the reasoning why the current task was started.
Definition: scheduler.c:737
struct GNUNET_NETWORK_Handle * sock
Underlying OS's socket, set to NULL after fatal errors.
void * access_cb_cls
Closure for access_cb.
Context information passed to each scheduler task.
struct GNUNET_NETWORK_Handle ** listen_sockets
NULL-terminated array of sockets used to listen for new connections.
#define LOG(kind,...)
Definition: arm_api.c:33
static struct GNUNET_SCHEDULER_TaskContext tc
Task context of the current task.
Definition: scheduler.c:410
const struct GNUNET_NETWORK_FDSet * read_ready
Set of file descriptors ready for reading; note that additional bits may be set that were not in the ...
struct GNUNET_CONNECTION_Handle * GNUNET_CONNECTION_create_from_accept(GNUNET_CONNECTION_AccessCheck access_cb, void *access_cb_cls, struct GNUNET_NETWORK_Handle *lsock)
Create a connection handle by accepting on a listen socket.
handle for a server
void GNUNET_SERVER_resume(struct GNUNET_SERVER_Handle *server)
Resume accepting connections from the listen socket.
GNUNET_CONNECTION_AccessCheck access_cb
Function to call for access control.
struct GNUNET_SCHEDULER_Task * listen_task
Task scheduled to do the listening.
struct GNUNET_SERVER_Client * GNUNET_SERVER_connect_socket(struct GNUNET_SERVER_Handle *server, struct GNUNET_CONNECTION_Handle *connection)
Add a TCP socket-based connection to the set of handles managed by this server.
int GNUNET_NETWORK_fdset_isset(const struct GNUNET_NETWORK_FDSet *fds, const struct GNUNET_NETWORK_Handle *desc)
Check whether a socket is part of the fd set.
Definition: network.c:1017
handle for a network connection
Here is the call graph for this function:
Here is the caller graph for this function:

◆ open_listen_socket()

static struct GNUNET_NETWORK_Handle* open_listen_socket ( const struct sockaddr *  server_addr,
socklen_t  socklen 
)
static

Create and initialize a listen socket for the server.

Parameters
server_addraddress to listen on
socklenlength of server_addr
Returns
NULL on error, otherwise the listen socket

Definition at line 423 of file tcp_server_legacy.c.

References _, GNUNET_a2s(), GNUNET_break, GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_ERROR, GNUNET_ERROR_TYPE_WARNING, GNUNET_NETWORK_socket_bind(), GNUNET_NETWORK_socket_close(), GNUNET_NETWORK_socket_create(), GNUNET_NETWORK_socket_listen(), GNUNET_OK, LOG, LOG_STRERROR, and port.

Referenced by GNUNET_SERVER_create().

425 {
426  struct GNUNET_NETWORK_Handle *sock;
427  uint16_t port;
428  int eno;
429 
430  switch (server_addr->sa_family)
431  {
432  case AF_INET:
433  port = ntohs(((const struct sockaddr_in *)server_addr)->sin_port);
434  break;
435 
436  case AF_INET6:
437  port = ntohs(((const struct sockaddr_in6 *)server_addr)->sin6_port);
438  break;
439 
440  case AF_UNIX:
441  port = 0;
442  break;
443 
444  default:
445  GNUNET_break(0);
446  port = 0;
447  break;
448  }
449  sock = GNUNET_NETWORK_socket_create(server_addr->sa_family, SOCK_STREAM, 0);
450  if (NULL == sock)
451  {
453  errno = 0;
454  return NULL;
455  }
456  /* bind the socket */
457  if (GNUNET_OK != GNUNET_NETWORK_socket_bind(sock, server_addr, socklen))
458  {
459  eno = errno;
460  if (EADDRINUSE != errno)
461  {
462  /* we don't log 'EADDRINUSE' here since an IPv4 bind may
463  * fail if we already took the port on IPv6; if both IPv4 and
464  * IPv6 binds fail, then our caller will log using the
465  * errno preserved in 'eno' */
467  "bind");
468  if (0 != port)
470  _("`%s' failed for port %d (%s).\n"),
471  "bind",
472  port,
473  (AF_INET == server_addr->sa_family) ? "IPv4" : "IPv6");
474  eno = 0;
475  }
476  else
477  {
478  if (0 != port)
480  _("`%s' failed for port %d (%s): address already in use\n"),
481  "bind", port,
482  (AF_INET == server_addr->sa_family) ? "IPv4" : "IPv6");
483  else if (AF_UNIX == server_addr->sa_family)
484  {
486  _("`%s' failed for `%s': address already in use\n"),
487  "bind",
488  GNUNET_a2s(server_addr, socklen));
489  }
490  }
492  errno = eno;
493  return NULL;
494  }
495  if (GNUNET_OK != GNUNET_NETWORK_socket_listen(sock, 5))
496  {
498  "listen");
500  errno = 0;
501  return NULL;
502  }
503  if (0 != port)
505  "Server starts to listen on port %u.\n",
506  port);
507  return sock;
508 }
int GNUNET_NETWORK_socket_listen(const struct GNUNET_NETWORK_Handle *desc, int backlog)
Listen on a socket.
Definition: network.c:696
#define LOG(kind,...)
Definition: arm_api.c:33
int GNUNET_NETWORK_socket_bind(struct GNUNET_NETWORK_Handle *desc, const struct sockaddr *address, socklen_t address_len)
Bind a socket to a particular address.
Definition: network.c:474
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:75
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
#define _(String)
GNU gettext support macro.
Definition: platform.h:181
const char * GNUNET_a2s(const struct sockaddr *addr, socklen_t addrlen)
Convert a "struct sockaddr*" (IPv4 or IPv6 address) to a string (for printing debug messages)...
static uint16_t port
Port number.
Definition: gnunet-bcd.c:81
#define LOG_STRERROR(kind, syscall)
handle to a socket
Definition: network.c:46
int GNUNET_NETWORK_socket_close(struct GNUNET_NETWORK_Handle *desc)
Close a socket.
Definition: network.c:548
struct GNUNET_NETWORK_Handle * GNUNET_NETWORK_socket_create(int domain, int type, int protocol)
Create a new socket.
Definition: network.c:900
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_SERVER_create_with_sockets()

struct GNUNET_SERVER_Handle* GNUNET_SERVER_create_with_sockets ( GNUNET_CONNECTION_AccessCheck  access_cb,
void *  access_cb_cls,
struct GNUNET_NETWORK_Handle **  lsocks,
struct GNUNET_TIME_Relative  idle_timeout,
int  require_found 
)

Create a new server.

Parameters
access_cbfunction for access control
access_cb_clsclosure for access_cb
lsocksNULL-terminated array of listen sockets
idle_timeoutafter how long should we timeout idle connections?
require_foundif GNUNET_YES, connections sending messages of unknown type will be closed
Returns
handle for the new server, NULL on error (typically, "port" already in use)

Definition at line 524 of file tcp_server_legacy.c.

References GNUNET_SERVER_Handle::access_cb, GNUNET_SERVER_Handle::access_cb_cls, GNUNET_new, GNUNET_SERVER_resume(), GNUNET_SERVER_Handle::idle_timeout, GNUNET_SERVER_Handle::listen_sockets, and GNUNET_SERVER_Handle::require_found.

Referenced by GNUNET_SERVER_create(), LEGACY_SERVICE_start(), libgnunet_plugin_transport_tcp_init(), and service_task().

529 {
530  struct GNUNET_SERVER_Handle *server;
531 
532  server = GNUNET_new(struct GNUNET_SERVER_Handle);
533  server->idle_timeout = idle_timeout;
534  server->listen_sockets = lsocks;
535  server->access_cb = access_cb;
536  server->access_cb_cls = access_cb_cls;
537  server->require_found = require_found;
538  if (NULL != lsocks)
539  GNUNET_SERVER_resume(server);
540  return server;
541 }
void * access_cb_cls
Closure for access_cb.
struct GNUNET_NETWORK_Handle ** listen_sockets
NULL-terminated array of sockets used to listen for new connections.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
struct GNUNET_TIME_Relative idle_timeout
After how long should an idle connection time out (on write).
handle for a server
void GNUNET_SERVER_resume(struct GNUNET_SERVER_Handle *server)
Resume accepting connections from the listen socket.
int require_found
Do we ignore messages of types that we do not understand or do we require that a handler is found (an...
GNUNET_CONNECTION_AccessCheck access_cb
Function to call for access control.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_SERVER_create()

struct GNUNET_SERVER_Handle* GNUNET_SERVER_create ( GNUNET_CONNECTION_AccessCheck  access_cb,
void *  access_cb_cls,
struct sockaddr *const *  server_addr,
const socklen_t *  socklen,
struct GNUNET_TIME_Relative  idle_timeout,
int  require_found 
)

Create a new server.

Parameters
access_cbfunction for access control
access_cb_clsclosure for access_cb
server_addraddress to listen on (including port), NULL terminated array
socklenlength of server_addr
idle_timeoutafter how long should we timeout idle connections?
require_foundif YES, connections sending messages of unknown type will be closed
Returns
handle for the new server, NULL on error (typically, "port" already in use)

Definition at line 558 of file tcp_server_legacy.c.

References GNUNET_ERROR_TYPE_ERROR, GNUNET_free, GNUNET_malloc, GNUNET_SERVER_create_with_sockets(), LOG_STRERROR, and open_listen_socket().

Referenced by LEGACY_SERVICE_start(), and service_task().

564 {
565  struct GNUNET_NETWORK_Handle **lsocks;
566  unsigned int i;
567  unsigned int j;
568  unsigned int k;
569  int seen;
570 
571  i = 0;
572  while (NULL != server_addr[i])
573  i++;
574  if (i > 0)
575  {
576  lsocks = GNUNET_malloc(sizeof(struct GNUNET_NETWORK_Handle *) * (i + 1));
577  i = 0;
578  j = 0;
579  while (NULL != server_addr[i])
580  {
581  seen = 0;
582  for (k = 0; k < i; k++)
583  if ((socklen[k] == socklen[i]) &&
584  (0 == memcmp(server_addr[k], server_addr[i], socklen[i])))
585  {
586  seen = 1;
587  break;
588  }
589  if (0 != seen)
590  {
591  /* duplicate address, skip */
592  i++;
593  continue;
594  }
595  lsocks[j] = open_listen_socket(server_addr[i], socklen[i]);
596  if (NULL != lsocks[j])
597  j++;
598  i++;
599  }
600  if (0 == j)
601  {
602  if (0 != errno)
604  GNUNET_free(lsocks);
605  lsocks = NULL;
606  }
607  }
608  else
609  {
610  lsocks = NULL;
611  }
612  return GNUNET_SERVER_create_with_sockets(access_cb,
613  access_cb_cls,
614  lsocks,
615  idle_timeout,
616  require_found);
617 }
static struct GNUNET_NETWORK_Handle * open_listen_socket(const struct sockaddr *server_addr, socklen_t socklen)
Create and initialize a listen socket for the server.
struct GNUNET_SERVER_Handle * GNUNET_SERVER_create_with_sockets(GNUNET_CONNECTION_AccessCheck access_cb, void *access_cb_cls, struct GNUNET_NETWORK_Handle **lsocks, struct GNUNET_TIME_Relative idle_timeout, int require_found)
Create a new server.
#define LOG_STRERROR(kind, syscall)
handle to a socket
Definition: network.c:46
#define GNUNET_malloc(size)
Wrapper around malloc.
#define GNUNET_free(ptr)
Wrapper around free.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_SERVER_client_mark_monitor()

void GNUNET_SERVER_client_mark_monitor ( struct GNUNET_SERVER_Client client)

Set the 'monitor' flag on this client.

Clients which have been marked as 'monitors' won't prevent the server from shutting down once 'GNUNET_SERVER_stop_listening()' has been invoked. The idea is that for "normal" clients we likely want to allow them to process their requests; however, monitor-clients are likely to 'never' disconnect during shutdown and thus will not be considered when determining if the server should continue to exist after GNUNET_SERVER_destroy() has been called.

Parameters
clientthe client to set the 'monitor' flag on

Definition at line 633 of file tcp_server_legacy.c.

References GNUNET_ERROR_TYPE_DEBUG, GNUNET_log, GNUNET_YES, and GNUNET_SERVER_Client::is_monitor.

634 {
636  "Marking client as monitor!\n");
637  client->is_monitor = GNUNET_YES;
638 }
int is_monitor
Is this client a &#39;monitor&#39; client that should not be counted when deciding on destroying the server d...
#define GNUNET_log(kind,...)
#define GNUNET_YES
Definition: gnunet_common.h:77

◆ do_destroy()

static void do_destroy ( void *  cls)
static

Helper function for test_monitor_clients() to trigger GNUNET_SERVER_destroy() after the stack has unwound.

Parameters
clsthe struct GNUNET_SERVER_Handle * to destroy

Definition at line 648 of file tcp_server_legacy.c.

References GNUNET_SERVER_destroy().

Referenced by test_monitor_clients().

649 {
650  struct GNUNET_SERVER_Handle *server = cls;
651 
652  GNUNET_SERVER_destroy(server);
653 }
void GNUNET_SERVER_destroy(struct GNUNET_SERVER_Handle *server)
Free resources held by this server.
handle for a server
Here is the call graph for this function:
Here is the caller graph for this function:

◆ test_monitor_clients()

static void test_monitor_clients ( struct GNUNET_SERVER_Handle server)
static

Check if only 'monitor' clients are left.

If so, destroy the server completely.

Parameters
serverserver to test for full shutdown

Definition at line 663 of file tcp_server_legacy.c.

References GNUNET_SERVER_Handle::clients_head, do_destroy(), GNUNET_NO, GNUNET_SCHEDULER_add_now(), GNUNET_SYSERR, GNUNET_YES, GNUNET_SERVER_Handle::in_soft_shutdown, GNUNET_SERVER_Client::is_monitor, and GNUNET_SERVER_Client::next.

Referenced by GNUNET_SERVER_client_disconnect(), and GNUNET_SERVER_stop_listening().

664 {
665  struct GNUNET_SERVER_Client *client;
666 
667  if (GNUNET_YES != server->in_soft_shutdown)
668  return;
669  for (client = server->clients_head; NULL != client; client = client->next)
670  if (GNUNET_NO == client->is_monitor)
671  return;
672  /* not done yet */
674  (void)GNUNET_SCHEDULER_add_now(&do_destroy, server);
675 }
#define GNUNET_NO
Definition: gnunet_common.h:78
struct GNUNET_SERVER_Client * next
This is a doubly linked list.
int is_monitor
Is this client a &#39;monitor&#39; client that should not be counted when deciding on destroying the server d...
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_now(GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run as soon as possible.
Definition: scheduler.c:1264
#define GNUNET_SYSERR
Definition: gnunet_common.h:76
static void do_destroy(void *cls)
Helper function for test_monitor_clients() to trigger GNUNET_SERVER_destroy() after the stack has unw...
int in_soft_shutdown
Set to GNUNET_YES once we are in &#39;soft&#39; shutdown where we wait for all non-monitor clients to disconn...
#define GNUNET_YES
Definition: gnunet_common.h:77
handle for a client of the server
struct GNUNET_SERVER_Client * clients_head
Head of list of our current clients.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_SERVER_suspend()

void GNUNET_SERVER_suspend ( struct GNUNET_SERVER_Handle server)

Suspend accepting connections from the listen socket temporarily.

Parameters
serverserver to stop accepting connections.

Definition at line 684 of file tcp_server_legacy.c.

References GNUNET_SCHEDULER_cancel(), and GNUNET_SERVER_Handle::listen_task.

Referenced by connect_notify().

685 {
686  if (NULL != server->listen_task)
687  {
689  server->listen_task = NULL;
690  }
691 }
struct GNUNET_SCHEDULER_Task * listen_task
Task scheduled to do the listening.
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:956
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_SERVER_resume()

void GNUNET_SERVER_resume ( struct GNUNET_SERVER_Handle server)

Resume accepting connections from the listen socket.

Parameters
serverserver to stop accepting connections.

Definition at line 700 of file tcp_server_legacy.c.

References GNUNET_NETWORK_fdset_create(), GNUNET_NETWORK_fdset_destroy(), GNUNET_NETWORK_fdset_set(), GNUNET_SCHEDULER_add_read_net_with_priority(), GNUNET_SCHEDULER_add_select(), GNUNET_SCHEDULER_PRIORITY_HIGH, GNUNET_TIME_UNIT_FOREVER_REL, GNUNET_SERVER_Handle::listen_sockets, GNUNET_SERVER_Handle::listen_task, and process_listen_socket().

Referenced by disconnect_notify(), GNUNET_SERVER_create_with_sockets(), and process_listen_socket().

701 {
702  struct GNUNET_NETWORK_FDSet *r;
703  unsigned int i;
704 
705  if (NULL == server->listen_sockets)
706  return;
707  if (NULL == server->listen_sockets[0])
708  return; /* nothing to do, no listen sockets! */
709  if (NULL == server->listen_sockets[1])
710  {
711  /* simplified method: no fd set needed; this is then much simpler
712  and much more efficient */
713  server->listen_task =
716  server->listen_sockets[0],
717  &process_listen_socket, server);
718  return;
719  }
721  i = 0;
722  while (NULL != server->listen_sockets[i])
723  GNUNET_NETWORK_fdset_set(r, server->listen_sockets[i++]);
724  server->listen_task =
727  &process_listen_socket, server);
729 }
Run with high priority (important requests).
struct GNUNET_NETWORK_Handle ** listen_sockets
NULL-terminated array of sockets used to listen for new connections.
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_read_net_with_priority(struct GNUNET_TIME_Relative delay, enum GNUNET_SCHEDULER_Priority priority, struct GNUNET_NETWORK_Handle *rfd, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified priority and to be run after the specified delay or wh...
Definition: scheduler.c:1501
void GNUNET_NETWORK_fdset_destroy(struct GNUNET_NETWORK_FDSet *fds)
Releases the associated memory of an fd set.
Definition: network.c:1254
struct GNUNET_NETWORK_FDSet * GNUNET_NETWORK_fdset_create(void)
Creates an fd set.
Definition: network.c:1238
collection of IO descriptors
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_select(enum GNUNET_SCHEDULER_Priority prio, struct GNUNET_TIME_Relative delay, const struct GNUNET_NETWORK_FDSet *rs, const struct GNUNET_NETWORK_FDSet *ws, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay or when any of the specified file descriptor set...
Definition: scheduler.c:1784
#define GNUNET_TIME_UNIT_FOREVER_REL
Constant used to specify "forever".
static void process_listen_socket(void *cls)
Scheduler says our listen socket is ready.
void GNUNET_NETWORK_fdset_set(struct GNUNET_NETWORK_FDSet *fds, const struct GNUNET_NETWORK_Handle *desc)
Add a socket to the FD set.
Definition: network.c:999
struct GNUNET_SCHEDULER_Task * listen_task
Task scheduled to do the listening.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_SERVER_stop_listening()

void GNUNET_SERVER_stop_listening ( struct GNUNET_SERVER_Handle server)

Stop the listen socket and get ready to shutdown the server once only 'monitor' clients are left.

Parameters
serverserver to stop listening on

Definition at line 739 of file tcp_server_legacy.c.

References GNUNET_break, GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_NETWORK_socket_close(), GNUNET_NO, GNUNET_OK, GNUNET_SCHEDULER_cancel(), GNUNET_YES, GNUNET_SERVER_Handle::in_soft_shutdown, GNUNET_SERVER_Handle::listen_sockets, GNUNET_SERVER_Handle::listen_task, LOG, and test_monitor_clients().

Referenced by shutdown_task().

740 {
741  unsigned int i;
742 
744  "Server in soft shutdown\n");
745  if (NULL != server->listen_task)
746  {
748  server->listen_task = NULL;
749  }
750  if (NULL != server->listen_sockets)
751  {
752  i = 0;
753  while (NULL != server->listen_sockets[i])
756  GNUNET_free(server->listen_sockets);
757  server->listen_sockets = NULL;
758  }
759  if (GNUNET_NO == server->in_soft_shutdown)
760  server->in_soft_shutdown = GNUNET_YES;
761  test_monitor_clients(server);
762 }
struct GNUNET_NETWORK_Handle ** listen_sockets
NULL-terminated array of sockets used to listen for new connections.
#define LOG(kind,...)
Definition: arm_api.c:33
#define GNUNET_NO
Definition: gnunet_common.h:78
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:75
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
struct GNUNET_SCHEDULER_Task * listen_task
Task scheduled to do the listening.
int in_soft_shutdown
Set to GNUNET_YES once we are in &#39;soft&#39; shutdown where we wait for all non-monitor clients to disconn...
#define GNUNET_YES
Definition: gnunet_common.h:77
static void test_monitor_clients(struct GNUNET_SERVER_Handle *server)
Check if only &#39;monitor&#39; clients are left.
int GNUNET_NETWORK_socket_close(struct GNUNET_NETWORK_Handle *desc)
Close a socket.
Definition: network.c:548
#define GNUNET_free(ptr)
Wrapper around free.
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:956
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_SERVER_destroy()

void GNUNET_SERVER_destroy ( struct GNUNET_SERVER_Handle server)

Free resources held by this server.

Parameters
serverserver to destroy

Definition at line 771 of file tcp_server_legacy.c.

References NotifyList::callback, NotifyList::callback_cls, GNUNET_SERVER_Handle::clients_head, GNUNET_SERVER_Handle::connect_notify_list_head, GNUNET_SERVER_Handle::connect_notify_list_tail, GNUNET_SERVER_Handle::disconnect_notify_list_head, GNUNET_SERVER_Handle::disconnect_notify_list_tail, GNUNET_break, GNUNET_CONTAINER_DLL_remove, GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_NETWORK_socket_close(), GNUNET_OK, GNUNET_SCHEDULER_cancel(), GNUNET_SERVER_client_disconnect(), GNUNET_SERVER_Handle::handlers, GNUNET_SERVER_Handle::listen_sockets, GNUNET_SERVER_Handle::listen_task, LOG, and HandlerList::next.

Referenced by do_destroy(), LEGACY_SERVICE_stop(), libgnunet_plugin_transport_tcp_done(), and shutdown_task().

772 {
773  struct HandlerList *hpos;
774  struct NotifyList *npos;
775  unsigned int i;
776 
778  "Server shutting down.\n");
779  if (NULL != server->listen_task)
780  {
782  server->listen_task = NULL;
783  }
784  if (NULL != server->listen_sockets)
785  {
786  i = 0;
787  while (NULL != server->listen_sockets[i])
790  GNUNET_free(server->listen_sockets);
791  server->listen_sockets = NULL;
792  }
793  while (NULL != server->clients_head)
795  while (NULL != (hpos = server->handlers))
796  {
797  server->handlers = hpos->next;
798  GNUNET_free(hpos);
799  }
800  while (NULL != (npos = server->disconnect_notify_list_head))
801  {
802  npos->callback(npos->callback_cls,
803  NULL);
806  npos);
807  GNUNET_free(npos);
808  }
809  while (NULL != (npos = server->connect_notify_list_head))
810  {
811  npos->callback(npos->callback_cls,
812  NULL);
814  server->connect_notify_list_tail,
815  npos);
816  GNUNET_free(npos);
817  }
818  GNUNET_free(server);
819 }
#define GNUNET_CONTAINER_DLL_remove(head, tail, element)
Remove an element from a DLL.
List of arrays of message handlers.
struct NotifyList * connect_notify_list_head
Head of linked list of functions to call on connects by clients.
List of arrays of message handlers.
struct GNUNET_NETWORK_Handle ** listen_sockets
NULL-terminated array of sockets used to listen for new connections.
#define LOG(kind,...)
Definition: arm_api.c:33
GNUNET_SERVER_DisconnectCallback callback
Function to call.
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:75
void * callback_cls
Closure for callback.
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
struct HandlerList * handlers
List of handlers for incoming messages.
struct NotifyList * disconnect_notify_list_head
Head of linked list of functions to call on disconnects by clients.
void GNUNET_SERVER_client_disconnect(struct GNUNET_SERVER_Client *client)
Ask the server to disconnect from the given client.
struct GNUNET_SCHEDULER_Task * listen_task
Task scheduled to do the listening.
struct NotifyList * disconnect_notify_list_tail
Tail of linked list of functions to call on disconnects by clients.
struct NotifyList * connect_notify_list_tail
Tail of linked list of functions to call on connects by clients.
struct GNUNET_SERVER_Client * clients_head
Head of list of our current clients.
struct HandlerList * next
This is a linked list.
int GNUNET_NETWORK_socket_close(struct GNUNET_NETWORK_Handle *desc)
Close a socket.
Definition: network.c:548
#define GNUNET_free(ptr)
Wrapper around free.
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:956
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_SERVER_add_handlers()

void GNUNET_SERVER_add_handlers ( struct GNUNET_SERVER_Handle server,
const struct GNUNET_SERVER_MessageHandler handlers 
)

Add additional handlers to an existing server.

Parameters
serverthe server to add handlers to
handlersarray of message handlers for incoming messages; the last entry must have "NULL" for the "callback"; multiple entries for the same type are allowed, they will be called in order of occurence. These handlers can be removed later; the handlers array must exist until removed (or server is destroyed).

Definition at line 836 of file tcp_server_legacy.c.

References GNUNET_new, HandlerList::handlers, GNUNET_SERVER_Handle::handlers, HandlerList::next, and p.

Referenced by LEGACY_SERVICE_start(), libgnunet_plugin_transport_tcp_init(), and service_task().

838 {
839  struct HandlerList *p;
840 
841  p = GNUNET_new(struct HandlerList);
842  p->handlers = handlers;
843  p->next = server->handlers;
844  server->handlers = p;
845 }
List of arrays of message handlers.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
struct HandlerList * handlers
List of handlers for incoming messages.
static struct GNUNET_OS_Process * p
Helper process we started.
Definition: gnunet-qr.c:59
static struct GNUNET_CADET_MessageHandler handlers[]
Handlers, for diverse services.
const struct GNUNET_SERVER_MessageHandler * handlers
NULL-terminated array of handlers.
struct HandlerList * next
This is a linked list.
Here is the caller graph for this function:

◆ GNUNET_SERVER_set_callbacks()

void GNUNET_SERVER_set_callbacks ( struct GNUNET_SERVER_Handle server,
GNUNET_SERVER_MstCreateCallback  create,
GNUNET_SERVER_MstDestroyCallback  destroy,
GNUNET_SERVER_MstReceiveCallback  receive,
void *  cls 
)

Change functions used by the server to tokenize the message stream.

(very rarely used).

Parameters
serverserver to modify
createnew tokenizer initialization function
destroynew tokenizer destruction function
receivenew tokenizer receive function
clsclosure for create, receive, destroy

Definition at line 859 of file tcp_server_legacy.c.

References destroy(), GNUNET_SERVER_Handle::mst_cls, GNUNET_SERVER_Handle::mst_create, GNUNET_SERVER_Handle::mst_destroy, and GNUNET_SERVER_Handle::mst_receive.

864 {
865  server->mst_create = create;
866  server->mst_destroy = destroy;
867  server->mst_receive = receive;
868  server->mst_cls = cls;
869 }
GNUNET_SERVER_MstReceiveCallback mst_receive
Alternative function to give data to a MST instance.
GNUNET_SERVER_MstDestroyCallback mst_destroy
Alternative function to destroy a MST instance.
GNUNET_SERVER_MstCreateCallback mst_create
Alternative function to create a MST instance.
static void destroy(void *cls)
void * mst_cls
Closure for &#39;mst_&#39;-callbacks.
Here is the call graph for this function:

◆ warn_no_receive_done()

static void warn_no_receive_done ( void *  cls)
static

Task run to warn about missing calls to GNUNET_SERVER_receive_done.

Parameters
clsour struct GNUNET_SERVER_Client * to process more requests from

Definition at line 878 of file tcp_server_legacy.c.

References _, GNUNET_break, GNUNET_ERROR_TYPE_WARNING, GNUNET_SCHEDULER_add_delayed(), GNUNET_STRINGS_relative_time_to_string(), GNUNET_TIME_absolute_get_duration(), GNUNET_TIME_UNIT_MINUTES, GNUNET_YES, LOG, GNUNET_SERVER_Client::warn_start, GNUNET_SERVER_Client::warn_task, and GNUNET_SERVER_Client::warn_type.

Referenced by GNUNET_SERVER_inject().

879 {
880  struct GNUNET_SERVER_Client *client = cls;
881 
882  GNUNET_break(0 != client->warn_type); /* type should never be 0 here, as we don't use 0 */
883  client->warn_task =
885  &warn_no_receive_done, client);
887  _("Processing code for message of type %u did not call `GNUNET_SERVER_receive_done' after %s\n"),
888  (unsigned int)client->warn_type,
890  GNUNET_YES));
891 }
#define GNUNET_TIME_UNIT_MINUTES
One minute.
#define LOG(kind,...)
Definition: arm_api.c:33
static void warn_no_receive_done(void *cls)
Task run to warn about missing calls to GNUNET_SERVER_receive_done.
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
#define _(String)
GNU gettext support macro.
Definition: platform.h:181
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_delayed(struct GNUNET_TIME_Relative delay, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay.
Definition: scheduler.c:1237
const char * GNUNET_STRINGS_relative_time_to_string(struct GNUNET_TIME_Relative delta, int do_round)
Give relative time in human-readable fancy format.
Definition: strings.c:686
uint16_t warn_type
Type of last message processed (for warn_no_receive_done).
struct GNUNET_TIME_Absolute warn_start
Time when the warn task was started.
struct GNUNET_TIME_Relative GNUNET_TIME_absolute_get_duration(struct GNUNET_TIME_Absolute whence)
Get the duration of an operation as the difference of the current time and the given start time "henc...
Definition: time.c:373
struct GNUNET_SCHEDULER_Task * warn_task
Task that warns about missing calls to GNUNET_SERVER_receive_done.
#define GNUNET_YES
Definition: gnunet_common.h:77
handle for a client of the server
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_SERVER_disable_receive_done_warning()

void GNUNET_SERVER_disable_receive_done_warning ( struct GNUNET_SERVER_Client client)

Disable the warning the server issues if a message is not acknowledged in a timely fashion.

Use this call if a client is intentionally delayed for a while. Only applies to the current message.

Parameters
clientclient for which to disable the warning

Definition at line 902 of file tcp_server_legacy.c.

References GNUNET_SCHEDULER_cancel(), and GNUNET_SERVER_Client::warn_task.

Referenced by handle_tcp_data().

903 {
904  if (NULL != client->warn_task)
905  {
907  client->warn_task = NULL;
908  }
909 }
struct GNUNET_SCHEDULER_Task * warn_task
Task that warns about missing calls to GNUNET_SERVER_receive_done.
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:956
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_SERVER_inject()

int GNUNET_SERVER_inject ( struct GNUNET_SERVER_Handle server,
struct GNUNET_SERVER_Client sender,
const struct GNUNET_MessageHeader message 
)

Inject a message into the server, pretend it came from the specified client.

Delivery of the message will happen instantly (if a handler is installed; otherwise the call does nothing).

Parameters
serverthe server receiving the message
senderthe "pretended" sender of the message can be NULL!
messagemessage to transmit
Returns
GNUNET_OK if the message was OK and the connection can stay open GNUNET_SYSERR if the connection to the client should be shut down

Definition at line 928 of file tcp_server_legacy.c.

References buf, GNUNET_SERVER_MessageHandler::callback, GNUNET_SERVER_MessageHandler::callback_cls, GNUNET_SERVER_MessageHandler::expected_size, GNUNET_break, GNUNET_break_op, GNUNET_ERROR_TYPE_BULK, GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_INFO, GNUNET_ERROR_TYPE_WARNING, GNUNET_MESSAGE_TYPE_ALL, GNUNET_NO, GNUNET_OK, GNUNET_SCHEDULER_add_delayed(), GNUNET_SYSERR, GNUNET_TIME_absolute_get(), GNUNET_TIME_UNIT_MINUTES, GNUNET_YES, HandlerList::handlers, GNUNET_SERVER_Handle::handlers, LOG, mh, HandlerList::next, process_incoming(), GNUNET_SERVER_Handle::require_found, size, GNUNET_MessageHeader::size, GNUNET_SERVER_Client::suspended, type, GNUNET_SERVER_MessageHandler::type, GNUNET_MessageHeader::type, warn_no_receive_done(), GNUNET_SERVER_Client::warn_start, GNUNET_SERVER_Client::warn_task, and GNUNET_SERVER_Client::warn_type.

Referenced by client_message_tokenizer_callback().

931 {
932  struct HandlerList *pos;
933  const struct GNUNET_SERVER_MessageHandler *mh;
934  unsigned int i;
935  uint16_t type;
936  uint16_t size;
937  int found;
938 
939  type = ntohs(message->type);
940  size = ntohs(message->size);
942  "Received message of type %u and size %u from client\n",
943  type, size);
944  found = GNUNET_NO;
945  for (pos = server->handlers; NULL != pos; pos = pos->next)
946  {
947  i = 0;
948  while (pos->handlers[i].callback != NULL)
949  {
950  mh = &pos->handlers[i];
951  if ((mh->type == type) || (mh->type == GNUNET_MESSAGE_TYPE_ALL))
952  {
953  if ((0 != mh->expected_size) && (mh->expected_size != size))
954  {
955 #if GNUNET8_NETWORK_IS_DEAD
957  "Expected %u bytes for message of type %u, got %u\n",
958  mh->expected_size, mh->type, size);
959  GNUNET_break_op(0);
960 #else
962  "Expected %u bytes for message of type %u, got %u\n",
963  mh->expected_size, mh->type, size);
964 #endif
965  return GNUNET_SYSERR;
966  }
967  if (NULL != sender)
968  {
969  if ((0 == sender->suspended) &&
970  (NULL == sender->warn_task))
971  {
972  GNUNET_break(0 != type); /* type should never be 0 here, as we don't use 0 */
974  sender->warn_task =
977  sender);
978  sender->warn_type = type;
979  }
980  sender->suspended++;
981  }
982  mh->callback(mh->callback_cls, sender, message);
983  found = GNUNET_YES;
984  }
985  i++;
986  }
987  }
988  if (GNUNET_NO == found)
989  {
991  "Received message of unknown type %d\n", type);
992  if (GNUNET_YES == server->require_found)
993  return GNUNET_SYSERR;
994  }
995  return GNUNET_OK;
996 }
List of arrays of message handlers.
GNUNET_SERVER_MessageCallback callback
Function to call for messages of "type".
#define GNUNET_TIME_UNIT_MINUTES
One minute.
#define LOG(kind,...)
Definition: arm_api.c:33
static struct GNUNET_CADET_Handle * mh
Cadet handle.
Definition: gnunet-cadet.c:92
static void warn_no_receive_done(void *cls)
Task run to warn about missing calls to GNUNET_SERVER_receive_done.
#define GNUNET_NO
Definition: gnunet_common.h:78
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:75
uint16_t size
The length of the struct (in bytes, including the length field itself), in big-endian format...
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
struct HandlerList * handlers
List of handlers for incoming messages.
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_delayed(struct GNUNET_TIME_Relative delay, GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run with a specified delay.
Definition: scheduler.c:1237
uint16_t type
The type of the message (GNUNET_MESSAGE_TYPE_XXXX), in big-endian format.
#define GNUNET_break_op(cond)
Use this for assertion violations caused by other peers (i.e.
uint16_t expected_size
Expected size of messages of this type.
struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_get(void)
Get the current time.
Definition: time.c:118
#define GNUNET_SYSERR
Definition: gnunet_common.h:76
static unsigned int size
Size of the "table".
Definition: peer.c:66
int require_found
Do we ignore messages of types that we do not understand or do we require that a handler is found (an...
uint16_t type
Type of the message this handler covers.
uint16_t warn_type
Type of last message processed (for warn_no_receive_done).
struct GNUNET_TIME_Absolute warn_start
Time when the warn task was started.
#define GNUNET_MESSAGE_TYPE_ALL
Next available: 1500.
const struct GNUNET_SERVER_MessageHandler * handlers
NULL-terminated array of handlers.
struct GNUNET_SCHEDULER_Task * warn_task
Task that warns about missing calls to GNUNET_SERVER_receive_done.
enum GNUNET_TESTBED_UnderlayLinkModelType type
the type of this model
#define GNUNET_YES
Definition: gnunet_common.h:77
struct HandlerList * next
This is a linked list.
void * callback_cls
Closure argument for callback.
unsigned int suspended
Was processing if incoming messages suspended while we were still processing data already received...
Here is the call graph for this function:
Here is the caller graph for this function:

◆ process_incoming()

static void process_incoming ( void *  cls,
const void *  buf,
size_t  available,
const struct sockaddr *  addr,
socklen_t  addrlen,
int  errCode 
)
static

We are receiving an incoming message.

Process it.

Parameters
clsour closure (handle for the client)
bufbuffer with data received from network
availablenumber of bytes available in buf
addraddress of the sender
addrlenlength of addr
errCodecode indicating errors receiving, 0 for success

Definition at line 1092 of file tcp_server_legacy.c.

References GNUNET_TIME_Absolute::abs_value_us, GNUNET_SERVER_Client::connection, GNUNET_a2s(), GNUNET_assert, GNUNET_break, GNUNET_CONNECTION_check(), GNUNET_CONNECTION_receive(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_MAX_MESSAGE_SIZE, GNUNET_NO, GNUNET_SERVER_client_disconnect(), GNUNET_SERVER_client_drop(), GNUNET_SERVER_client_keep(), GNUNET_SERVER_mst_receive(), GNUNET_TIME_absolute_add(), GNUNET_TIME_absolute_get(), GNUNET_TIME_absolute_get_remaining(), GNUNET_YES, GNUNET_SERVER_Client::idle_timeout, GNUNET_SERVER_Client::last_activity, LOG, GNUNET_SERVER_Client::mst, GNUNET_SERVER_Handle::mst_cls, GNUNET_SERVER_Handle::mst_receive, process_mst(), GNUNET_SERVER_Client::receive_pending, ret, GNUNET_SERVER_Client::server, and GNUNET_SERVER_Client::shutdown_now.

Referenced by GNUNET_SERVER_connect_socket(), GNUNET_SERVER_inject(), process_mst(), and restart_processing().

1098 {
1099  struct GNUNET_SERVER_Client *client = cls;
1100  struct GNUNET_SERVER_Handle *server = client->server;
1101  struct GNUNET_TIME_Absolute end;
1102  struct GNUNET_TIME_Absolute now;
1103  int ret;
1104 
1106  client->receive_pending = GNUNET_NO;
1107  now = GNUNET_TIME_absolute_get();
1109  client->idle_timeout);
1110 
1111  if ((NULL == buf) &&
1112  (0 == available) &&
1113  (NULL == addr) &&
1114  (0 == errCode) &&
1115  (GNUNET_YES != client->shutdown_now) &&
1116  (NULL != server) &&
1118  (end.abs_value_us > now.abs_value_us))
1119  {
1120  /* wait longer, timeout changed (i.e. due to us sending) */
1122  "Receive time out, but no disconnect due to sending (%p)\n",
1123  client);
1124  client->receive_pending = GNUNET_YES;
1129  client);
1130  return;
1131  }
1132  if ((NULL == buf) ||
1133  (0 == available) ||
1134  (0 != errCode) ||
1135  (NULL == server) ||
1136  (GNUNET_YES == client->shutdown_now) ||
1138  {
1139  /* other side closed connection, error connecting, etc. */
1141  "Failed to connect or other side closed connection (%p)\n",
1142  client);
1144  return;
1145  }
1147  "Server receives %u bytes from `%s'.\n",
1148  (unsigned int)available,
1149  GNUNET_a2s(addr, addrlen));
1150  GNUNET_SERVER_client_keep(client);
1151  client->last_activity = now;
1152 
1153  if (NULL != server->mst_receive)
1154  {
1155  ret = client->server->mst_receive(client->server->mst_cls,
1156  client->mst,
1157  client,
1158  buf,
1159  available,
1160  GNUNET_NO,
1161  GNUNET_YES);
1162  }
1163  else if (NULL != client->mst)
1164  {
1165  ret =
1167  client,
1168  buf,
1169  available,
1170  GNUNET_NO,
1171  GNUNET_YES);
1172  }
1173  else
1174  {
1175  GNUNET_break(0);
1176  return;
1177  }
1178  process_mst(client,
1179  ret);
1180  GNUNET_SERVER_client_drop(client);
1181 }
static int end
Set if we are to shutdown all services (including ARM).
Definition: gnunet-arm.c:34
void GNUNET_SERVER_client_keep(struct GNUNET_SERVER_Client *client)
Notify the server that the given client handle should be kept (keeps the connection up if possible...
#define LOG(kind,...)
Definition: arm_api.c:33
GNUNET_SERVER_MstReceiveCallback mst_receive
Alternative function to give data to a MST instance.
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
struct GNUNET_TIME_Absolute last_activity
Last activity on this socket (used to time it out if reference_count == 0).
#define GNUNET_NO
Definition: gnunet_common.h:78
struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_add(struct GNUNET_TIME_Absolute start, struct GNUNET_TIME_Relative duration)
Add a given relative duration to the given start time.
Definition: time.c:393
int GNUNET_SERVER_mst_receive(struct GNUNET_SERVER_MessageStreamTokenizer *mst, void *client_identity, const char *buf, size_t size, int purge, int one_shot)
Add incoming data to the receive buffer and call the callback for all complete messages.
int receive_pending
Are we currently trying to receive? (GNUNET_YES if we are, GNUNET_NO if we are not, GNUNET_SYSERR if data is already available in MST).
static int ret
Final status code.
Definition: gnunet-arm.c:89
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
struct GNUNET_TIME_Relative idle_timeout
After how long should an idle connection time out (on write).
static char buf[2048]
int GNUNET_CONNECTION_receive(struct GNUNET_CONNECTION_Handle *connection, size_t max, struct GNUNET_TIME_Relative timeout, GNUNET_CONNECTION_Receiver receiver, void *receiver_cls)
Receive data from the given connection.
int GNUNET_CONNECTION_check(struct GNUNET_CONNECTION_Handle *connection)
Check if connection is valid (no fatal errors have happened so far).
void GNUNET_SERVER_client_drop(struct GNUNET_SERVER_Client *client)
Notify the server that the given client handle is no longer required.
handle for a server
struct GNUNET_CONNECTION_Handle * connection
Client closure for callbacks.
const char * GNUNET_a2s(const struct sockaddr *addr, socklen_t addrlen)
Convert a "struct sockaddr*" (IPv4 or IPv6 address) to a string (for printing debug messages)...
struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_get(void)
Get the current time.
Definition: time.c:118
int shutdown_now
We&#39;re about to close down this client.
void GNUNET_SERVER_client_disconnect(struct GNUNET_SERVER_Client *client)
Ask the server to disconnect from the given client.
static void process_incoming(void *cls, const void *buf, size_t available, const struct sockaddr *addr, socklen_t addrlen, int errCode)
We are receiving an incoming message.
#define GNUNET_MAX_MESSAGE_SIZE
Largest supported message (to be precise, one byte more than the largest possible message...
struct GNUNET_TIME_Relative GNUNET_TIME_absolute_get_remaining(struct GNUNET_TIME_Absolute future)
Given a timestamp in the future, how much time remains until then?
Definition: time.c:331
Time for absolute times used by GNUnet, in microseconds.
#define GNUNET_YES
Definition: gnunet_common.h:77
handle for a client of the server
struct GNUNET_SERVER_Handle * server
Server that this client belongs to.
void * mst_cls
Closure for &#39;mst_&#39;-callbacks.
void * mst
Processing of incoming data.
static void process_mst(struct GNUNET_SERVER_Client *client, int ret)
Process messages from the client&#39;s message tokenizer until either the tokenizer is empty (and then sc...
Here is the call graph for this function:
Here is the caller graph for this function:

◆ process_mst()

static void process_mst ( struct GNUNET_SERVER_Client client,
int  ret 
)
static

Process messages from the client's message tokenizer until either the tokenizer is empty (and then schedule receiving more), or until some handler is not immediately done (then wait for restart_processing) or shutdown.

Parameters
clientthe client to process, RC must have already been increased using GNUNET_SERVER_client_keep and will be decreased by one in this function
retGNUNET_NO to start processing from the buffer, GNUNET_OK if the mst buffer is drained and we should instantly go back to receiving GNUNET_SYSERR if we should instantly abort due to error in a previous step

Definition at line 1032 of file tcp_server_legacy.c.

References GNUNET_SERVER_Client::connection, GNUNET_CONNECTION_receive(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_MAX_MESSAGE_SIZE, GNUNET_NO, GNUNET_OK, GNUNET_SERVER_client_disconnect(), GNUNET_SERVER_mst_receive(), GNUNET_STRINGS_relative_time_to_string(), GNUNET_SYSERR, GNUNET_YES, GNUNET_SERVER_Client::idle_timeout, LOG, GNUNET_SERVER_Client::mst, GNUNET_SERVER_Handle::mst_cls, GNUNET_SERVER_Handle::mst_receive, process_incoming(), GNUNET_SERVER_Client::receive_pending, GNUNET_SERVER_Client::server, GNUNET_SERVER_Client::shutdown_now, and GNUNET_SERVER_Client::suspended.

Referenced by process_incoming(), and restart_processing().

1034 {
1035  while ((GNUNET_SYSERR != ret) && (NULL != client->server) &&
1036  (GNUNET_YES != client->shutdown_now) && (0 == client->suspended))
1037  {
1038  if (GNUNET_OK == ret)
1039  {
1041  "Server re-enters receive loop, timeout: %s.\n",
1043  client->receive_pending = GNUNET_YES;
1044  if (GNUNET_OK !=
1047  client->idle_timeout,
1049  client))
1050  return;
1051  break;
1052  }
1054  "Server processes additional messages instantly.\n");
1055  if (NULL != client->server->mst_receive)
1056  ret =
1057  client->server->mst_receive(client->server->mst_cls, client->mst,
1058  client, NULL, 0, GNUNET_NO, GNUNET_YES);
1059  else
1060  ret =
1061  GNUNET_SERVER_mst_receive(client->mst, client, NULL, 0, GNUNET_NO,
1062  GNUNET_YES);
1063  }
1065  "Server leaves instant processing loop: ret = %d, server = %p, shutdown = %d, suspended = %u\n",
1066  ret, client->server,
1067  client->shutdown_now,
1068  client->suspended);
1069  if (GNUNET_NO == ret)
1070  {
1072  "Server has more data pending but is suspended.\n");
1073  client->receive_pending = GNUNET_SYSERR; /* data pending */
1074  }
1075  if ((GNUNET_SYSERR == ret) ||
1076  (GNUNET_YES == client->shutdown_now))
1078 }
#define LOG(kind,...)
Definition: arm_api.c:33
GNUNET_SERVER_MstReceiveCallback mst_receive
Alternative function to give data to a MST instance.
#define GNUNET_NO
Definition: gnunet_common.h:78
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:75
int GNUNET_SERVER_mst_receive(struct GNUNET_SERVER_MessageStreamTokenizer *mst, void *client_identity, const char *buf, size_t size, int purge, int one_shot)
Add incoming data to the receive buffer and call the callback for all complete messages.
int receive_pending
Are we currently trying to receive? (GNUNET_YES if we are, GNUNET_NO if we are not, GNUNET_SYSERR if data is already available in MST).
static int ret
Final status code.
Definition: gnunet-arm.c:89
struct GNUNET_TIME_Relative idle_timeout
After how long should an idle connection time out (on write).
const char * GNUNET_STRINGS_relative_time_to_string(struct GNUNET_TIME_Relative delta, int do_round)
Give relative time in human-readable fancy format.
Definition: strings.c:686
int GNUNET_CONNECTION_receive(struct GNUNET_CONNECTION_Handle *connection, size_t max, struct GNUNET_TIME_Relative timeout, GNUNET_CONNECTION_Receiver receiver, void *receiver_cls)
Receive data from the given connection.
struct GNUNET_CONNECTION_Handle * connection
Client closure for callbacks.
int shutdown_now
We&#39;re about to close down this client.
void GNUNET_SERVER_client_disconnect(struct GNUNET_SERVER_Client *client)
Ask the server to disconnect from the given client.
static void process_incoming(void *cls, const void *buf, size_t available, const struct sockaddr *addr, socklen_t addrlen, int errCode)
We are receiving an incoming message.
#define GNUNET_SYSERR
Definition: gnunet_common.h:76
#define GNUNET_MAX_MESSAGE_SIZE
Largest supported message (to be precise, one byte more than the largest possible message...
#define GNUNET_YES
Definition: gnunet_common.h:77
struct GNUNET_SERVER_Handle * server
Server that this client belongs to.
void * mst_cls
Closure for &#39;mst_&#39;-callbacks.
void * mst
Processing of incoming data.
unsigned int suspended
Was processing if incoming messages suspended while we were still processing data already received...
Here is the call graph for this function:
Here is the caller graph for this function:

◆ restart_processing()

static void restart_processing ( void *  cls)
static

Task run to start again receiving from the network and process requests.

Parameters
clsour struct GNUNET_SERVER_Client * to process more requests from

Definition at line 1191 of file tcp_server_legacy.c.

References GNUNET_SERVER_Client::connection, GNUNET_assert, GNUNET_CONNECTION_receive(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_MAX_MESSAGE_SIZE, GNUNET_NO, GNUNET_SERVER_client_drop(), GNUNET_SERVER_client_keep(), GNUNET_YES, GNUNET_SERVER_Client::idle_timeout, LOG, process_incoming(), process_mst(), GNUNET_SERVER_Client::receive_pending, GNUNET_SERVER_Client::restart_task, and GNUNET_SERVER_Client::shutdown_now.

Referenced by GNUNET_SERVER_receive_done().

1192 {
1193  struct GNUNET_SERVER_Client *client = cls;
1194 
1196  client->restart_task = NULL;
1197  if (GNUNET_NO == client->receive_pending)
1198  {
1199  LOG(GNUNET_ERROR_TYPE_DEBUG, "Server begins to read again from client.\n");
1200  client->receive_pending = GNUNET_YES;
1203  client->idle_timeout,
1205  client);
1206  return;
1207  }
1209  "Server continues processing messages still in the buffer.\n");
1210  GNUNET_SERVER_client_keep(client);
1211  client->receive_pending = GNUNET_NO;
1212  process_mst(client,
1213  GNUNET_NO);
1214  GNUNET_SERVER_client_drop(client);
1215 }
void GNUNET_SERVER_client_keep(struct GNUNET_SERVER_Client *client)
Notify the server that the given client handle should be kept (keeps the connection up if possible...
#define LOG(kind,...)
Definition: arm_api.c:33
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
#define GNUNET_NO
Definition: gnunet_common.h:78
int receive_pending
Are we currently trying to receive? (GNUNET_YES if we are, GNUNET_NO if we are not, GNUNET_SYSERR if data is already available in MST).
struct GNUNET_TIME_Relative idle_timeout
After how long should an idle connection time out (on write).
int GNUNET_CONNECTION_receive(struct GNUNET_CONNECTION_Handle *connection, size_t max, struct GNUNET_TIME_Relative timeout, GNUNET_CONNECTION_Receiver receiver, void *receiver_cls)
Receive data from the given connection.
void GNUNET_SERVER_client_drop(struct GNUNET_SERVER_Client *client)
Notify the server that the given client handle is no longer required.
struct GNUNET_CONNECTION_Handle * connection
Client closure for callbacks.
int shutdown_now
We&#39;re about to close down this client.
static void process_incoming(void *cls, const void *buf, size_t available, const struct sockaddr *addr, socklen_t addrlen, int errCode)
We are receiving an incoming message.
#define GNUNET_MAX_MESSAGE_SIZE
Largest supported message (to be precise, one byte more than the largest possible message...
#define GNUNET_YES
Definition: gnunet_common.h:77
handle for a client of the server
static void process_mst(struct GNUNET_SERVER_Client *client, int ret)
Process messages from the client&#39;s message tokenizer until either the tokenizer is empty (and then sc...
struct GNUNET_SCHEDULER_Task * restart_task
ID of task used to restart processing.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ client_message_tokenizer_callback()

static int client_message_tokenizer_callback ( void *  cls,
void *  client,
const struct GNUNET_MessageHeader message 
)
static

This function is called whenever our inbound message tokenizer has received a complete message.

Parameters
clsclosure (struct GNUNET_SERVER_Handle)
clientidentification of the client (struct GNUNET_SERVER_Client *)
messagethe actual message
Returns
GNUNET_OK on success, GNUNET_SYSERR to stop further processing

Definition at line 1229 of file tcp_server_legacy.c.

References GNUNET_ERROR_TYPE_DEBUG, GNUNET_NO, GNUNET_OK, GNUNET_SERVER_client_disconnect(), GNUNET_SERVER_inject(), GNUNET_SYSERR, GNUNET_YES, GNUNET_SERVER_Client::in_process_client_buffer, LOG, ret, GNUNET_SERVER_Client::shutdown_now, GNUNET_MessageHeader::size, and GNUNET_MessageHeader::type.

Referenced by GNUNET_SERVER_connect_socket().

1232 {
1233  struct GNUNET_SERVER_Handle *server = cls;
1234  struct GNUNET_SERVER_Client *sender = client;
1235  int ret;
1236 
1238  "Tokenizer gives server message of type %u and size %u from client\n",
1239  ntohs(message->type), ntohs(message->size));
1241  ret = GNUNET_SERVER_inject(server, sender, message);
1243  if ((GNUNET_OK != ret) || (GNUNET_YES == sender->shutdown_now))
1244  {
1246  return GNUNET_SYSERR;
1247  }
1248  return GNUNET_OK;
1249 }
int in_process_client_buffer
Are we currently in the "process_client_buffer" function (and will hence restart the receive job on e...
#define LOG(kind,...)
Definition: arm_api.c:33
#define GNUNET_NO
Definition: gnunet_common.h:78
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:75
uint16_t size
The length of the struct (in bytes, including the length field itself), in big-endian format...
static int ret
Final status code.
Definition: gnunet-arm.c:89
int GNUNET_SERVER_inject(struct GNUNET_SERVER_Handle *server, struct GNUNET_SERVER_Client *sender, const struct GNUNET_MessageHeader *message)
Inject a message into the server, pretend it came from the specified client.
uint16_t type
The type of the message (GNUNET_MESSAGE_TYPE_XXXX), in big-endian format.
handle for a server
int shutdown_now
We&#39;re about to close down this client.
void GNUNET_SERVER_client_disconnect(struct GNUNET_SERVER_Client *client)
Ask the server to disconnect from the given client.
#define GNUNET_SYSERR
Definition: gnunet_common.h:76
#define GNUNET_YES
Definition: gnunet_common.h:77
handle for a client of the server
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_SERVER_connect_socket()

struct GNUNET_SERVER_Client* GNUNET_SERVER_connect_socket ( struct GNUNET_SERVER_Handle server,
struct GNUNET_CONNECTION_Handle connection 
)

Add a TCP socket-based connection to the set of handles managed by this server.

Use this function for outgoing (P2P) connections that we initiated (and where this server should process incoming messages).

Parameters
serverthe server to use
connectionthe connection to manage (client must stop using this connection from now on)
Returns
the client handle

Definition at line 1264 of file tcp_server_legacy.c.

References NotifyList::callback, NotifyList::callback_cls, client_message_tokenizer_callback(), GNUNET_SERVER_Handle::clients_head, GNUNET_SERVER_Handle::clients_tail, GNUNET_SERVER_Handle::connect_notify_list_head, GNUNET_SERVER_Client::connection, GNUNET_assert, GNUNET_CONNECTION_receive(), GNUNET_CONTAINER_DLL_insert, GNUNET_MAX_MESSAGE_SIZE, GNUNET_new, GNUNET_SERVER_mst_create(), GNUNET_SYSERR, GNUNET_TIME_absolute_get(), GNUNET_YES, GNUNET_SERVER_Handle::idle_timeout, GNUNET_SERVER_Client::idle_timeout, GNUNET_SERVER_Client::last_activity, GNUNET_SERVER_Client::mst, GNUNET_SERVER_Handle::mst_cls, GNUNET_SERVER_Handle::mst_create, NotifyList::next, process_incoming(), GNUNET_SERVER_Client::receive_pending, and GNUNET_SERVER_Client::server.

Referenced by notify_send_probe(), process_listen_socket(), and tcp_plugin_get_session().

1266 {
1267  struct GNUNET_SERVER_Client *client;
1268  struct NotifyList *n;
1269 
1270  client = GNUNET_new(struct GNUNET_SERVER_Client);
1271  client->connection = connection;
1272  client->server = server;
1274  client->idle_timeout = server->idle_timeout;
1276  server->clients_tail,
1277  client);
1278  if (NULL != server->mst_create)
1279  client->mst =
1280  server->mst_create(server->mst_cls, client);
1281  else
1282  client->mst =
1284  server);
1285  GNUNET_assert(NULL != client->mst);
1286  for (n = server->connect_notify_list_head; NULL != n; n = n->next)
1287  n->callback(n->callback_cls, client);
1288  client->receive_pending = GNUNET_YES;
1289  if (GNUNET_SYSERR ==
1292  client->idle_timeout,
1294  client))
1295  return NULL;
1296  return client;
1297 }
#define GNUNET_CONTAINER_DLL_insert(head, tail, element)
Insert an element at the head of a DLL.
struct NotifyList * connect_notify_list_head
Head of linked list of functions to call on connects by clients.
List of arrays of message handlers.
struct GNUNET_SERVER_Client * clients_tail
Head of list of our current clients.
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
struct GNUNET_TIME_Absolute last_activity
Last activity on this socket (used to time it out if reference_count == 0).
GNUNET_SERVER_DisconnectCallback callback
Function to call.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
int receive_pending
Are we currently trying to receive? (GNUNET_YES if we are, GNUNET_NO if we are not, GNUNET_SYSERR if data is already available in MST).
void * callback_cls
Closure for callback.
struct NotifyList * next
This is a doubly linked list.
struct GNUNET_TIME_Relative idle_timeout
After how long should an idle connection time out (on write).
struct GNUNET_TIME_Relative idle_timeout
After how long should an idle connection time out (on write).
int GNUNET_CONNECTION_receive(struct GNUNET_CONNECTION_Handle *connection, size_t max, struct GNUNET_TIME_Relative timeout, GNUNET_CONNECTION_Receiver receiver, void *receiver_cls)
Receive data from the given connection.
GNUNET_SERVER_MstCreateCallback mst_create
Alternative function to create a MST instance.
struct GNUNET_CONNECTION_Handle * connection
Client closure for callbacks.
struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_get(void)
Get the current time.
Definition: time.c:118
static void process_incoming(void *cls, const void *buf, size_t available, const struct sockaddr *addr, socklen_t addrlen, int errCode)
We are receiving an incoming message.
#define GNUNET_SYSERR
Definition: gnunet_common.h:76
static int client_message_tokenizer_callback(void *cls, void *client, const struct GNUNET_MessageHeader *message)
This function is called whenever our inbound message tokenizer has received a complete message...
#define GNUNET_MAX_MESSAGE_SIZE
Largest supported message (to be precise, one byte more than the largest possible message...
#define GNUNET_YES
Definition: gnunet_common.h:77
handle for a client of the server
struct GNUNET_SERVER_Client * clients_head
Head of list of our current clients.
struct GNUNET_SERVER_Handle * server
Server that this client belongs to.
void * mst_cls
Closure for &#39;mst_&#39;-callbacks.
void * mst
Processing of incoming data.
struct GNUNET_SERVER_MessageStreamTokenizer * GNUNET_SERVER_mst_create(GNUNET_SERVER_MessageTokenizerCallback cb, void *cb_cls)
Create a message stream tokenizer.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_SERVER_client_set_timeout()

void GNUNET_SERVER_client_set_timeout ( struct GNUNET_SERVER_Client client,
struct GNUNET_TIME_Relative  timeout 
)

Change the timeout for a particular client.

Decreasing the timeout may not go into effect immediately (only after the previous timeout times out or activity happens on the socket).

Parameters
clientthe client to update
timeoutnew timeout for activities on the socket

Definition at line 1309 of file tcp_server_legacy.c.

References GNUNET_SERVER_Client::idle_timeout, and timeout.

Referenced by handle_tcp_welcome(), and tcp_plugin_send().

1311 {
1312  client->idle_timeout = timeout;
1313 }
static struct GNUNET_TIME_Relative timeout
User defined timestamp for completing operations.
Definition: gnunet-arm.c:114
struct GNUNET_TIME_Relative idle_timeout
After how long should an idle connection time out (on write).
Here is the caller graph for this function:

◆ GNUNET_SERVER_client_keep()

void GNUNET_SERVER_client_keep ( struct GNUNET_SERVER_Client client)

Notify the server that the given client handle should be kept (keeps the connection up if possible, increments the internal reference counter).

Parameters
clientthe client to keep

Definition at line 1324 of file tcp_server_legacy.c.

References GNUNET_SERVER_Client::reference_count.

Referenced by process_incoming(), and restart_processing().

1325 {
1326  client->reference_count++;
1327 }
unsigned int reference_count
Number of external entities with a reference to this client object.
Here is the caller graph for this function:

◆ GNUNET_SERVER_client_drop()

void GNUNET_SERVER_client_drop ( struct GNUNET_SERVER_Client client)

Notify the server that the given client handle is no longer required.

Decrements the reference counter. If that counter reaches zero an inactive connection maybe closed.

Parameters
clientthe client to drop

Definition at line 1339 of file tcp_server_legacy.c.

References GNUNET_assert, GNUNET_SERVER_client_disconnect(), GNUNET_YES, GNUNET_SERVER_Client::reference_count, and GNUNET_SERVER_Client::shutdown_now.

Referenced by process_incoming(), and restart_processing().

1340 {
1341  GNUNET_assert(client->reference_count > 0);
1342  client->reference_count--;
1343  if ((GNUNET_YES == client->shutdown_now) && (0 == client->reference_count))
1345 }
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
int shutdown_now
We&#39;re about to close down this client.
unsigned int reference_count
Number of external entities with a reference to this client object.
void GNUNET_SERVER_client_disconnect(struct GNUNET_SERVER_Client *client)
Ask the server to disconnect from the given client.
#define GNUNET_YES
Definition: gnunet_common.h:77
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_SERVER_client_get_address()

int GNUNET_SERVER_client_get_address ( struct GNUNET_SERVER_Client client,
void **  addr,
size_t *  addrlen 
)

Obtain the network address of the other party.

Parameters
clientthe client to get the address for
addrwhere to store the address
addrlenwhere to store the length of the addr
Returns
GNUNET_OK on success

Definition at line 1357 of file tcp_server_legacy.c.

References GNUNET_SERVER_Client::connection, and GNUNET_CONNECTION_get_address().

Referenced by handle_tcp_data(), handle_tcp_nat_probe(), and handle_tcp_welcome().

1359 {
1360  return GNUNET_CONNECTION_get_address(client->connection, addr, addrlen);
1361 }
struct GNUNET_CONNECTION_Handle * connection
Client closure for callbacks.
int GNUNET_CONNECTION_get_address(struct GNUNET_CONNECTION_Handle *connection, void **addr, size_t *addrlen)
Obtain the network address of the other party.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_SERVER_disconnect_notify()

void GNUNET_SERVER_disconnect_notify ( struct GNUNET_SERVER_Handle server,
GNUNET_SERVER_DisconnectCallback  callback,
void *  callback_cls 
)

Ask the server to notify us whenever a client disconnects.

This function is called whenever the actual network connection is closed; the reference count may be zero or larger than zero at this point.

Parameters
serverthe server manageing the clients
callbackfunction to call on disconnect
callback_clsclosure for callback

Definition at line 1375 of file tcp_server_legacy.c.

References NotifyList::callback, NotifyList::callback_cls, GNUNET_SERVER_Handle::disconnect_notify_list_head, GNUNET_SERVER_Handle::disconnect_notify_list_tail, GNUNET_CONTAINER_DLL_insert, and GNUNET_new.

Referenced by libgnunet_plugin_transport_tcp_init().

1378 {
1379  struct NotifyList *n;
1380 
1381  n = GNUNET_new(struct NotifyList);
1382  n->callback = callback;
1386  n);
1387 }
#define GNUNET_CONTAINER_DLL_insert(head, tail, element)
Insert an element at the head of a DLL.
List of arrays of message handlers.
GNUNET_SERVER_DisconnectCallback callback
Function to call.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
void * callback_cls
Closure for callback.
struct NotifyList * disconnect_notify_list_head
Head of linked list of functions to call on disconnects by clients.
struct NotifyList * disconnect_notify_list_tail
Tail of linked list of functions to call on disconnects by clients.
Here is the caller graph for this function:

◆ GNUNET_SERVER_connect_notify()

void GNUNET_SERVER_connect_notify ( struct GNUNET_SERVER_Handle server,
GNUNET_SERVER_ConnectCallback  callback,
void *  callback_cls 
)

Ask the server to notify us whenever a client connects.

This function is called whenever the actual network connection is opened. If the server is destroyed before this notification is explicitly cancelled, the 'callback' will once be called with a 'client' argument of NULL to indicate that the server itself is now gone (and that the callback won't be called anymore and also can no longer be cancelled).

Parameters
serverthe server manageing the clients
callbackfunction to call on sconnect
callback_clsclosure for callback

Definition at line 1404 of file tcp_server_legacy.c.

References NotifyList::callback, NotifyList::callback_cls, GNUNET_SERVER_Handle::clients_head, GNUNET_SERVER_Handle::connect_notify_list_head, GNUNET_SERVER_Handle::connect_notify_list_tail, GNUNET_CONTAINER_DLL_insert, GNUNET_new, and GNUNET_SERVER_Client::next.

Referenced by libgnunet_plugin_transport_tcp_init().

1407 {
1408  struct NotifyList *n;
1409  struct GNUNET_SERVER_Client *client;
1410 
1411  n = GNUNET_new(struct NotifyList);
1412  n->callback = callback;
1413  n->callback_cls = callback_cls;
1415  server->connect_notify_list_tail,
1416  n);
1417  for (client = server->clients_head; NULL != client; client = client->next)
1418  callback(callback_cls, client);
1419 }
#define GNUNET_CONTAINER_DLL_insert(head, tail, element)
Insert an element at the head of a DLL.
struct NotifyList * connect_notify_list_head
Head of linked list of functions to call on connects by clients.
List of arrays of message handlers.
GNUNET_SERVER_DisconnectCallback callback
Function to call.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
struct GNUNET_SERVER_Client * next
This is a doubly linked list.
void * callback_cls
Closure for callback.
struct NotifyList * connect_notify_list_tail
Tail of linked list of functions to call on connects by clients.
handle for a client of the server
struct GNUNET_SERVER_Client * clients_head
Head of list of our current clients.
Here is the caller graph for this function:

◆ GNUNET_SERVER_disconnect_notify_cancel()

void GNUNET_SERVER_disconnect_notify_cancel ( struct GNUNET_SERVER_Handle server,
GNUNET_SERVER_DisconnectCallback  callback,
void *  callback_cls 
)

Ask the server to stop notifying us whenever a client connects.

Parameters
serverthe server manageing the clients
callbackfunction to call on connect
callback_clsclosure for callback

Definition at line 1430 of file tcp_server_legacy.c.

References NotifyList::callback, NotifyList::callback_cls, GNUNET_SERVER_Handle::disconnect_notify_list_head, GNUNET_SERVER_Handle::disconnect_notify_list_tail, GNUNET_break, GNUNET_CONTAINER_DLL_remove, GNUNET_free, and NotifyList::next.

1433 {
1434  struct NotifyList *pos;
1435 
1436  for (pos = server->disconnect_notify_list_head; NULL != pos; pos = pos->next)
1437  if ((pos->callback == callback) && (pos->callback_cls == callback_cls))
1438  break;
1439  if (NULL == pos)
1440  {
1441  GNUNET_break(0);
1442  return;
1443  }
1446  pos);
1447  GNUNET_free(pos);
1448 }
#define GNUNET_CONTAINER_DLL_remove(head, tail, element)
Remove an element from a DLL.
List of arrays of message handlers.
GNUNET_SERVER_DisconnectCallback callback
Function to call.
void * callback_cls
Closure for callback.
struct NotifyList * next
This is a doubly linked list.
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
struct NotifyList * disconnect_notify_list_head
Head of linked list of functions to call on disconnects by clients.
struct NotifyList * disconnect_notify_list_tail
Tail of linked list of functions to call on disconnects by clients.
#define GNUNET_free(ptr)
Wrapper around free.

◆ GNUNET_SERVER_connect_notify_cancel()

void GNUNET_SERVER_connect_notify_cancel ( struct GNUNET_SERVER_Handle server,
GNUNET_SERVER_ConnectCallback  callback,
void *  callback_cls 
)

Ask the server to stop notifying us whenever a client disconnects.

Parameters
serverthe server manageing the clients
callbackfunction to call on disconnect
callback_clsclosure for callback

Definition at line 1459 of file tcp_server_legacy.c.

References NotifyList::callback, NotifyList::callback_cls, GNUNET_SERVER_Handle::connect_notify_list_head, GNUNET_SERVER_Handle::connect_notify_list_tail, GNUNET_break, GNUNET_CONTAINER_DLL_remove, GNUNET_free, and NotifyList::next.

1462 {
1463  struct NotifyList *pos;
1464 
1465  for (pos = server->connect_notify_list_head; NULL != pos; pos = pos->next)
1466  if ((pos->callback == callback) && (pos->callback_cls == callback_cls))
1467  break;
1468  if (NULL == pos)
1469  {
1470  GNUNET_break(0);
1471  return;
1472  }
1474  server->connect_notify_list_tail,
1475  pos);
1476  GNUNET_free(pos);
1477 }
#define GNUNET_CONTAINER_DLL_remove(head, tail, element)
Remove an element from a DLL.
struct NotifyList * connect_notify_list_head
Head of linked list of functions to call on connects by clients.
List of arrays of message handlers.
GNUNET_SERVER_DisconnectCallback callback
Function to call.
void * callback_cls
Closure for callback.
struct NotifyList * next
This is a doubly linked list.
#define GNUNET_break(cond)
Use this for internal assertion violations that are not fatal (can be handled) but should not occur...
struct NotifyList * connect_notify_list_tail
Tail of linked list of functions to call on connects by clients.
#define GNUNET_free(ptr)
Wrapper around free.

◆ GNUNET_SERVER_client_disconnect()

void GNUNET_SERVER_client_disconnect ( struct GNUNET_SERVER_Client client)

Ask the server to disconnect from the given client.

This is the same as returning GNUNET_SYSERR from a message handler, except that it allows dropping of a client even when not handling a message from that client.

Parameters
clientthe client to disconnect from

Definition at line 1489 of file tcp_server_legacy.c.

References NotifyList::callback, NotifyList::callback_cls, GNUNET_SERVER_Handle::clients_head, GNUNET_SERVER_Handle::clients_tail, GNUNET_SERVER_Client::connection, GNUNET_SERVER_TransmitHandle::cth, GNUNET_SERVER_Handle::disconnect_notify_list_head, GNUNET_CONNECTION_destroy(), GNUNET_CONNECTION_persist_(), GNUNET_CONNECTION_receive_cancel(), GNUNET_CONTAINER_DLL_remove, GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_NO, GNUNET_SCHEDULER_cancel(), GNUNET_SERVER_mst_destroy(), GNUNET_SERVER_notify_transmit_ready_cancel(), GNUNET_YES, GNUNET_SERVER_Client::in_process_client_buffer, LOG, GNUNET_SERVER_Client::mst, GNUNET_SERVER_Handle::mst_cls, GNUNET_SERVER_Handle::mst_destroy, NotifyList::next, GNUNET_SERVER_Client::persist, GNUNET_SERVER_Client::receive_pending, GNUNET_SERVER_Client::reference_count, GNUNET_SERVER_Client::restart_task, GNUNET_SERVER_Client::server, GNUNET_SERVER_Client::shutdown_now, test_monitor_clients(), GNUNET_SERVER_Client::th, and GNUNET_SERVER_Client::warn_task.

Referenced by client_message_tokenizer_callback(), GNUNET_SERVER_client_drop(), GNUNET_SERVER_destroy(), GNUNET_SERVER_receive_done(), process_incoming(), process_mst(), and tcp_plugin_disconnect_session().

1490 {
1491  struct GNUNET_SERVER_Handle *server = client->server;
1492  struct NotifyList *n;
1493 
1495  "Client is being disconnected from the server.\n");
1496  if (NULL != client->restart_task)
1497  {
1499  client->restart_task = NULL;
1500  }
1501  if (NULL != client->warn_task)
1502  {
1504  client->warn_task = NULL;
1505  }
1506  if (GNUNET_YES == client->receive_pending)
1507  {
1509  client->receive_pending = GNUNET_NO;
1510  }
1511  client->shutdown_now = GNUNET_YES;
1512  client->reference_count++; /* make sure nobody else clean up client... */
1513  if ((NULL != client->mst) &&
1514  (NULL != server))
1515  {
1517  server->clients_tail,
1518  client);
1519  if (NULL != server->mst_destroy)
1520  server->mst_destroy(server->mst_cls,
1521  client->mst);
1522  else
1523  GNUNET_SERVER_mst_destroy(client->mst);
1524  client->mst = NULL;
1525  for (n = server->disconnect_notify_list_head; NULL != n; n = n->next)
1526  n->callback(n->callback_cls,
1527  client);
1528  }
1529  client->reference_count--;
1530  if (client->reference_count > 0)
1531  {
1533  "RC of %p still positive, not destroying everything.\n",
1534  client);
1535  client->server = NULL;
1536  return;
1537  }
1538  if (GNUNET_YES == client->in_process_client_buffer)
1539  {
1541  "Still processing inputs of %p, not destroying everything.\n",
1542  client);
1543  return;
1544  }
1546  "RC of %p now zero, destroying everything.\n",
1547  client);
1548  if (GNUNET_YES == client->persist)
1550  if (NULL != client->th.cth)
1553  /* need to cancel again, as it might have been re-added
1554  in the meantime (i.e. during callbacks) */
1555  if (NULL != client->warn_task)
1556  {
1558  client->warn_task = NULL;
1559  }
1560  if (GNUNET_YES == client->receive_pending)
1561  {
1563  client->receive_pending = GNUNET_NO;
1564  }
1565  GNUNET_free(client);
1566  /* we might be in soft-shutdown, test if we're done */
1567  if (NULL != server)
1568  test_monitor_clients(server);
1569 }
#define GNUNET_CONTAINER_DLL_remove(head, tail, element)
Remove an element from a DLL.
void GNUNET_CONNECTION_persist_(struct GNUNET_CONNECTION_Handle *connection)
Set the persist option on this connection handle.
int in_process_client_buffer
Are we currently in the "process_client_buffer" function (and will hence restart the receive job on e...
List of arrays of message handlers.
struct GNUNET_SERVER_Client * clients_tail
Head of list of our current clients.
#define LOG(kind,...)
Definition: arm_api.c:33
GNUNET_SERVER_MstDestroyCallback mst_destroy
Alternative function to destroy a MST instance.
GNUNET_SERVER_DisconnectCallback callback
Function to call.
#define GNUNET_NO
Definition: gnunet_common.h:78
void * GNUNET_CONNECTION_receive_cancel(struct GNUNET_CONNECTION_Handle *connection)
Cancel receive job on the given connection.
void GNUNET_SERVER_mst_destroy(struct GNUNET_SERVER_MessageStreamTokenizer *mst)
Destroys a tokenizer.
int receive_pending
Are we currently trying to receive? (GNUNET_YES if we are, GNUNET_NO if we are not, GNUNET_SYSERR if data is already available in MST).
void * callback_cls
Closure for callback.
struct NotifyList * next
This is a doubly linked list.
struct GNUNET_CONNECTION_TransmitHandle * cth
Active connection transmission handle.
struct GNUNET_SERVER_TransmitHandle th
Transmission handle we return for this client from GNUNET_SERVER_notify_transmit_ready.
void GNUNET_SERVER_notify_transmit_ready_cancel(struct GNUNET_SERVER_TransmitHandle *th)
Abort transmission request.
struct NotifyList * disconnect_notify_list_head
Head of linked list of functions to call on disconnects by clients.
handle for a server
struct GNUNET_CONNECTION_Handle * connection
Client closure for callbacks.
int shutdown_now
We&#39;re about to close down this client.
unsigned int reference_count
Number of external entities with a reference to this client object.
void GNUNET_CONNECTION_destroy(struct GNUNET_CONNECTION_Handle *connection)
Close the connection and free associated resources.
int persist
Persist the file handle for this client no matter what happens, force the OS to close once the proces...
struct GNUNET_SCHEDULER_Task * warn_task
Task that warns about missing calls to GNUNET_SERVER_receive_done.
#define GNUNET_YES
Definition: gnunet_common.h:77
struct GNUNET_SERVER_Client * clients_head
Head of list of our current clients.
static void test_monitor_clients(struct GNUNET_SERVER_Handle *server)
Check if only &#39;monitor&#39; clients are left.
struct GNUNET_SERVER_Handle * server
Server that this client belongs to.
void * mst_cls
Closure for &#39;mst_&#39;-callbacks.
void * mst
Processing of incoming data.
struct GNUNET_SCHEDULER_Task * restart_task
ID of task used to restart processing.
#define GNUNET_free(ptr)
Wrapper around free.
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:956
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_SERVER_client_disable_corking()

int GNUNET_SERVER_client_disable_corking ( struct GNUNET_SERVER_Client client)

Disable the "CORK" feature for communication with the given client, forcing the OS to immediately flush the buffer on transmission instead of potentially buffering multiple messages.

Parameters
clienthandle to the client
Returns
GNUNET_OK on success

Definition at line 1581 of file tcp_server_legacy.c.

References GNUNET_SERVER_Client::connection, and GNUNET_CONNECTION_disable_corking().

1582 {
1584 }
int GNUNET_CONNECTION_disable_corking(struct GNUNET_CONNECTION_Handle *connection)
Disable the "CORK" feature for communication with the given connection, forcing the OS to immediately...
struct GNUNET_CONNECTION_Handle * connection
Client closure for callbacks.
Here is the call graph for this function:

◆ transmit_ready_callback_wrapper()

static size_t transmit_ready_callback_wrapper ( void *  cls,
size_t  size,
void *  buf 
)
static

Wrapper for transmission notification that calls the original callback and update the last activity time for our connection.

Parameters
clsthe struct GNUNET_SERVER_Client *
sizenumber of bytes we can transmit
bufwhere to copy the message
Returns
number of bytes actually transmitted

Definition at line 1597 of file tcp_server_legacy.c.

References GNUNET_SERVER_TransmitHandle::callback, GNUNET_SERVER_TransmitHandle::callback_cls, GNUNET_SERVER_TransmitHandle::cth, GNUNET_TIME_absolute_get(), GNUNET_SERVER_Client::last_activity, and GNUNET_SERVER_Client::th.

Referenced by GNUNET_SERVER_notify_transmit_ready().

1598 {
1599  struct GNUNET_SERVER_Client *client = cls;
1601 
1602  client->th.cth = NULL;
1603  callback = client->th.callback;
1604  client->th.callback = NULL;
1606  return callback(client->th.callback_cls, size, buf);
1607 }
struct GNUNET_TIME_Absolute last_activity
Last activity on this socket (used to time it out if reference_count == 0).
size_t(* GNUNET_CONNECTION_TransmitReadyNotify)(void *cls, size_t size, void *buf)
Function called to notify a client about the connection begin ready to queue more data...
struct GNUNET_CONNECTION_TransmitHandle * cth
Active connection transmission handle.
struct GNUNET_SERVER_TransmitHandle th
Transmission handle we return for this client from GNUNET_SERVER_notify_transmit_ready.
static char buf[2048]
struct GNUNET_TIME_Absolute GNUNET_TIME_absolute_get(void)
Get the current time.
Definition: time.c:118
static unsigned int size
Size of the "table".
Definition: peer.c:66
GNUNET_CONNECTION_TransmitReadyNotify callback
Function to call to get the message.
void * callback_cls
Closure for callback.
handle for a client of the server
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_SERVER_notify_transmit_ready()

struct GNUNET_SERVER_TransmitHandle* GNUNET_SERVER_notify_transmit_ready ( struct GNUNET_SERVER_Client client,
size_t  size,
struct GNUNET_TIME_Relative  timeout,
GNUNET_CONNECTION_TransmitReadyNotify  callback,
void *  callback_cls 
)

Notify us when the server has enough space to transmit a message of the given size to the given client.

Parameters
clientclient to transmit message to
sizerequested amount of buffer space
timeoutafter how long should we give up (and call notify with buf NULL and size 0)?
callbackfunction to call when space is available
callback_clsclosure for callback
Returns
non-NULL if the notify callback was queued; can be used to cancel the request using GNUNET_SERVER_notify_transmit_ready_cancel(). NULL if we are already going to notify someone else (busy)

Definition at line 1626 of file tcp_server_legacy.c.

References GNUNET_SERVER_TransmitHandle::callback, GNUNET_SERVER_TransmitHandle::callback_cls, GNUNET_SERVER_Client::connection, GNUNET_SERVER_TransmitHandle::cth, GNUNET_CONNECTION_notify_transmit_ready(), GNUNET_SERVER_Client::th, and transmit_ready_callback_wrapper().

Referenced by handle_test(), and process_pending_messages().

1631 {
1632  if (NULL != client->th.callback)
1633  return NULL;
1634  client->th.callback_cls = callback_cls;
1635  client->th.callback = callback;
1637  timeout,
1639  client);
1640  return &client->th;
1641 }
struct GNUNET_CONNECTION_TransmitHandle * cth
Active connection transmission handle.
struct GNUNET_SERVER_TransmitHandle th
Transmission handle we return for this client from GNUNET_SERVER_notify_transmit_ready.
struct GNUNET_CONNECTION_Handle * connection
Client closure for callbacks.
static unsigned int size
Size of the "table".
Definition: peer.c:66
GNUNET_CONNECTION_TransmitReadyNotify callback
Function to call to get the message.
struct GNUNET_CONNECTION_TransmitHandle * GNUNET_CONNECTION_notify_transmit_ready(struct GNUNET_CONNECTION_Handle *connection, size_t size, struct GNUNET_TIME_Relative timeout, GNUNET_CONNECTION_TransmitReadyNotify notify, void *notify_cls)
Ask the connection to call us once the specified number of bytes are free in the transmission buffer...
void * callback_cls
Closure for callback.
static size_t transmit_ready_callback_wrapper(void *cls, size_t size, void *buf)
Wrapper for transmission notification that calls the original callback and update the last activity t...
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_SERVER_notify_transmit_ready_cancel()

void GNUNET_SERVER_notify_transmit_ready_cancel ( struct GNUNET_SERVER_TransmitHandle th)

Abort transmission request.

Parameters
threquest to abort

Definition at line 1650 of file tcp_server_legacy.c.

References GNUNET_SERVER_TransmitHandle::callback, GNUNET_SERVER_TransmitHandle::cth, and GNUNET_CONNECTION_notify_transmit_ready_cancel().

Referenced by GNUNET_SERVER_client_disconnect(), and tcp_plugin_disconnect_session().

1651 {
1653  th->cth = NULL;
1654  th->callback = NULL;
1655 }
void GNUNET_CONNECTION_notify_transmit_ready_cancel(struct GNUNET_CONNECTION_TransmitHandle *th)
Cancel the specified transmission-ready notification.
struct GNUNET_CONNECTION_TransmitHandle * cth
Active connection transmission handle.
GNUNET_CONNECTION_TransmitReadyNotify callback
Function to call to get the message.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ GNUNET_SERVER_client_persist_()

void GNUNET_SERVER_client_persist_ ( struct GNUNET_SERVER_Client client)

Set the persistent flag on this client, used to setup client connection to only be killed when the service it's connected to is actually dead.

Parameters
clientthe client to set the persistent flag on

Definition at line 1665 of file tcp_server_legacy.c.

References GNUNET_YES, and GNUNET_SERVER_Client::persist.

1666 {
1667  client->persist = GNUNET_YES;
1668 }
int persist
Persist the file handle for this client no matter what happens, force the OS to close once the proces...
#define GNUNET_YES
Definition: gnunet_common.h:77

◆ GNUNET_SERVER_receive_done()

void GNUNET_SERVER_receive_done ( struct GNUNET_SERVER_Client client,
int  success 
)

Resume receiving from this client, we are done processing the current request.

This function must be called from within each GNUNET_SERVER_MessageCallback (or its respective continuations).

Parameters
clientclient we were processing a message of
successGNUNET_OK to keep the connection open and continue to receive GNUNET_NO to close the connection (normal behavior) GNUNET_SYSERR to close the connection (signal serious error)

Definition at line 1684 of file tcp_server_legacy.c.

References GNUNET_assert, GNUNET_ERROR_TYPE_DEBUG, GNUNET_OK, GNUNET_SCHEDULER_add_now(), GNUNET_SCHEDULER_cancel(), GNUNET_SERVER_client_disconnect(), GNUNET_YES, GNUNET_SERVER_Client::in_process_client_buffer, LOG, GNUNET_SERVER_Client::reference_count, restart_processing(), GNUNET_SERVER_Client::restart_task, GNUNET_SERVER_Client::server, GNUNET_SERVER_Client::shutdown_now, GNUNET_SERVER_Client::suspended, and GNUNET_SERVER_Client::warn_task.

Referenced by delayed_done(), handle_tcp_data(), handle_tcp_nat_probe(), handle_tcp_welcome(), handle_test(), and write_test().

1686 {
1687  if (NULL == client)
1688  return;
1689  GNUNET_assert(client->suspended > 0);
1690  client->suspended--;
1691  if (GNUNET_OK != success)
1692  {
1694  "GNUNET_SERVER_receive_done called with failure indication\n");
1695  if ((client->reference_count > 0) || (client->suspended > 0))
1696  client->shutdown_now = GNUNET_YES;
1697  else
1699  return;
1700  }
1701  if (client->suspended > 0)
1702  {
1704  "GNUNET_SERVER_receive_done called, but more clients pending\n");
1705  return;
1706  }
1707  if (NULL != client->warn_task)
1708  {
1710  client->warn_task = NULL;
1711  }
1712  if (GNUNET_YES == client->in_process_client_buffer)
1713  {
1715  "GNUNET_SERVER_receive_done called while still in processing loop\n");
1716  return;
1717  }
1718  if ((NULL == client->server) || (GNUNET_YES == client->shutdown_now))
1719  {
1721  return;
1722  }
1724  "GNUNET_SERVER_receive_done causes restart in reading from the socket\n");
1725  GNUNET_assert(NULL == client->restart_task);
1727  client);
1728 }
int in_process_client_buffer
Are we currently in the "process_client_buffer" function (and will hence restart the receive job on e...
#define LOG(kind,...)
Definition: arm_api.c:33
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
#define GNUNET_OK
Named constants for return values.
Definition: gnunet_common.h:75
struct GNUNET_SCHEDULER_Task * GNUNET_SCHEDULER_add_now(GNUNET_SCHEDULER_TaskCallback task, void *task_cls)
Schedule a new task to be run as soon as possible.
Definition: scheduler.c:1264
int shutdown_now
We&#39;re about to close down this client.
unsigned int reference_count
Number of external entities with a reference to this client object.
void GNUNET_SERVER_client_disconnect(struct GNUNET_SERVER_Client *client)
Ask the server to disconnect from the given client.
static void restart_processing(void *cls)
Task run to start again receiving from the network and process requests.
struct GNUNET_SCHEDULER_Task * warn_task
Task that warns about missing calls to GNUNET_SERVER_receive_done.
#define GNUNET_YES
Definition: gnunet_common.h:77
struct GNUNET_SERVER_Handle * server
Server that this client belongs to.
struct GNUNET_SCHEDULER_Task * restart_task
ID of task used to restart processing.
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:956
unsigned int suspended
Was processing if incoming messages suspended while we were still processing data already received...
Here is the call graph for this function:
Here is the caller graph for this function: