XROAD
Public Attributes | List of all members
xroad_process_iface_s Struct Reference

#include <xroad_process.h>

Public Attributes

process_t *(* create )(int32_t, char *[])
 
void(* destroy )(process_t *)
 
void(* start )(process_t *)
 
void(* stop )(process_t *)
 
void(* activate )(process_t *)
 
void(* deactivate )(process_t *)
 
void(* shutdown )(process_t *)
 
void(* on_node_object )(process_t *, void *, xroad_node_id_t)
 
xroad_errno_t(* reconfig )(process_t *)
 
void(* date_changed )(process_t *)
 
void(* reset )(process_t *, void *reset_obj)
 
int32_t(* enter_loop )(process_t *)
 
void(* print_help )()
 

Detailed Description

process interface

Member Data Documentation

◆ activate

void(* xroad_process_iface_s::activate) (process_t *)

fired at process activation. optional.

Parameters
[in]-process instance to activate

◆ create

process_t*(* xroad_process_iface_s::create) (int32_t, char *[])

fired at process creation. required.

Parameters
[in]-argv
[in]-argc
Returns
process instance

◆ date_changed

void(* xroad_process_iface_s::date_changed) (process_t *)

fired at date changed. optional. optional.

Parameters
[in]-process instance

◆ deactivate

void(* xroad_process_iface_s::deactivate) (process_t *)

fired at process deactivation. optional.

Parameters
[in]-process instalce to deactivate

◆ enter_loop

int32_t(* xroad_process_iface_s::enter_loop) (process_t *)

fired each time process enter into loop. required.

Parameters
[in]-process instance
Returns
0 - process leaves loop successfully <0 - process leaves loop with error >0 - continue to work

◆ on_node_object

void(* xroad_process_iface_s::on_node_object) (process_t *, void *, xroad_node_id_t)

fired at new object received. required.

Parameters
[in]-process instance
[in]-received object
[in]-source node id

◆ print_help

void(* xroad_process_iface_s::print_help) ()

print process specific flags to console

Parameters
[in]-process instance

◆ reconfig

xroad_errno_t(* xroad_process_iface_s::reconfig) (process_t *)

fired at process reconfiguration. optional.

Parameters
[in]-process to reconfigure
Returns
XROAD_OK - process reconfigured, else - failed

◆ reset

void(* xroad_process_iface_s::reset) (process_t *, void *reset_obj)

fired at reset received. optional.

Parameters
[in]-process instance
[in]-reset object

◆ shutdown

void(* xroad_process_iface_s::shutdown) (process_t *)

fired at process shutdown. required.

Parameters
[in]-process instance to shutdown

◆ start

void(* xroad_process_iface_s::start) (process_t *)

fired at process start. required.

Parameters
[in]-process instance to start

◆ stop

void(* xroad_process_iface_s::stop) (process_t *)

fired at process stop. required.

Parameters
[in]-process instalce to stop
The documentation for this struct was generated from the following file: