SimGrid  3.16
Versatile Simulation of Distributed Systems
Tracing user variables

Detailed Description

Functions to declare and define user variables associated to resources.

Functions

void TRACE_vm_variable_declare (const char *variable)
 Declare a new user variable associated to VMs. More...
 
void TRACE_vm_variable_declare_with_color (const char *variable, const char *color)
 Declare a new user variable associated to VMs with a color. More...
 
void TRACE_vm_variable_set (const char *vm, const char *variable, double value)
 Set the value of a variable of a host. More...
 
void TRACE_vm_variable_add (const char *vm, const char *variable, double value)
 Add a value to a variable of a VM. More...
 
void TRACE_vm_variable_sub (const char *vm, const char *variable, double value)
 Subtract a value from a variable of a VM. More...
 
void TRACE_vm_variable_set_with_time (double time, const char *vm, const char *variable, double value)
 Set the value of a variable of a VM at a given timestamp. More...
 
void TRACE_vm_variable_add_with_time (double time, const char *vm, const char *variable, double value)
 Add a value to a variable of a VM at a given timestamp. More...
 
void TRACE_vm_variable_sub_with_time (double time, const char *vm, const char *variable, double value)
 Subtract a value from a variable of a VM at a given timestamp. More...
 
xbt_dynar_t TRACE_get_vm_variables ()
 Get declared user vm variables. More...
 
void TRACE_host_variable_declare (const char *variable)
 Declare a new user variable associated to hosts. More...
 
void TRACE_host_variable_declare_with_color (const char *variable, const char *color)
 Declare a new user variable associated to hosts with a color. More...
 
void TRACE_host_variable_set (const char *host, const char *variable, double value)
 Set the value of a variable of a host. More...
 
void TRACE_host_variable_add (const char *host, const char *variable, double value)
 Add a value to a variable of a host. More...
 
void TRACE_host_variable_sub (const char *host, const char *variable, double value)
 Subtract a value from a variable of a host. More...
 
void TRACE_host_variable_set_with_time (double time, const char *host, const char *variable, double value)
 Set the value of a variable of a host at a given timestamp. More...
 
void TRACE_host_variable_add_with_time (double time, const char *host, const char *variable, double value)
 Add a value to a variable of a host at a given timestamp. More...
 
void TRACE_host_variable_sub_with_time (double time, const char *host, const char *variable, double value)
 Subtract a value from a variable of a host at a given timestamp. More...
 
xbt_dynar_t TRACE_get_host_variables ()
 Get declared user host variables. More...
 
void TRACE_link_variable_declare (const char *variable)
 Declare a new user variable associated to links. More...
 
void TRACE_link_variable_declare_with_color (const char *variable, const char *color)
 Declare a new user variable associated to links with a color. More...
 
void TRACE_link_variable_set (const char *link, const char *variable, double value)
 Set the value of a variable of a link. More...
 
void TRACE_link_variable_add (const char *link, const char *variable, double value)
 Add a value to a variable of a link. More...
 
void TRACE_link_variable_sub (const char *link, const char *variable, double value)
 Subtract a value from a variable of a link. More...
 
void TRACE_link_variable_set_with_time (double time, const char *link, const char *variable, double value)
 Set the value of a variable of a link at a given timestamp. More...
 
void TRACE_link_variable_add_with_time (double time, const char *link, const char *variable, double value)
 Add a value to a variable of a link at a given timestamp. More...
 
void TRACE_link_variable_sub_with_time (double time, const char *link, const char *variable, double value)
 Subtract a value from a variable of a link at a given timestamp. More...
 
void TRACE_link_srcdst_variable_set (const char *src, const char *dst, const char *variable, double value)
 Set the value of the variable present in the links connecting source and destination. More...
 
void TRACE_link_srcdst_variable_add (const char *src, const char *dst, const char *variable, double value)
 Add a value to the variable present in the links connecting source and destination. More...
 
void TRACE_link_srcdst_variable_sub (const char *src, const char *dst, const char *variable, double value)
 Subtract a value from the variable present in the links connecting source and destination. More...
 
void TRACE_link_srcdst_variable_set_with_time (double time, const char *src, const char *dst, const char *variable, double value)
 Set the value of the variable present in the links connecting source and destination at a given timestamp. More...
 
