gnunet_arm_service.h

Go to the documentation of this file.

/*
      This file is part of GNUnet
      Copyright (C) 2009, 2016 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
 */
 
#ifndef GNUNET_ARM_SERVICE_H
#define GNUNET_ARM_SERVICE_H
 
#ifdef __cplusplus
extern "C"
{
#if 0                           /* keep Emacsens' auto-indent happy */
}
#endif
#endif
 
 
#include "gnunet_util_lib.h"
 
#define GNUNET_ARM_VERSION 0x00000003
 
 
enum GNUNET_ARM_RequestStatus
{
  GNUNET_ARM_REQUEST_SENT_OK = 0,
 
  GNUNET_ARM_REQUEST_DISCONNECTED = 2
};
 
 
enum GNUNET_ARM_ServiceMonitorStatus
{
  GNUNET_ARM_SERVICE_MONITORING_STARTED = 0,
 
  GNUNET_ARM_SERVICE_STOPPED = 1,
 
  GNUNET_ARM_SERVICE_STARTING = 2,
 
  GNUNET_ARM_SERVICE_STOPPING = 3
};
 
 
enum GNUNET_ARM_Result
{
  GNUNET_ARM_RESULT_STOPPED = 0,
 
  GNUNET_ARM_RESULT_STOPPING = 1,
 
  GNUNET_ARM_RESULT_STARTING = 2,
 
  GNUNET_ARM_RESULT_IS_STARTING_ALREADY = 3,
 
  GNUNET_ARM_RESULT_IS_STOPPING_ALREADY = 4,
 
  GNUNET_ARM_RESULT_IS_STARTED_ALREADY = 5,
 
  GNUNET_ARM_RESULT_IS_STOPPED_ALREADY = 6,
 
  GNUNET_ARM_RESULT_IS_NOT_KNOWN = 7,
 
  GNUNET_ARM_RESULT_START_FAILED = 8,
 
  GNUNET_ARM_RESULT_IN_SHUTDOWN = 9
};
 
 
enum GNUNET_ARM_ServiceStatus
{
  GNUNET_ARM_SERVICE_STATUS_STOPPED = 0,
 
  GNUNET_ARM_SERVICE_STATUS_STARTED = 1,
 
  GNUNET_ARM_SERVICE_STATUS_FAILED = 2,
 
  GNUNET_ARM_SERVICE_STATUS_FINISHED = 3,
 
  GNUNET_ARM_SERVICE_STATUS_STOPPING = 4,
};
 
 
struct GNUNET_ARM_ServiceInfo
{
  enum GNUNET_ARM_ServiceStatus status;
 
  const char *name;
 
  const char *binary;
 
  struct GNUNET_TIME_Absolute restart_at;
 
  struct GNUNET_TIME_Absolute last_started_at;
 
  int last_exit_status;
};
 
 
struct GNUNET_ARM_Handle;
 
struct GNUNET_ARM_Operation;
 
 
typedef void
(*GNUNET_ARM_ConnectionStatusCallback) (void *cls,
                                        int connected);
 
 
typedef void
(*GNUNET_ARM_ResultCallback) (void *cls,
                              enum GNUNET_ARM_RequestStatus rs,
                              enum GNUNET_ARM_Result result);
 
 
typedef void
(*GNUNET_ARM_ServiceListCallback) (void *cls,
                                   enum GNUNET_ARM_RequestStatus rs,
                                   unsigned int count,
                                   const struct GNUNET_ARM_ServiceInfo *list);
 
 
struct GNUNET_ARM_Handle *
GNUNET_ARM_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
                    GNUNET_ARM_ConnectionStatusCallback conn_status,
                    void *conn_status_cls);
 
 
void
GNUNET_ARM_disconnect (struct GNUNET_ARM_Handle *h);
 
 
void
GNUNET_ARM_operation_cancel (struct GNUNET_ARM_Operation *op);
 
 
struct GNUNET_ARM_Operation *
GNUNET_ARM_request_service_list (struct GNUNET_ARM_Handle *h,
                                 GNUNET_ARM_ServiceListCallback cont,
                                 void *cont_cls);
 
 
struct GNUNET_ARM_Operation *
GNUNET_ARM_request_service_stop (struct GNUNET_ARM_Handle *h,
                                 const char *service_name,
                                 GNUNET_ARM_ResultCallback cont,
                                 void *cont_cls);
 
 
struct GNUNET_ARM_Operation *
GNUNET_ARM_request_service_start (struct GNUNET_ARM_Handle *h,
                                  const char *service_name,
                                  enum GNUNET_OS_InheritStdioFlags
                                  std_inheritance,
                                  GNUNET_ARM_ResultCallback cont,
                                  void *cont_cls);
 
 
struct GNUNET_ARM_MonitorHandle;
 
 
typedef void
(*GNUNET_ARM_ServiceMonitorCallback) (void *cls,
                                      const char *service,
                                      enum GNUNET_ARM_ServiceMonitorStatus
                                      status);
 
 
struct GNUNET_ARM_MonitorHandle *
GNUNET_ARM_monitor_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
                          GNUNET_ARM_ServiceMonitorCallback cont,
                          void *cont_cls);
 
 
void
GNUNET_ARM_monitor_stop (struct GNUNET_ARM_MonitorHandle *h);
 
#if 0                           /* keep Emacsens' auto-indent happy */
{
#endif
#ifdef __cplusplus
}
#endif
 
#endif
  /* end of group */