monitoringDefs.h File Reference

Classes
struct	event
struct	state

Macros
#define	STATUS_FLAG(status_type)   (1<<(unsigned int)status_type)
	All state and transition definitions can be found here The server monitoring observes different states for multiple status types. More...
#define	FIRST_STATUS   0
#define	FIRST_EVENT   0
#define	ENTRY_STATE   0
#define	DOM_ELEMENT_STATUS_MESSAGE_NAME   "StatusMessage"
#define	DOM_ELEMENT_STATE_NAME   "State"
#define	DOM_ELEMENT_STATE_LEVEL_NAME   "StateLevel"
#define	DOM_ELEMENT_STATE_DESCRIPTION_NAME   "StateDescription"
#define	MAX_DESCRIPTION_LENGTH   50
#define	MONITORING_SERVER_PORT   8080
#define	XML_STATUS_MESSAGE_MAX_SIZE   3000
#define	XML_STATUS_MESSAGE_START   "<StatusMessage>"
#define	HTTP_ANSWER_PREFIX_FORMAT   "HTTP/1.1 200 OK\nContent-Length: %u\nConnection: close\nContent-Type: text/xml; charset=UTF-8\n\n"
#define	HTTP_ANSWER_PREFIX_MAX_LENGTH   100
#define	EVER   1
#define	NR_STATUS_TYPES   stat_all
#define	NETWORKING_STATUS_NAME   "NetworkingStatus"
#define	NR_NETWORKING_STATES   st_net_overall
#define	NR_NETWORKING_EVENTS   ev_net_overall
#define	SYSTEM_STATUS_NAME   "SystemStatus"
#define	NR_SYSTEM_STATES   st_sys_overall
#define	NR_SYSTEM_EVENTS   ev_sys_overall
#define	NR_STATE_LEVELS   stl_all
#define	FINISH_STATE_DEFINITIONS(state_array)
	helper macros for defining states and events: More...
#define	FINISH_EVENT_DEFINITIONS(event_array)
#define	FINISH_NETWORKING_STATE_DEFINITIONS(state_array)
#define	FINISH_NETWORKING_EVENT_DEFINITIONS(event_array)
#define	FINISH_PAYMENT_STATE_DEFINITIONS(state_array)
#define	FINISH_PAYMENT_EVENT_DEFINITIONS(event_array)
#define	FINISH_SYSTEM_STATE_DEFINITIONS(state_array)
#define	FINISH_SYSTEM_EVENT_DEFINITIONS(event_array)
#define	NET_STATE_DEF(state_array, state_type, description, transitions, stateLevel)    STATE_DEF(state_array, stat_networking, state_type, description, transitions, stateLevel)
#define	NET_EVENT_DEF(event_array, event_type, description)    EVENT_DEF(event_array, stat_networking, event_type, description)
#define	PAY_STATE_DEF(state_array, state_type, description, transitions, stateLevel)
#define	PAY_EVENT_DEF(event_array, event_type, description)
#define	SYS_STATE_DEF(state_array, state_type, description, transitions, stateLevel)    STATE_DEF(state_array, stat_system, state_type, description, transitions, stateLevel)
#define	SYS_EVENT_DEF(event_array, event_type, description)    EVENT_DEF(event_array, stat_system, event_type, description)
#define	STATE_DEF(state_array, status_type, state_type, description, transitions, stateLevel)
#define	EVENT_DEF(event_array, status_type, event_type, description)    event_array[status_type][event_type]->ev_description = (char *) description;
#define	TRANS_NET_ENTRY
	NETWORKING STATE TRANSITIONS. More...
#define	TRANS_NET_FIRST_MIX_INIT
#define	TRANS_NET_FIRST_MIX_CONNECTED_TO_NEXT
#define	TRANS_NET_FIRST_MIX_ONLINE
#define	TRANS_NET_MIDDLE_MIX_INIT
#define	TRANS_NET_MIDDLE_MIX_CONNECTED_TO_PREV
#define	TRANS_NET_MIDDLE_MIX_CONNECTED_TO_NEXT
#define	TRANS_NET_MIDDLE_MIX_ONLINE
#define	TRANS_NET_LAST_MIX_INIT
#define	TRANS_NET_LAST_MIX_CONNECTED_TO_PREV
#define	TRANS_NET_LAST_MIX_ONLINE
#define	TRANS_SYS_ENTRY
	SYSTEM STATE TRANSITIONS. More...