void TRACE_link_srcdst_variable_add_with_time (double time, const char *src, const char *dst, const char *variable, double value)
 Add a value to the variable present in the links connecting source and destination at a given timestamp. More...
 
void TRACE_link_srcdst_variable_sub_with_time (double time, const char *src, const char *dst, const char *variable, double value)
 Subtract a value from the variable present in the links connecting source and dest. More...
 
xbt_dynar_t TRACE_get_link_variables ()
 Get declared user link variables. More...
 
void TRACE_host_state_declare (const char *state)
 Declare a new user state associated to hosts. More...
 
void TRACE_host_state_declare_value (const char *state, const char *value, const char *color)
 Declare a new value for a user state associated to hosts. More...
 
void TRACE_host_set_state (const char *host, const char *state, const char *value)
 Set the user state to the given value. More...
 
void TRACE_host_push_state (const char *host, const char *state, const char *value)
 Push a new value for a state of a given host. More...
 
void TRACE_host_pop_state (const char *host, const char *state)
 Pop the last value of a state of a given host. More...
 
void TRACE_host_reset_state (const char *host, const char *state)
 Reset the state of a given host. More...
 

Function Documentation

◆ TRACE_vm_variable_declare()

void TRACE_vm_variable_declare ( const char *  variable)

Declare a new user variable associated to VMs.

Declare a user variable that will be associated to VMs. A user vm variable can be used to trace user variables such as the number of tasks in a VM, the number of clients in an application (for VMs), and so on. The color associated to this new variable will be random.

Parameters
variableThe name of the new variable to be declared.
See also
TRACE_vm_variable_declare_with_color

◆ TRACE_vm_variable_declare_with_color()

void TRACE_vm_variable_declare_with_color ( const char *  variable,
const char *  color 
)

Declare a new user variable associated to VMs with a color.

Same as TRACE_vm_variable_declare, but associated a color to the newly created user host variable. The color needs to be a string with three numbers separated by spaces in the range [0,1]. A light-gray color can be specified using "0.7 0.7 0.7" as color.

Parameters
variableThe name of the new variable to be declared.
colorThe color for the new variable.

◆ TRACE_vm_variable_set()

void TRACE_vm_variable_set ( const char *  vm,
const char *  variable,
double  value 
)

Set the value of a variable of a host.

Parameters
vmThe name of the VM to be considered.
variableThe name of the variable to be considered.
valueThe new value of the variable.
See also
TRACE_vm_variable_declare, TRACE_vm_variable_add, TRACE_vm_variable_sub

◆ TRACE_vm_variable_add()

void TRACE_vm_variable_add ( const char *  vm,
const char *  variable,
double  value 
)

Add a value to a variable of a VM.

Parameters
vmThe name of the VM to be considered.
variableThe name of the variable to be considered.
valueThe value to be added to the variable.
See also
TRACE_vm_variable_declare, TRACE_vm_variable_set, TRACE_vm_variable_sub

◆ TRACE_vm_variable_sub()

void TRACE_vm_variable_sub ( const char *  vm,
const char *  variable,
double  value 
)

Subtract a value from a variable of a VM.

Parameters
vmThe name of the vm to be considered.
variableThe name of the variable to be considered.
valueThe value to be subtracted from the variable.
See also
TRACE_vm_variable_declare, TRACE_vm_variable_set, TRACE_vm_variable_add

◆ TRACE_vm_variable_set_with_time()

void TRACE_vm_variable_set_with_time ( double  time,
const char *  vm,
const char *  variable,
double  value 
)

Set the value of a variable of a VM at a given timestamp.

Same as TRACE_vm_variable_set, but let user specify the time used to trace it. Users can specify a time that is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are also traced.

Parameters
timeThe timestamp to be used to tag this change of value.
vmThe name of the VM to be considered.
variableThe name of the variable to be considered.
valueThe new value of the variable.
See also
TRACE_vm_variable_declare, TRACE_vm_variable_add_with_time, TRACE_vm_variable_sub_with_time

◆ TRACE_vm_variable_add_with_time()

void TRACE_vm_variable_add_with_time ( double  time,
const char *  vm,
const char *  variable,
double  value 
)

Add a value to a variable of a VM at a given timestamp.

