The variables module (varmod)

The varmod is a centralized service that allow all the modules to share variables for collecting statistics or sharing global informations.

It allows to store a value associated with a name (a variable), to get it back. It also allows to make some basic operations on the variables :

• intopvar provides any integer operations on variables. The operator can be + - x or / providing the corresponding arithmetic operation.
• stropvar provides string operations. The operator can be only ‘c’ at that time corresponding to the concatenation operation.

API

cmd_varmod.delns_varmod(varmod_id, ns='default')

Delete a variables workspace and all its content

cmd_varmod.checkns_varmod(varmod_id, ns='default')

Check if a workspace exists

cmd_varmod.rmvar_varmod(varmod_id, ns, param_name)

Remove a variable

cmd_varmod.setvar_varmod(varmod_id, ns, param_name, param_value)

Set value on variable param_name

cmd_varmod.getvar_varmod(varmod_id, ns, param_name)

Get value of variable param_name

cmd_varmod.intopvar_varmod(varmod_id, ns, param_name, op, operand)

Do integer operation op with operand on variable param_name. op can be ‘+’, ‘-‘, ‘x’ or ‘/’

cmd_varmod.flopvar_varmod(varmod_id, ns, param_name, op, operand)

Do floating point operation op with operand on variable param_name. op can be ‘+’, ‘-‘, ‘x’ or ‘/’

cmd_varmod.stropvar_varmod(varmod_id, ns, param_name, op, operand)

Do string operation op with operand on variable param_name. op can only be ‘c’ for concatenation

cmd_varmod.get_token_varmod(varmod_id, ns, token_name)

gives a token to the client if the token is free

cmd_varmod.release_token_varmod(varmod_id, ns, token_name)

gives a token to the client if the token is free

cmd_varmod.del_token_varmod(varmod_id, ns, token_name)

delete a token

cmd_varmod.register_ds_varmod(varmod_id, ns, source_name, host, data_port, dataready_port, schema)

register a data source

cmd_varmod.get_ds_varmod(varmod_id, ns, source_name)

get a data source

cmd_varmod.get_ds_fields_varmod(varmod_id, ns, source_name)

get a data source

cmd_varmod.find_ds_varmod(varmod_id, ns, pattern)

find data sources

cmd_varmod.rm_ds_varmod(varmod_id, ns, source_name)

remove a data source