afw_service.h

Go to the documentation of this file.

// See the 'COPYING' file in the project root for licensing information.
/*
 * Adaptive Framework Service Support
 *
 * Copyright (c) 2010-2023 Clemson University
 *
 */
 
#ifndef __AFW_SERVICE_H__
#define __AFW_SERVICE_H__
 
#include "afw_interface.h"
 
AFW_BEGIN_DECLARES
 
typedef void (*afw_service_create_cede_p_t)(
    afw_service_t *service,
    void *data,
    const afw_object_t *properties,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
struct afw_service_s {
 
    const afw_pool_t *p;
 
    afw_utf8_t service_id;
 
    const afw_utf8_t *type;
 
    const afw_service_type_t *service_type;
 
    const afw_utf8_t *conf_id;
 
    const afw_utf8_t *conf_subtype;
 
    const afw_utf8_t *source_location;
 
    const afw_object_t *properties;
 
    const afw_utf8_t *conf_source_location;
 
    afw_service_status_t status;
 
    afw_dateTime_t start_time;
 
    const afw_utf8_t *status_message;
 
    const afw_utf8_t *status_debug;
 
    afw_thread_mutex_t *mutex;
 
    void *data;
 
    afw_boolean_t has_service_conf;
};
 
 
AFW_DECLARE(void)
afw_service_context_prepare(
    const afw_service_t *service,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(const afw_utf8_t *)
afw_service_startup_as_utf8(afw_service_startup_t startup);
 
 
AFW_DECLARE(const afw_value_t *)
afw_service_startup_as_value(afw_service_startup_t startup);
 
 
AFW_DECLARE(const afw_utf8_t *)
afw_service_startup_description(afw_service_startup_t startup);
 
 
AFW_DECLARE(const afw_value_t *)
afw_service_startup_description_as_value(afw_service_startup_t startup);
 
 
AFW_DECLARE(afw_service_startup_t)
afw_service_startup_as_enum(const afw_utf8_t *s);
 
 
AFW_DECLARE(const afw_utf8_t *)
afw_service_status_as_utf8(afw_service_status_t status);
 
 
AFW_DECLARE(const afw_value_t *)
afw_service_status_as_value(afw_service_status_t status);
 
 
AFW_DECLARE(const afw_utf8_t *)
afw_service_status_description(afw_service_status_t status);
 
 
AFW_DECLARE(const afw_value_t *)
afw_service_status_description_as_value(afw_service_status_t status);
 
 
AFW_DECLARE(afw_service_status_t)
afw_service_status_as_enum(const afw_utf8_t *s);
 
 
AFW_DECLARE(const afw_object_t *)
afw_service_get_object(
    const afw_utf8_t *service_id,
    const afw_pool_t *p,
    afw_xctx_t *xctx);
 
 
AFW_DECLARE(void)
afw_service_start_using_AdaptiveConf_cede_p(
    const afw_object_t *properties,
    const afw_utf8_t *source_location,
    const afw_pool_t *p, afw_xctx_t *xctx);
 
 
AFW_DECLARE(void)
afw_service_start(
    const afw_utf8_t *service_id,
    afw_boolean_t manual_start,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(void)
afw_service_stop(
    const afw_utf8_t *service_id,
    afw_xctx_t *xctx);
 
 
 
AFW_DECLARE(void)
afw_service_restart(
    const afw_utf8_t *service_id,
    afw_xctx_t *xctx);
 
 
 
AFW_END_DECLARES
 
#endif /* __AFW_SERVICE_H__ */