Same as TRACE_vm_variable_add, but let user specify the time used to trace it. Users can specify a time that is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are also traced.

Parameters
timeThe timestamp to be used to tag this change of value.
vmThe name of the VM to be considered.
variableThe name of the variable to be considered.
valueThe value to be added to the variable.
See also
TRACE_vm_variable_declare, TRACE_vm_variable_set_with_time, TRACE_vm_variable_sub_with_time

◆ TRACE_vm_variable_sub_with_time()

void TRACE_vm_variable_sub_with_time ( double  time,
const char *  vm,
const char *  variable,
double  value 
)

Subtract a value from a variable of a VM at a given timestamp.

Same as TRACE_vm_variable_sub, but let user specify the time used to trace it. Users can specify a time that is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are also traced.

Parameters
timeThe timestamp to be used to tag this change of value.
vmThe name of the VM to be considered.
variableThe name of the variable to be considered.
valueThe value to be subtracted from the variable.
See also
TRACE_vm_variable_declare, TRACE_vm_variable_set_with_time, TRACE_vm_variable_add_with_time

◆ TRACE_get_vm_variables()

xbt_dynar_t TRACE_get_vm_variables ( )

Get declared user vm variables.

This function should be used to get VM variables that were already declared with TRACE_vm_variable_declare or with TRACE_vm_variable_declare_with_color.

Returns
A dynar with the declared host variables, must be freed with xbt_dynar_free.

◆ TRACE_host_variable_declare()

void TRACE_host_variable_declare ( const char *  variable)

Declare a new user variable associated to hosts.

Declare a user variable that will be associated to hosts. A user host variable can be used to trace user variables such as the number of tasks in a server, the number of clients in an application (for hosts), and so on. The color associated to this new variable will be random.

Parameters
variableThe name of the new variable to be declared.
See also
TRACE_host_variable_declare_with_color

◆ TRACE_host_variable_declare_with_color()

void TRACE_host_variable_declare_with_color ( const char *  variable,
const char *  color 
)

Declare a new user variable associated to hosts with a color.

Same as TRACE_host_variable_declare, but associated a color to the newly created user host variable. The color needs to be a string with three numbers separated by spaces in the range [0,1]. A light-gray color can be specified using "0.7 0.7 0.7" as color.

Parameters
variableThe name of the new variable to be declared.
colorThe color for the new variable.

◆ TRACE_host_variable_set()

void TRACE_host_variable_set ( const char *  host,
const char *  variable,
double  value 
)

Set the value of a variable of a host.

Parameters
hostThe name of the host to be considered.
variableThe name of the variable to be considered.
valueThe new value of the variable.
See also
TRACE_host_variable_declare, TRACE_host_variable_add, TRACE_host_variable_sub

◆ TRACE_host_variable_add()

void TRACE_host_variable_add ( const char *  host,
const char *  variable,
double  value 
)

Add a value to a variable of a host.

Parameters
hostThe name of the host to be considered.
variableThe name of the variable to be considered.
valueThe value to be added to the variable.
See also
TRACE_host_variable_declare, TRACE_host_variable_set, TRACE_host_variable_sub

◆ TRACE_host_variable_sub()

void TRACE_host_variable_sub ( const char *  host,
const char *  variable,
double  value 
)

Subtract a value from a variable of a host.

Parameters
hostThe name of the host to be considered.
variableThe name of the variable to be considered.
valueThe value to be subtracted from the variable.
See also
TRACE_host_variable_declare, TRACE_host_variable_set, TRACE_host_variable_add

◆ TRACE_host_variable_set_with_time()

void TRACE_host_variable_set_with_time ( double  time,
const char *  host,
const char *  variable,
double  value 
)

Set the value of a variable of a host at a given timestamp.

Same as TRACE_host_variable_set, but let user specify the time used to trace it. Users can specify a time that is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are also traced.

Parameters
timeThe timestamp to be used to tag this change of value.
hostThe name of the host to be considered.
variableThe name of the variable to be considered.
valueThe new value of the variable.
See also
TRACE_host_variable_declare, TRACE_host_variable_add_with_time, TRACE_host_variable_sub_with_time

◆ TRACE_host_variable_add_with_time()

void TRACE_host_variable_add_with_time ( double  time,
const char *  host,
const char *  variable,
double  value 
)