#define	TRANS_SYS_INITIALIZING
#define	TRANS_SYS_OPERATING
#define	TRANS_SYS_RESTARTING
#define	TRANS_SYS_SHUTTING_DOWN
#define	TRANS_SYS_SHUTTING_DOWN_AFTER_SEG_FAULT    (defineTransitions(stat_system, 0))

Typedefs
typedef enum state_type	state_type_t
typedef enum status_type	status_type_t
typedef enum state_type	transition_t
typedef enum event_type	event_type_t
typedef enum state_level	state_level_t
typedef struct state	state_t
typedef struct event	event_t

Enumerations
enum	status_type { stat_undef = -1 , stat_networking = 0 , stat_system , stat_all }
enum	state_type {   st_ignore = -1 , st_net_entry = 0 , st_net_firstMixInit , st_net_firstMixConnectedToNext ,   st_net_firstMixOnline , st_net_middleMixInit , st_net_middleMixConnectedToPrev , st_net_middleMixConnectedToNext ,   st_net_middleMixOnline , st_net_lastMixInit , st_net_lastMixConnectedToPrev , st_net_lastMixOnline ,   st_net_overall , st_sys_entry = 0 , st_sys_initializing , st_sys_operating ,   st_sys_restarting , st_sys_shuttingDown , st_sys_ShuttingDownAfterSegFault , st_sys_overall }
enum	event_type {   ev_net_firstMixInited = 0 , ev_net_middleMixInited , ev_net_lastMixInited , ev_net_prevConnected ,   ev_net_nextConnected , ev_net_prevConnectionClosed , ev_net_nextConnectionClosed , ev_net_keyExchangePrevSuccessful ,   ev_net_keyExchangeNextSuccessful , ev_net_keyExchangePrevFailed , ev_net_keyExchangeNextFailed , ev_net_overall ,   ev_sys_start = 0 , ev_sys_enterMainLoop , ev_sys_leavingMainLoop , ev_sys_sigTerm ,   ev_sys_sigInt , ev_sys_sigSegV , ev_sys_overall }
enum	state_level {   stl_ok = 0 , stl_warning , stl_critical , stl_unknown ,   stl_all }

Functions
transition_t *	defineTransitions (status_type_t s_type, int transitionCount,...)
	a convenience function for easily defining state transitions More...

Variables
static const char *	STATUS_NAMES [NR_STATUS_TYPES]
static const int	EVENT_COUNT [NR_STATUS_TYPES]
static const int	STATE_COUNT [NR_STATUS_TYPES]
static const char *	STATUS_LEVEL_NAMES [NR_STATE_LEVELS]

Macro Definition Documentation

DOM_ELEMENT_STATE_DESCRIPTION_NAME

#define DOM_ELEMENT_STATE_DESCRIPTION_NAME   "StateDescription"

DOM_ELEMENT_STATE_LEVEL_NAME

#define DOM_ELEMENT_STATE_LEVEL_NAME   "StateLevel"

DOM_ELEMENT_STATE_NAME

#define DOM_ELEMENT_STATE_NAME   "State"

DOM_ELEMENT_STATUS_MESSAGE_NAME

#define DOM_ELEMENT_STATUS_MESSAGE_NAME   "StatusMessage"

ENTRY_STATE

#define ENTRY_STATE   0

EVENT_DEF

#define EVENT_DEF	(		event_array,
			status_type,
			event_type,
			description
	)		event_array[status_type][event_type]->ev_description = (char *) description;

EVER

#define EVER   1

FINISH_EVENT_DEFINITIONS

#define FINISH_EVENT_DEFINITIONS

(

event_array

)

Value:

      FINISH_NETWORKING_EVENT_DEFINITIONS(event_array) \
      FINISH_PAYMENT_EVENT_DEFINITIONS(event_array) \
      FINISH_SYSTEM_EVENT_DEFINITIONS(event_array)

FINISH_NETWORKING_EVENT_DEFINITIONS

#define FINISH_NETWORKING_EVENT_DEFINITIONS

(

event_array

)

