gnunet_service_lib.h

Go to the documentation of this file.

/*
     This file is part of GNUnet.
     Copyright (C) 2009-2013, 2016, 2017 GNUnet e.V.
 
     GNUnet is free software: you can redistribute it and/or modify it
     under the terms of the GNU Affero General Public License as published
     by the Free Software Foundation, either version 3 of the License,
     or (at your option) any later version.
 
     GNUnet is distributed in the hope that it will be useful, but
     WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
     Affero General Public License for more details.
 
     You should have received a copy of the GNU Affero General Public License
     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
     SPDX-License-Identifier: AGPL3.0-or-later
 */
 
 
#if ! defined (__GNUNET_UTIL_LIB_H_INSIDE__)
#error "Only <gnunet_util_lib.h> can be included directly."
#endif
 
#ifndef GNUNET_SERVICE_LIB_H
#define GNUNET_SERVICE_LIB_H
 
#ifdef __cplusplus
extern "C"
{
#if 0                           /* keep Emacsens' auto-indent happy */
}
#endif
#endif
 
#include "gnunet_util_lib.h"
#include "gnunet_configuration_lib.h"
 
 
enum GNUNET_SERVICE_Options
{
  GNUNET_SERVICE_OPTION_NONE = 0,
 
  GNUNET_SERVICE_OPTION_MANUAL_SHUTDOWN = 1,
 
  GNUNET_SERVICE_OPTION_SOFT_SHUTDOWN = 2,
 
  GNUNET_SERVICE_OPTION_SHUTDOWN_BITMASK = 3,
 
  GNUNET_SERVICE_OPTION_CLOSE_LSOCKS = 4
};
 
 
/* **************** NEW SERVICE API ********************** */
 
struct GNUNET_SERVICE_Handle;
 
 
struct GNUNET_SERVICE_Client;
 
 
typedef void
(*GNUNET_SERVICE_InitCallback)(void *cls,
                               const struct GNUNET_CONFIGURATION_Handle *cfg,
                               struct GNUNET_SERVICE_Handle *sh);
 
 
typedef void *
(*GNUNET_SERVICE_ConnectHandler)(void *cls,
                                 struct GNUNET_SERVICE_Client *c,
                                 struct GNUNET_MQ_Handle *mq);
 
 
typedef void
(*GNUNET_SERVICE_DisconnectHandler)(void *cls,
                                    struct GNUNET_SERVICE_Client *c,
                                    void *internal_cls);
 
 
struct GNUNET_SERVICE_Handle *
GNUNET_SERVICE_start (const struct GNUNET_OS_ProjectData *pd,
                      const char *service_name,
                      const struct GNUNET_CONFIGURATION_Handle *cfg,
                      GNUNET_SERVICE_ConnectHandler connect_cb,
                      GNUNET_SERVICE_DisconnectHandler disconnect_cb,
                      void *cls,
                      const struct GNUNET_MQ_MessageHandler *handlers);
 
 
void
GNUNET_SERVICE_stop (struct GNUNET_SERVICE_Handle *srv);
 
int
GNUNET_SERVICE_run_ (const struct GNUNET_OS_ProjectData *pd,
                     int argc,
                     char *const *argv,
                     const char *service_name,
                     enum GNUNET_SERVICE_Options options,
                     GNUNET_SERVICE_InitCallback service_init_cb,
                     GNUNET_SERVICE_ConnectHandler connect_cb,
                     GNUNET_SERVICE_DisconnectHandler disconnect_cb,
                     void *cls,
                     const struct GNUNET_MQ_MessageHandler *handlers);
 
 
int
GNUNET_SERVICE_register_ (
  const struct GNUNET_OS_ProjectData *pd,
  const char *service_name,
  enum GNUNET_SERVICE_Options options,
  GNUNET_SERVICE_InitCallback service_init_cb,
  GNUNET_SERVICE_ConnectHandler connect_cb,
  GNUNET_SERVICE_DisconnectHandler disconnect_cb,
  void *cls,
  const struct GNUNET_MQ_MessageHandler *handlers);
 
 
#ifndef HAVE_GNUNET_MONOLITH
#define GNUNET_SERVICE_MAIN(pd, service_name, service_options, init_cb,  \
                            connect_cb, \
                            disconnect_cb, cls, ...) \
        int \
        main (int argc, \
              char *const *argv) \
        { \
          struct GNUNET_MQ_MessageHandler mh[] = { \
            __VA_ARGS__ \
          };                        \
          return GNUNET_SERVICE_run_ (pd, \
                                      argc, \
                                      argv, \
                                      service_name, \
                                      service_options, \
                                      init_cb, \
                                      connect_cb, \
                                      disconnect_cb, \
                                      cls, \
                                      mh); \
        }
#else
#define GNUNET_SERVICE_MAIN(pd, service_name, service_options, init_cb, \
                            connect_cb, \
                            disconnect_cb, cls, ...) \
        static int __attribute__ ((constructor)) \
        init (void) \
        { \
          struct GNUNET_MQ_MessageHandler mh[] = { \
            __VA_ARGS__ \
          };                        \
          return GNUNET_SERVICE_register_ (pd, \
                                           service_name,    \
                                           service_options, \
                                           init_cb, \
                                           connect_cb, \
                                           disconnect_cb, \
                                           cls, \
                                           mh); \
        }
#endif
 
void
GNUNET_SERVICE_main (const struct GNUNET_OS_ProjectData *pd,
                     int argc,
                     char *const *argv,
                     struct GNUNET_CONFIGURATION_Handle *cfg,
                     enum GNUNET_GenericReturnValue with_scheduler);
 
void
GNUNET_SERVICE_suspend (struct GNUNET_SERVICE_Handle *sh);
 
 
void
GNUNET_SERVICE_resume (struct GNUNET_SERVICE_Handle *sh);
 
 
void
GNUNET_SERVICE_client_continue (struct GNUNET_SERVICE_Client *c);
 
 
struct GNUNET_MQ_Handle *
GNUNET_SERVICE_client_get_mq (struct GNUNET_SERVICE_Client *c);
 
 
void
GNUNET_SERVICE_client_disable_continue_warning (
  struct GNUNET_SERVICE_Client *c);
 
 
void
GNUNET_SERVICE_client_drop (struct GNUNET_SERVICE_Client *c);
 
 
void
GNUNET_SERVICE_shutdown (struct GNUNET_SERVICE_Handle *sh);
 
 
void
GNUNET_SERVICE_client_mark_monitor (struct GNUNET_SERVICE_Client *c);
 
 
void
GNUNET_SERVICE_client_persist (struct GNUNET_SERVICE_Client *c);
 
 
#if 0                           /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
 
/* ifndef GNUNET_SERVICE_LIB_H */
#endif
  /* end of group service */
 /* end of group addition to networking*/
 /* end of group addition to libgnunetutil */
 
/* end of gnunet_service_lib.h */