Add a value to a variable of a host at a given timestamp.

Same as TRACE_host_variable_add, but let user specify the time used to trace it. Users can specify a time that is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are also traced.

Parameters
timeThe timestamp to be used to tag this change of value.
hostThe name of the host to be considered.
variableThe name of the variable to be considered.
valueThe value to be added to the variable.
See also
TRACE_host_variable_declare, TRACE_host_variable_set_with_time, TRACE_host_variable_sub_with_time

◆ TRACE_host_variable_sub_with_time()

void TRACE_host_variable_sub_with_time ( double  time,
const char *  host,
const char *  variable,
double  value 
)

Subtract a value from a variable of a host at a given timestamp.

Same as TRACE_host_variable_sub, but let user specify the time used to trace it. Users can specify a time that is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are also traced.

Parameters
timeThe timestamp to be used to tag this change of value.
hostThe name of the host to be considered.
variableThe name of the variable to be considered.
valueThe value to be subtracted from the variable.
See also
TRACE_host_variable_declare, TRACE_host_variable_set_with_time, TRACE_host_variable_add_with_time

◆ TRACE_get_host_variables()

xbt_dynar_t TRACE_get_host_variables ( )

Get declared user host variables.

This function should be used to get host variables that were already declared with TRACE_host_variable_declare or with TRACE_host_variable_declare_with_color.

Returns
A dynar with the declared host variables, must be freed with xbt_dynar_free.

◆ TRACE_link_variable_declare()

void TRACE_link_variable_declare ( const char *  variable)

Declare a new user variable associated to links.

Declare a user variable that will be associated to links. A user link variable can be used, for example, to trace user variables such as the number of messages being transferred through network links. The color associated to this new variable will be random.

Parameters
variableThe name of the new variable to be declared.
See also
TRACE_link_variable_declare_with_color

◆ TRACE_link_variable_declare_with_color()

void TRACE_link_variable_declare_with_color ( const char *  variable,
const char *  color 
)

Declare a new user variable associated to links with a color.

Same as TRACE_link_variable_declare, but associated a color to the newly created user link variable. The color needs to be a string with three numbers separated by spaces in the range [0,1]. A light-gray color can be specified using "0.7 0.7 0.7" as color.

Parameters
variableThe name of the new variable to be declared.
colorThe color for the new variable.

◆ TRACE_link_variable_set()

void TRACE_link_variable_set ( const char *  link,
const char *  variable,
double  value 
)

Set the value of a variable of a link.

Parameters
linkThe name of the link to be considered.
variableThe name of the variable to be considered.
valueThe new value of the variable.
See also
TRACE_link_variable_declare, TRACE_link_variable_add, TRACE_link_variable_sub

◆ TRACE_link_variable_add()

void TRACE_link_variable_add ( const char *  link,
const char *  variable,
double  value 
)

Add a value to a variable of a link.

Parameters
linkThe name of the link to be considered.
variableThe name of the variable to be considered.
valueThe value to be added to the variable.
See also
TRACE_link_variable_declare, TRACE_link_variable_set, TRACE_link_variable_sub

◆ TRACE_link_variable_sub()

void TRACE_link_variable_sub ( const char *  link,
const char *  variable,
double  value 
)

Subtract a value from a variable of a link.

Parameters
linkThe name of the link to be considered.
variableThe name of the variable to be considered.
valueThe value to be subtracted from the variable.
See also
TRACE_link_variable_declare, TRACE_link_variable_set, TRACE_link_variable_add

◆ TRACE_link_variable_set_with_time()

void TRACE_link_variable_set_with_time ( double  time,
const char *  link,
const char *  variable,
double  value 
)

Set the value of a variable of a link at a given timestamp.

Same as TRACE_link_variable_set, but let user specify the time used to trace it. Users can specify a time that is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are also traced.

Parameters
timeThe timestamp to be used to tag this change of value.
linkThe name of the link to be considered.
variableThe name of the variable to be considered.
valueThe new value of the variable.
See also
TRACE_link_variable_declare, TRACE_link_variable_add_with_time, TRACE_link_variable_sub_with_time

◆ TRACE_link_variable_add_with_time()

void TRACE_link_variable_add_with_time ( double  time,
const char *  link,
const char *  variable,
double  value 
)