Value:

      NET_EVENT_DEF(event_array, ev_net_firstMixInited, \
          "first mix initialization finished") \
      NET_EVENT_DEF(event_array, ev_net_middleMixInited, \
          "middle mix initialization finished") \
      NET_EVENT_DEF(event_array, ev_net_lastMixInited, \
          "last mix initialization finished") \
      NET_EVENT_DEF(event_array, ev_net_prevConnected, \
          "connection to previous mix established") \
      NET_EVENT_DEF(event_array, ev_net_nextConnected, \
          "connection to next mix established") \
      NET_EVENT_DEF(event_array, ev_net_keyExchangePrevSuccessful, \
          "key exchange with previous mix successful") \
      NET_EVENT_DEF(event_array, ev_net_keyExchangeNextSuccessful, \
            "key exchange with next mix successful") \
        NET_EVENT_DEF(event_array, ev_net_keyExchangePrevFailed, \
            "key exchange with previous mix failed") \
      NET_EVENT_DEF(event_array, ev_net_keyExchangeNextFailed, \
            "key exchange with next mix failed") \
        NET_EVENT_DEF(event_array, ev_net_prevConnectionClosed, \
          "connection to previous mix closed") \
      NET_EVENT_DEF(event_array, ev_net_nextConnectionClosed, \
          "connection to next mix closed")

FINISH_NETWORKING_STATE_DEFINITIONS

#define FINISH_NETWORKING_STATE_DEFINITIONS

(

state_array

)

FINISH_PAYMENT_EVENT_DEFINITIONS

#define FINISH_PAYMENT_EVENT_DEFINITIONS

(

event_array

)

FINISH_PAYMENT_STATE_DEFINITIONS

#define FINISH_PAYMENT_STATE_DEFINITIONS

(

state_array

)

FINISH_STATE_DEFINITIONS

#define FINISH_STATE_DEFINITIONS

(

state_array

)

Value:

      FINISH_NETWORKING_STATE_DEFINITIONS(state_array) \
      FINISH_PAYMENT_STATE_DEFINITIONS(state_array) \
      FINISH_SYSTEM_STATE_DEFINITIONS(state_array)

helper macros for defining states and events:

FINISH_SYSTEM_EVENT_DEFINITIONS

#define FINISH_SYSTEM_EVENT_DEFINITIONS

(

event_array

)

Value:

      SYS_EVENT_DEF(event_array, ev_sys_start, \
          "mix startup") \
      SYS_EVENT_DEF(event_array, ev_sys_enterMainLoop, \
          "mix entering main loop") \
      SYS_EVENT_DEF(event_array, ev_sys_leavingMainLoop, \
          "mix leaving main loop") \
      SYS_EVENT_DEF(event_array, ev_sys_sigTerm, \
          "mix caught SIG_TERM") \
      SYS_EVENT_DEF(event_array, ev_sys_sigInt, \
          "mix caught SIG_INT") \
      SYS_EVENT_DEF(event_array, ev_sys_sigSegV, \
          "mix caught SIG_SEGV")

FINISH_SYSTEM_STATE_DEFINITIONS

#define FINISH_SYSTEM_STATE_DEFINITIONS

(

state_array

)

Value:

      SYS_STATE_DEF(state_array, st_sys_entry, \
          "system entry state", \
          TRANS_SYS_ENTRY, stl_unknown) \
      SYS_STATE_DEF(state_array, st_sys_initializing, \
          "mix is initializing", \
          TRANS_SYS_INITIALIZING, stl_warning) \
      SYS_STATE_DEF(state_array, st_sys_operating, \
          "mix is operating", \
          TRANS_SYS_OPERATING, stl_ok) \
      SYS_STATE_DEF(state_array, st_sys_restarting, \
          "mix is restarting", \
          TRANS_SYS_RESTARTING, stl_warning) \
      SYS_STATE_DEF(state_array, st_sys_shuttingDown, \
          "mix is shutting down", \
          TRANS_SYS_SHUTTING_DOWN, stl_critical) \
      SYS_STATE_DEF(state_array, st_sys_ShuttingDownAfterSegFault, \
          "mix is shutting down due to a segmentation fault!", \
          TRANS_SYS_SHUTTING_DOWN_AFTER_SEG_FAULT, stl_critical)

FIRST_EVENT

#define FIRST_EVENT   0

