Use this interface instead of sending messages directly to ensure message keywords are spelled correctly, all parameters are specified, and error checked.

The receiving app defined this interface to ensure it receives the messages correctly.

Public Methods

static bool supervisorConsole(device)

UserDevice& device

end-user's device

static bool supervisorCommand(cmd, device)

const string& cmd	command to process
UserDevice& device	end-user's device

static bool mgmtMetaGet(channel, group)

const string& channel	client app/daemon channel
const string& group	name of the variable group

Get/Query variables for a group by supervisor. Meta interface - querying variable names from client apps/daemons

static bool mgmtMetaGetValue(group, list, status)

const string& group

name of the variable group

const StringSet& list

list of variable names

const string& status

OK for list present, otherwise error message

Default value: "OK"

Client reply with list of variables in group available for Get

static bool mgmtMetaSet(channel, group)

const string& channel	client app/daemon channel
const string& group	name of the variable group

Set variables for a group by supervisor. Meta interface - querying variable names from client apps/daemons

static bool mgmtMetaSetValue(group, list, status)

const string& group

name of the variable group

const StringSet& list

list of variable names

const string& status

OK for list present, otherwise error message

Default value: "OK"

Client reply with list of variables in group available for Set

static bool mgmtGet(channel, group, variable)

const string& channel	client app/daemon channel
const string& group	name of the variable group
const string& variable	name of the variable

Supervisor uses this API to query a client app/daemon for a variable's value.

static bool mgmtGetValue(group, variable, value, status)

const string& group	name of the variable group
const string& variable	name of the variable
const string& value	the value of the variable
const string& status	OK for list present, otherwise error message Default value: "OK"

Client app/daemon uses this API to reply to query for a variable's value.

static bool mgmtGetValue(group, variables, status)

const string& group

name of the variable group

const HashArray& variables

name of the variable

const string& status

OK for list present, otherwise error message

Default value: "OK"

Client app/daemon uses this API to reply to query for a list of variables' values.

static bool mgmtSet(channel, group, variable, value)

const string& channel	client app/daemon channel
const string& group	name of the variable group
const string& variable	name of the variable
const string& value	the value of the variable

Supervisor uses this API to change/set a client app/daemon variable's value.

static bool supervisorUsersSort(device, header)

UserDevice& device	end-user's device
const string& header	table header of column to sort

A user has clicked on a column header to sort that column.

static bool supervisorSelectUser(device, row)

UserDevice& device	end-user's device
int row	the interface row selected

The user has selected a MAE user to manipulate/change.

static bool mgmtSysAdminUI(device, channel, topic, param)

UserDevice& device	end-user's device
const string& channel	client app/daemon channel
const string& topic	action to take
const XMLData& param	parameter values for topic

Query by supervisor. Request UI access into system administrator interface.

static bool mgmtOperator(device, channel, topic, param)

UserDevice& device	end-user's device
const string& channel	client app/daemon channel
const string& topic	action to take
const XMLData& param	parameter values for topic

Query by supervisor. Request UI access into system operator interface.

static bool mgmtInputResponse(device, channel, cbtag, param, response)

UserDevice& device	end-user's device
const string& channel	client app/daemon channel
const string& cbtag	callback action (setup by supervisor)
const HashArray& param	callback data
const string& response	the user response to the UI control

Handle a user response (relayed from an app/daemon).

static bool send(request, params)

const string& request

the request keyword

const XMLData& params

the data (parameter payload)

Default value: XMLData("")

Send an API message to channel supervisor.