Add a value to a variable of a link at a given timestamp.

Same as TRACE_link_variable_add, but let user specify the time used to trace it. Users can specify a time that is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are also traced.

Parameters
timeThe timestamp to be used to tag this change of value.
linkThe name of the link to be considered.
variableThe name of the variable to be considered.
valueThe value to be added to the variable.
See also
TRACE_link_variable_declare, TRACE_link_variable_set_with_time, TRACE_link_variable_sub_with_time

◆ TRACE_link_variable_sub_with_time()

void TRACE_link_variable_sub_with_time ( double  time,
const char *  link,
const char *  variable,
double  value 
)

Subtract a value from a variable of a link at a given timestamp.

Same as TRACE_link_variable_sub, but let user specify the time used to trace it. Users can specify a time that is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are also traced.

Parameters
timeThe timestamp to be used to tag this change of value.
linkThe name of the link to be considered.
variableThe name of the variable to be considered.
valueThe value to be subtracted from the variable.
See also
TRACE_link_variable_declare, TRACE_link_variable_set_with_time, TRACE_link_variable_add_with_time

◆ TRACE_link_srcdst_variable_set()

void TRACE_link_srcdst_variable_set ( const char *  src,
const char *  dst,
const char *  variable,
double  value 
)

Set the value of the variable present in the links connecting source and destination.

Same as TRACE_link_variable_set, but instead of providing the name of link to be considered, provide the source and destination hosts. All links that are part of the route between source and destination will have the variable set to the provided value.

Parameters
srcThe name of the source host for get route.
dstThe name of the destination host for get route.
variableThe name of the variable to be considered.
valueThe new value of the variable.
See also
TRACE_link_variable_declare, TRACE_link_srcdst_variable_add, TRACE_link_srcdst_variable_sub

◆ TRACE_link_srcdst_variable_add()

void TRACE_link_srcdst_variable_add ( const char *  src,
const char *  dst,
const char *  variable,
double  value 
)

Add a value to the variable present in the links connecting source and destination.

Same as TRACE_link_variable_add, but instead of providing the name of link to be considered, provide the source and destination hosts. All links that are part of the route between source and destination will have the value passed as parameter added to the current value of the variable name to be considered.

Parameters
srcThe name of the source host for get route.
dstThe name of the destination host for get route.
variableThe name of the variable to be considered.
valueThe value to be added to the variable.
See also
TRACE_link_variable_declare, TRACE_link_srcdst_variable_set, TRACE_link_srcdst_variable_sub

◆ TRACE_link_srcdst_variable_sub()

void TRACE_link_srcdst_variable_sub ( const char *  src,
const char *  dst,
const char *  variable,
double  value 
)

Subtract a value from the variable present in the links connecting source and destination.

Same as TRACE_link_variable_sub, but instead of providing the name of link to be considered, provide the source and destination hosts. All links that are part of the route between source and destination will have the value passed as parameter subtracted from the current value of the variable name to be considered.

Parameters
srcThe name of the source host for get route.
dstThe name of the destination host for get route.
variableThe name of the variable to be considered.
valueThe value to be subtracted from the variable.
See also
TRACE_link_variable_declare, TRACE_link_srcdst_variable_set, TRACE_link_srcdst_variable_add

◆ TRACE_link_srcdst_variable_set_with_time()

void TRACE_link_srcdst_variable_set_with_time ( double  time,
const char *  src,
const char *  dst,
const char *  variable,
double  value 
)

Set the value of the variable present in the links connecting source and destination at a given timestamp.

Same as TRACE_link_srcdst_variable_set, but let user specify the time used to trace it. Users can specify a time that is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are also traced.

Parameters
timeThe timestamp to be used to tag this change of value.
srcThe name of the source host for get route.
dstThe name of the destination host for get route.
variableThe name of the variable to be considered.
valueThe new value of the variable.
See also
TRACE_link_variable_declare, TRACE_link_srcdst_variable_add_with_time, TRACE_link_srcdst_variable_sub_with_time

◆ TRACE_link_srcdst_variable_add_with_time()

void TRACE_link_srcdst_variable_add_with_time ( double  time,
const char *  src,
const char *  dst,
const char *  variable,
double  value 
)