FIRST_STATUS

#define FIRST_STATUS   0

HTTP_ANSWER_PREFIX_FORMAT

#define HTTP_ANSWER_PREFIX_FORMAT   "HTTP/1.1 200 OK\nContent-Length: %u\nConnection: close\nContent-Type: text/xml; charset=UTF-8\n\n"

HTTP_ANSWER_PREFIX_MAX_LENGTH

#define HTTP_ANSWER_PREFIX_MAX_LENGTH   100

MAX_DESCRIPTION_LENGTH

#define MAX_DESCRIPTION_LENGTH   50

MONITORING_SERVER_PORT

#define MONITORING_SERVER_PORT   8080

NET_EVENT_DEF

#define NET_EVENT_DEF	(		event_array,
			event_type,
			description
	)		EVENT_DEF(event_array, stat_networking, event_type, description)

NET_STATE_DEF

#define NET_STATE_DEF	(		state_array,
			state_type,
			description,
			transitions,
			stateLevel
	)		STATE_DEF(state_array, stat_networking, state_type, description, transitions, stateLevel)

NETWORKING_STATUS_NAME

#define NETWORKING_STATUS_NAME   "NetworkingStatus"

NR_NETWORKING_EVENTS

#define NR_NETWORKING_EVENTS   ev_net_overall

NR_NETWORKING_STATES

#define NR_NETWORKING_STATES   st_net_overall

NR_STATE_LEVELS

#define NR_STATE_LEVELS   stl_all

NR_STATUS_TYPES

#define NR_STATUS_TYPES   stat_all

NR_SYSTEM_EVENTS

#define NR_SYSTEM_EVENTS   ev_sys_overall

NR_SYSTEM_STATES

#define NR_SYSTEM_STATES   st_sys_overall

PAY_EVENT_DEF

#define PAY_EVENT_DEF	(		event_array,
			event_type,
			description
	)

PAY_STATE_DEF

#define PAY_STATE_DEF	(		state_array,
			state_type,
			description,
			transitions,
			stateLevel
	)

STATE_DEF

#define STATE_DEF	(		state_array,
			status_type,
			state_type,
			description,
			transitions,
			stateLevel
	)

Value:

      state_array[status_type][state_type]->st_description = (char *) description; \
      state_array[status_type][state_type]->st_transitions = transitions; \
      state_array[status_type][state_type]->st_stateLevel = stateLevel;

STATUS_FLAG

#define STATUS_FLAG

(

status_type

)

(1<<(unsigned int)status_type)

All state and transition definitions can be found here The server monitoring observes different states for multiple status types.

The status types are currently:

1. "Network" which contains informations about the connection of the current mix to the others
2. "Payment" refers to the current state of the mixes accounting instance module.

"System" reflects general information about the actual state of the mix process.

A state has a level that shows if the current state of a mix is ok, unknown or critical. To realize a state machine events can be defined here. The events can be linked with states to realize transitions from one state to another if an event is fired.

Several macros can be found here for the definition of status types, states and events. Transitions can also be realized via macros.

SYS_EVENT_DEF

#define SYS_EVENT_DEF	(		event_array,
			event_type,
			description
	)		EVENT_DEF(event_array, stat_system, event_type, description)

SYS_STATE_DEF

#define SYS_STATE_DEF	(		state_array,
			state_type,
			description,
			transitions,
			stateLevel
	)		STATE_DEF(state_array, stat_system, state_type, description, transitions, stateLevel)

SYSTEM_STATUS_NAME

#define SYSTEM_STATUS_NAME   "SystemStatus"

TRANS_NET_ENTRY

#define TRANS_NET_ENTRY

Value:

  (defineTransitions(stat_networking, 3, \
      ev_net_firstMixInited, st_net_firstMixInit, \
      ev_net_middleMixInited, st_net_middleMixInit, \
      ev_net_lastMixInited, st_net_lastMixInit))

NETWORKING STATE TRANSITIONS.

TRANS_NET_FIRST_MIX_CONNECTED_TO_NEXT

#define TRANS_NET_FIRST_MIX_CONNECTED_TO_NEXT

Value:

  (defineTransitions(stat_networking, 2, \
      ev_net_keyExchangeNextSuccessful, st_net_firstMixOnline, \
      ev_net_nextConnectionClosed, st_net_firstMixInit))

