sol_platform_linux_micro_module Struct Reference

struct that describes the Linux micro module More...

#include <sol-platform-linux-micro.h>

Data Fields
uint16_t	api_version
	The API version. More...
int(*	init )(const struct sol_platform_linux_micro_module *module, const char *service)
	Callback used to initialize the module. More...
const char *	name
	The module name. More...
int(*	restart )(const struct sol_platform_linux_micro_module *module, const char *service)
	Callback used to restart the service. More...
void(*	shutdown )(const struct sol_platform_linux_micro_module *module, const char *service)
	Callback used to shutdown the module. More...
int(*	start )(const struct sol_platform_linux_micro_module *module, const char *service)
	Callback used to start the service. More...
int(*	start_monitor )(const struct sol_platform_linux_micro_module *module, const char *service)
	Callback used to start a service monitor. More...
int(*	stop )(const struct sol_platform_linux_micro_module *module, const char *service, bool force_immediate)
	Callback used to stop the service. More...
int(*	stop_monitor )(const struct sol_platform_linux_micro_module *module, const char *service)
	Callback used to stop a service monitor. More...

Detailed Description

struct that describes the Linux micro module

See Also

SOL_PLATFORM_LINUX_MICRO_MODULE()

Field Documentation

uint16_t sol_platform_linux_micro_module::api_version

The API version.

int(* sol_platform_linux_micro_module::init)(const struct sol_platform_linux_micro_module *module, const char *service)

Callback used to initialize the module.

Parameters

module	The module handle
service	The service name

Returns

0 on success -errno on error.

Note

It is called once.

const char* sol_platform_linux_micro_module::name

The module name.

int(* sol_platform_linux_micro_module::restart)(const struct sol_platform_linux_micro_module *module, const char *service)

Callback used to restart the service.

Parameters

module	The module handle
service	The service name

Returns

0 on success -errno on error.

void(* sol_platform_linux_micro_module::shutdown)(const struct sol_platform_linux_micro_module *module, const char *service)

Callback used to shutdown the module.

Parameters

module	The module handle
service	The service name

Note

It is called once.

int(* sol_platform_linux_micro_module::start)(const struct sol_platform_linux_micro_module *module, const char *service)

Callback used to start the service.

Parameters

module	The module handle
service	The service name

Returns

0 on success -errno on error.

int(* sol_platform_linux_micro_module::start_monitor)(const struct sol_platform_linux_micro_module *module, const char *service)

Callback used to start a service monitor.

Parameters

module	The module handle
service	The service name

Returns

0 on success -errno on error.

int(* sol_platform_linux_micro_module::stop)(const struct sol_platform_linux_micro_module *module, const char *service, bool force_immediate)

Callback used to stop the service.

Parameters

module	The module handle
service	The service name

Returns

0 on success -errno on error.

int(* sol_platform_linux_micro_module::stop_monitor)(const struct sol_platform_linux_micro_module *module, const char *service)

Callback used to stop a service monitor.

Parameters

module	The module handle
service	The service name

Returns

0 on success -errno on error.

---

The documentation for this struct was generated from the following file:

• src/lib/common/include/sol-platform-linux-micro.h