Add a value to the variable present in the links connecting source and destination at a given timestamp.

Same as TRACE_link_srcdst_variable_add, but let user specify the time used to trace it. Users can specify a time that is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are also traced.

Parameters
timeThe timestamp to be used to tag this change of value.
srcThe name of the source host for get route.
dstThe name of the destination host for get route.
variableThe name of the variable to be considered.
valueThe value to be added to the variable.
See also
TRACE_link_variable_declare, TRACE_link_srcdst_variable_set_with_time, TRACE_link_srcdst_variable_sub_with_time

◆ TRACE_link_srcdst_variable_sub_with_time()

void TRACE_link_srcdst_variable_sub_with_time ( double  time,
const char *  src,
const char *  dst,
const char *  variable,
double  value 
)

Subtract a value from the variable present in the links connecting source and dest.

at a given timestamp.

Same as TRACE_link_srcdst_variable_sub, but let user specify the time used to trace it. Users can specify a time that is not the simulated clock time as defined by the core simulator. This allows a fine-grain control of time definition, but should be used with caution since the trace can be inconsistent if resource utilization traces are also traced.

Parameters
timeThe timestamp to be used to tag this change of value.
srcThe name of the source host for get route.
dstThe name of the destination host for get route.
variableThe name of the variable to be considered.
valueThe value to be subtracted from the variable.
See also
TRACE_link_variable_declare, TRACE_link_srcdst_variable_set_with_time, TRACE_link_srcdst_variable_add_with_time

◆ TRACE_get_link_variables()

xbt_dynar_t TRACE_get_link_variables ( )

Get declared user link variables.

This function should be used to get link variables that were already declared with TRACE_link_variable_declare or with TRACE_link_variable_declare_with_color.

Returns
A dynar with the declared link variables, must be freed with xbt_dynar_free.

◆ TRACE_host_state_declare()

void TRACE_host_state_declare ( const char *  state)

Declare a new user state associated to hosts.

Declare a user state that will be associated to hosts. A user host state can be used to trace application states.

Parameters
stateThe name of the new state to be declared.
See also
TRACE_host_state_declare_value

◆ TRACE_host_state_declare_value()

void TRACE_host_state_declare_value ( const char *  state,
const char *  value,
const char *  color 
)

Declare a new value for a user state associated to hosts.

Declare a value for a state. The color needs to be a string with 3 numbers separated by spaces in the range [0,1]. A light-gray color can be specified using "0.7 0.7 0.7" as color.

Parameters
stateThe name of the new state to be declared.
valueThe name of the value
colorThe color of the value
See also
TRACE_host_state_declare

◆ TRACE_host_set_state()

void TRACE_host_set_state ( const char *  host,
const char *  state,
const char *  value 
)

Set the user state to the given value.

Change a user state previously declared to the given value.

Parameters
hostThe name of the host to be considered.
stateThe name of the state previously declared.
valueThe new value of the state.
See also
TRACE_host_state_declare, TRACE_host_push_state, TRACE_host_pop_state, TRACE_host_reset_state

◆ TRACE_host_push_state()

void TRACE_host_push_state ( const char *  host,
const char *  state,
const char *  value 
)

Push a new value for a state of a given host.

Change a user state previously declared by pushing the new value to the state.

Parameters
hostThe name of the host to be considered.
stateThe name of the state previously declared.
valueThe value to be pushed.
See also
TRACE_host_state_declare, TRACE_host_set_state, TRACE_host_pop_state, TRACE_host_reset_state

◆ TRACE_host_pop_state()

void TRACE_host_pop_state ( const char *  host,
const char *  state 
)

Pop the last value of a state of a given host.

Change a user state previously declared by removing the last value of the state.

Parameters
hostThe name of the host to be considered.
stateThe name of the state to be popped.
See also
TRACE_host_state_declare, TRACE_host_set_state, TRACE_host_push_state, TRACE_host_reset_state

◆ TRACE_host_reset_state()

void TRACE_host_reset_state ( const char *  host,
const char *  state 
)

Reset the state of a given host.

Clear all previous values of a user state.

Parameters
hostThe name of the host to be considered.
stateThe name of the state to be cleared.
See also
TRACE_host_state_declare, TRACE_host_set_state, TRACE_host_push_state, TRACE_host_pop_state