TRANS_NET_FIRST_MIX_INIT

#define TRANS_NET_FIRST_MIX_INIT

Value:

  (defineTransitions(stat_networking, 1, \
      ev_net_nextConnected, st_net_firstMixConnectedToNext))

TRANS_NET_FIRST_MIX_ONLINE

#define TRANS_NET_FIRST_MIX_ONLINE

Value:

  (defineTransitions(stat_networking, 1, \
      ev_net_nextConnectionClosed, st_net_firstMixInit))

TRANS_NET_LAST_MIX_CONNECTED_TO_PREV

#define TRANS_NET_LAST_MIX_CONNECTED_TO_PREV

Value:

  (defineTransitions(stat_networking, 2, \
      ev_net_keyExchangePrevFailed, st_net_lastMixInit, \
      ev_net_keyExchangePrevSuccessful, st_net_lastMixOnline))

TRANS_NET_LAST_MIX_INIT

#define TRANS_NET_LAST_MIX_INIT

Value:

  (defineTransitions(stat_networking, 1, \
      ev_net_prevConnected, st_net_lastMixConnectedToPrev))

TRANS_NET_LAST_MIX_ONLINE

#define TRANS_NET_LAST_MIX_ONLINE

Value:

  (defineTransitions(stat_networking, 1, \
      ev_net_prevConnectionClosed, st_net_lastMixInit))

TRANS_NET_MIDDLE_MIX_CONNECTED_TO_NEXT

#define TRANS_NET_MIDDLE_MIX_CONNECTED_TO_NEXT

Value:

  (defineTransitions(stat_networking, 4, \
      ev_net_keyExchangeNextFailed, st_net_middleMixInit, \
      ev_net_keyExchangePrevFailed, st_net_middleMixInit, \
      ev_net_keyExchangeNextSuccessful, st_net_middleMixConnectedToNext, \
      ev_net_keyExchangePrevSuccessful, st_net_middleMixOnline))

TRANS_NET_MIDDLE_MIX_CONNECTED_TO_PREV

#define TRANS_NET_MIDDLE_MIX_CONNECTED_TO_PREV

Value:

  (defineTransitions(stat_networking, 2, \
      ev_net_nextConnected, st_net_middleMixConnectedToNext, \
      ev_net_prevConnectionClosed, st_net_middleMixInit))

TRANS_NET_MIDDLE_MIX_INIT

#define TRANS_NET_MIDDLE_MIX_INIT

Value:

  (defineTransitions(stat_networking, 1, \
      ev_net_prevConnected, st_net_middleMixConnectedToPrev))

TRANS_NET_MIDDLE_MIX_ONLINE

#define TRANS_NET_MIDDLE_MIX_ONLINE

Value:

  (defineTransitions(stat_networking, 2, \
      ev_net_prevConnectionClosed, st_net_middleMixInit, \
      ev_net_nextConnectionClosed, st_net_middleMixInit))

TRANS_SYS_ENTRY

#define TRANS_SYS_ENTRY

Value:

  (defineTransitions(stat_system, 1, \
      ev_sys_start, st_sys_initializing))

SYSTEM STATE TRANSITIONS.

TRANS_SYS_INITIALIZING

#define TRANS_SYS_INITIALIZING

Value:

  (defineTransitions(stat_system, 4, \
      ev_sys_enterMainLoop, st_sys_operating, \
      ev_sys_sigTerm, st_sys_shuttingDown, \
      ev_sys_sigInt, st_sys_shuttingDown, \
      ev_sys_sigSegV, st_sys_ShuttingDownAfterSegFault))

TRANS_SYS_OPERATING

#define TRANS_SYS_OPERATING

Value:

  (defineTransitions(stat_system, 4, \
      ev_sys_leavingMainLoop, st_sys_restarting, \
      ev_sys_sigTerm, st_sys_shuttingDown, \
      ev_sys_sigInt, st_sys_shuttingDown, \
      ev_sys_sigSegV, st_sys_ShuttingDownAfterSegFault))

TRANS_SYS_RESTARTING

#define TRANS_SYS_RESTARTING

