xroad_system.h

Go to the documentation of this file.

 
#pragma once
 
#include "xroad_node_fwd.h"
#include "xroad_node_types.h"
#include <common/xroad_common_types.h>
#include <common/xroad_string.h>
#include <common/xroad_string_decl.h>
#include <stdint.h>
#include <stdbool.h>
#include <signal.h>
 
#ifdef __cplusplus
extern "C"
{
#endif
 
typedef struct xroad_system_cursor_s xroad_system_cursor_t;
 
typedef enum
{
   xroad_node_status_active   = 1, 
   xroad_node_status_offline  = 2, 
   xroad_node_status_dead     = 3, 
   xroad_node_status_inactive = 4, 
   xroad_node_status_sleep    = 5, 
   xroad_node_status_deleted  = 6  
} xroad_node_status_t;
 
typedef enum
{
   xroad_node_flag_stand_alone     = 1,  
   xroad_node_flag_hidden          = 2,  
   xroad_node_flag_memory_locked   = 4,  
   xroad_node_flag_sleep_primary   = 8,  
   xroad_node_flag_sleep_backup    = 16, 
   xroad_node_flag_alarm_disabled  = 32, 
   xroad_node_flag_allow_clone     = 64  
} xroad_node_flag_t;
 
struct xroad_node_statistic_s
{
   uint32_t error_cnt;   
   uint32_t warn_cnt;    
   uint64_t msg_in_cnt;  
   uint64_t msg_out_cnt; 
   time_t   start_ts;    
   time_t   curr_ts;     
};
 
typedef enum
{
   xroad_link_type_posix_queue = 1,
   xroad_link_type_shm_queue = 2
} xroad_link_type_t;
 
typedef struct
{
   xroad_link_name_t name;        
   int32_t           msgsize_max; 
   int32_t           max_msg;     
} xroad_posix_queue_params_t;
 
typedef struct
{
   xroad_link_name_t name;     
   int32_t           shm_size; 
} xroad_shm_queue_params_t;
 
typedef enum
{
   xroad_system_role_primary = 1,
   xroad_system_role_backup = 2
} xroad_system_role_t;
 
typedef struct
{
   xroad_link_type_t type;                            
   bool flush;                                        
   union
   {
      xroad_posix_queue_params_t posix_queue_params;
      xroad_shm_queue_params_t shm_queue_params;
   };                                                 
} xroad_node_link_t;
 
typedef struct
{
   uint16_t         major_ver;      
   uint16_t         minor_ver;      
   xroad_git_hash_t git_hash;       
   bool             is_debug;       
   bool             unused;         
   xroad_arch_t     arch;           
} xroad_version_t;
 
typedef struct
{
   xroad_node_id_t        id;          
   xroad_node_name_t      name;        
   xroad_group_name_t     group;       
   pid_t                  pid;         
   xroad_node_statistic_t statistic;   
   xroad_node_status_t    status;      
   uint32_t               flags;       
   xroad_node_link_t      link;        
   xroad_version_t        version;     
   xroad_config_name_t    config;      
   xroad_config_name_t    schema;      
} xroad_node_data_t;
 
typedef struct
{
   uint16_t            major_ver;     
   bool                lock;          
   bool                out_of_system; 
   xroad_system_role_t role;          
   xroad_system_name_t name;          
   xroad_path_t        root_dir;      
   xroad_path_t        home_dir;      
   xroad_node_data_t   entries[XROAD_NODE_COUNT_MAX]; 
} xroad_system_t;
 
xroad_errno_t xroad_system_init(bool out_of_system);
 
xroad_system_t* xroad_system_get();
 
xroad_node_data_t* xroad_system_get_by_name(xroad_str_t name);
 
xroad_node_data_t* xroad_system_get_by_id(xroad_node_id_t id);
 
xroad_node_data_t* xroad_system_get_by_pid(pid_t pid);
 
xroad_str_t xroad_system_role_to_str(xroad_system_role_t role);
 
xroad_str_t xroad_node_status_to_str(xroad_node_status_t status);
 
xroad_hash_t* xroad_system_get_variables(const xroad_node_data_t* ndata);
 
xroad_xml_doc_t* xroad_system_read_config(const xroad_node_data_t* ndata);
 
 
xroad_system_cursor_t* xroad_system_create_cursor();
 
void xroad_system_destroy_cursor(xroad_system_cursor_t* cursor);
 
#define __xroad_system_cursor_dtor__ __dtor__(xroad_system_cursor_destructor)
void xroad_system_cursor_destructor(xroad_system_cursor_t** cursor);
 
xroad_node_data_t* xroad_system_cursor_get_first(xroad_system_cursor_t* cursor);
 
xroad_node_data_t* xroad_system_cursor_get_next(xroad_system_cursor_t* cursor);
 
xroad_node_data_t* xroad_system_cursor_get_last(xroad_system_cursor_t* cursor);
 
xroad_node_data_t* xroad_system_cursor_get_prev(xroad_system_cursor_t* cursor);
 
#ifdef __cplusplus
   }
#endif