src/util/service_new.c

   1 /*
   2      This file is part of GNUnet.
   3      Copyright (C) 2016 GNUnet e.V.
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 3, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  18      Boston, MA 02110-1301, USA.
  19 */
  20
  21 /**
  22  * @file util/service_new.c
  23  * @brief functions related to starting services (redesign)
  24  * @author Christian Grothoff
  25  */
  26 #include "platform.h"
  27 #include "gnunet_util_lib.h"
  28 #include "gnunet_protocols.h"
  29 #include "gnunet_constants.h"
  30 #include "gnunet_resolver_service.h"
  31
  32
  33 /**
  34  * Handle to a service.
  35  */
  36 struct GNUNET_SERVICE_Handle
  37 {
  38 };
  39
  40
  41 /**
  42  * Handle to a client that is connected to a service.
  43  */
  44 struct GNUNET_SERVICE_Client
  45 {
  46   /**
  47    * Task that warns about missing calls to
  48    * #GNUNET_SERVICE_client_continue().
  49    */
  50   struct GNUNET_SCHEDULER_Task *warn_task;
  51
  52 };
  53
  54
  55 /**
  56  * Creates the "main" function for a GNUnet service.  You
  57  * should almost always use the #GNUNET_SERVICE_MAIN macro
  58  * instead of calling this function directly (except
  59  * for ARM, which should call this function directly).
  60  *
  61  * The function will launch the service with the name @a service_name
  62  * using the @a service_options to configure its shutdown
  63  * behavior. Once the service is ready, the @a init_cb will be called
  64  * for service-specific initialization.  @a init_cb will be given the
  65  * service handler which can be used to control the service's
  66  * availability.  When clients connect or disconnect, the respective
  67  * @a connect_cb or @a disconnect_cb functions will be called. For
  68  * messages received from the clients, the respective @a handlers will
  69  * be invoked; for the closure of the handlers we use the return value
  70  * from the @a connect_cb invocation of the respective client.
  71  *
  72  * Each handler MUST call #GNUNET_SERVICE_client_continue() after each
  73  * message to receive further messages from this client.  If
  74  * #GNUNET_SERVICE_client_continue() is not called within a short
  75  * time, a warning will be logged. If delays are expected, services
  76  * should call #GNUNET_SERVICE_client_disable_continue_warning() to
  77  * disable the warning.
  78  *
  79  * Clients sending invalid messages (based on @a handlers) will be
  80  * dropped. Additionally, clients can be dropped at any time using
  81  * #GNUNET_SERVICE_client_drop().
  82  *
  83  * @param argc number of command-line arguments in @a argv
  84  * @param argv array of command-line arguments
  85  * @param service_name name of the service to run
  86  * @param options options controlling shutdown of the service
  87  * @param service_init_cb function to call once the service is ready
  88  * @param connect_cb function to call whenever a client connects
  89  * @param disconnect_cb function to call whenever a client disconnects
  90  * @param cls closure argument for @a service_init_cb, @a connect_cb and @a disconnect_cb
  91  * @param handlers NULL-terminated array of message handlers for the service,
  92  *                 the closure will be set to the value returned by
  93  *                 the @a connect_cb for the respective connection
  94  * @return 0 on success, non-zero on error
  95  */
  96 int
  97 GNUNET_SERVICE_ruN_ (int argc,
  98                      char *const *argv,
  99                      const char *service_name,
 100                      enum GNUNET_SERVICE_Options options,
 101                      GNUNET_SERVICE_InitCallback service_init_cb,
 102                      GNUNET_SERVICE_ConnectHandler connect_cb,
 103                      GNUNET_SERVICE_DisconnectHandler disconnect_cb,
 104                      void *cls,
 105                      const struct GNUNET_MQ_MessageHandler *handlers)
 106 {
 107   GNUNET_break (0); // not implemented
 108   return 1;
 109 }
 110
 111
 112 /**
 113  * Suspend accepting connections from the listen socket temporarily.
 114  * Resume activity using #GNUNET_SERVICE_resume.
 115  *
 116  * @param sh service to stop accepting connections.
 117  */
 118 void
 119 GNUNET_SERVICE_suspend (struct GNUNET_SERVICE_Handle *sh)
 120 {
 121   GNUNET_break (0); // not implemented
 122 }
 123
 124
 125 /**
 126  * Resume accepting connections from the listen socket.
 127  *
 128  * @param sh service to resume accepting connections.
 129  */
 130 void
 131 GNUNET_SERVICE_resume (struct GNUNET_SERVICE_Handle *sh)
 132 {
 133   GNUNET_break (0); // not implemented
 134 }
 135
 136
 137 /**
 138  * Continue receiving further messages from the given client.
 139  * Must be called after each message received.
 140  *
 141  * @param c the client to continue receiving from
 142  */
 143 void
 144 GNUNET_SERVICE_client_continue (struct GNUNET_SERVICE_Client *c)
 145 {
 146   GNUNET_break (0); // not implemented
 147 }
 148
 149
 150 /**
 151  * Disable the warning the server issues if a message is not
 152  * acknowledged in a timely fashion.  Use this call if a client is
 153  * intentionally delayed for a while.  Only applies to the current
 154  * message.
 155  *
 156  * @param c client for which to disable the warning
 157  */
 158 void
 159 GNUNET_SERVICE_client_disable_continue_warning (struct GNUNET_SERVICE_Client *c)
 160 {
 161   GNUNET_break (NULL != c->warn_task);
 162   if (NULL != c->warn_task)
 163   {
 164     GNUNET_SCHEDULER_cancel (c->warn_task);
 165     c->warn_task = NULL;
 166   }
 167 }
 168
 169
 170 /**
 171  * Ask the server to disconnect from the given client.  This is the
 172  * same as returning #GNUNET_SYSERR within the check procedure when
 173  * handling a message, wexcept that it allows dropping of a client even
 174  * when not handling a message from that client.  The `disconnect_cb`
 175  * will be called on @a c even if the application closes the connection
 176  * using this function.
 177  *
 178  * @param c client to disconnect now
 179  */
 180 void
 181 GNUNET_SERVICE_client_drop (struct GNUNET_SERVICE_Client *c)
 182 {
 183   GNUNET_break (0); // not implemented
 184 }
 185
 186
 187 /**
 188  * Stop the listen socket and get ready to shutdown the server once
 189  * only clients marked using #GNUNET_SERVER_client_mark_monitor are
 190  * left.
 191  *
 192  * @param sh server to stop listening on
 193  */
 194 void
 195 GNUNET_SERVICE_stop_listening (struct GNUNET_SERVICE_Handle *sh)
 196 {
 197   GNUNET_break (0); // not implemented
 198 }
 199
 200
 201 /**
 202  * Set the 'monitor' flag on this client.  Clients which have been
 203  * marked as 'monitors' won't prevent the server from shutting down
 204  * once #GNUNET_SERVICE_stop_listening() has been invoked.  The idea is
 205  * that for "normal" clients we likely want to allow them to process
 206  * their requests; however, monitor-clients are likely to 'never'
 207  * disconnect during shutdown and thus will not be considered when
 208  * determining if the server should continue to exist after
 209  * shutdown has been triggered.
 210  *
 211  * @param c client to mark as a monitor
 212  */
 213 void
 214 GNUNET_SERVICE_client_mark_monitor (struct GNUNET_SERVICE_Client *c)
 215 {
 216   GNUNET_break (0); // not implemented
 217 }
 218
 219
 220 /**
 221  * Set the persist option on this client.  Indicates that the
 222  * underlying socket or fd should never really be closed.  Used for
 223  * indicating process death.
 224  *
 225  * @param c client to persist the socket (never to be closed)
 226  */
 227 void
 228 GNUNET_SERVICE_client_persist (struct GNUNET_SERVICE_Client *c)
 229 {
 230   GNUNET_break (0); // not implemented
 231 }
 232
 233
 234
 235 /* end of service_new.c */