Value:

  (defineTransitions(stat_system, 4, \
      ev_sys_enterMainLoop, st_sys_operating, \
      ev_sys_sigTerm, st_sys_shuttingDown, \
      ev_sys_sigInt, st_sys_shuttingDown, \
      ev_sys_sigSegV, st_sys_ShuttingDownAfterSegFault))

TRANS_SYS_SHUTTING_DOWN

#define TRANS_SYS_SHUTTING_DOWN

Value:

  (defineTransitions(stat_system, 1, \
      ev_sys_sigSegV, st_sys_ShuttingDownAfterSegFault))

TRANS_SYS_SHUTTING_DOWN_AFTER_SEG_FAULT

#define TRANS_SYS_SHUTTING_DOWN_AFTER_SEG_FAULT    (defineTransitions(stat_system, 0))

XML_STATUS_MESSAGE_MAX_SIZE

#define XML_STATUS_MESSAGE_MAX_SIZE   3000

XML_STATUS_MESSAGE_START

#define XML_STATUS_MESSAGE_START   "<StatusMessage>"

Typedef Documentation

event_t

typedef struct event event_t

event_type_t

typedef enum event_type event_type_t

state_level_t

typedef enum state_level state_level_t

state_t

typedef struct state state_t

state_type_t

typedef enum state_type state_type_t

status_type_t

typedef enum status_type status_type_t

transition_t

typedef enum state_type transition_t

Enumeration Type Documentation

event_type

enum event_type

Enumerator
ev_net_firstMixInited
ev_net_middleMixInited
ev_net_lastMixInited
ev_net_prevConnected
ev_net_nextConnected
ev_net_prevConnectionClosed
ev_net_nextConnectionClosed
ev_net_keyExchangePrevSuccessful
ev_net_keyExchangeNextSuccessful
ev_net_keyExchangePrevFailed
ev_net_keyExchangeNextFailed
ev_net_overall
ev_sys_start
ev_sys_enterMainLoop
ev_sys_leavingMainLoop
ev_sys_sigTerm
ev_sys_sigInt
ev_sys_sigSegV
ev_sys_overall

state_level

enum state_level

Enumerator
stl_ok
stl_warning
stl_critical
stl_unknown
stl_all

state_type

enum state_type

Enumerator
st_ignore
st_net_entry
st_net_firstMixInit
st_net_firstMixConnectedToNext
st_net_firstMixOnline
st_net_middleMixInit
st_net_middleMixConnectedToPrev
st_net_middleMixConnectedToNext
st_net_middleMixOnline
st_net_lastMixInit
st_net_lastMixConnectedToPrev
st_net_lastMixOnline
st_net_overall
st_sys_entry
st_sys_initializing
st_sys_operating
st_sys_restarting
st_sys_shuttingDown
st_sys_ShuttingDownAfterSegFault
st_sys_overall

status_type

enum status_type

Enumerator
stat_undef
stat_networking
stat_system
stat_all

Function Documentation

defineTransitions()

transition_t* defineTransitions	(	status_type_t	s_type,
		int	transitionCount,
			...
	)

a convenience function for easily defining state transitions

Parameters

s_type	the status type of the state for which the transitions are to be defined
transitionCount	the number of transitions to define
...	an event_type (of type event_type_t) followed by a state transition (of type transition_t) IMPORTANT: an event type MUST be followed by a state transition!

Returns

pointer to the array where the transitions are stored, (which of course has to be disposed by delete[] when reference is not needed anymore)!

Variable Documentation

EVENT_COUNT

const int EVENT_COUNT[NR_STATUS_TYPES]

static

Initial value:

=
{
    NR_NETWORKING_EVENTS,
 
 
 
    NR_SYSTEM_EVENTS
}

STATE_COUNT

const int STATE_COUNT[NR_STATUS_TYPES]

static

Initial value:

=
{
    NR_NETWORKING_STATES,
 
 
 
    NR_SYSTEM_STATES
}

STATUS_LEVEL_NAMES

const char* STATUS_LEVEL_NAMES[NR_STATE_LEVELS]

static

Initial value:

=
{
    "OK", "WARNING", "CRITICAL", "UNKNOWN"
}

STATUS_NAMES

const char* STATUS_NAMES[NR_STATUS_TYPES]

static

Initial value:

=
{
    NETWORKING_STATUS_NAME,
 
 
 
    SYSTEM_STATUS_NAME
}