call | inputs | outputs | Who? | Nonblocking? | purpose
|
---|
logon | none? client id? | PASS/FAIL | Clients | N | Get the connect with server phase
out of the way and make sure the
server is up. Alternatively, or
in addition, all other API calls
should first check that the connection is up.
|
logoff | none | PASS/FAIL | Clients | N | Free resources and shut down connection.
|
touch | name, type? min? max? lifetime? | PASS/FAIL | Provider | N | Three uses (maybe want three functions?): (1) Create variable if it doesn't exist (2) Register interest in having write permission (3) Reconfigure extra fields like lifetime, min, max, etc.
|
put | name, value lifetime? | PASS/FAIL | Provider | N | Put a new value.
|
stat | name | PASS/FAIL | Consumer | N | Test if a variable exists.
|
get | name | PASS/FAIL, value | Consumer | N | Get a value.
|
monitor | name, deadband? age? | PASSFAIL | Consumer | Y | Set up a monitor
|
kill_monitor | name | PASS/FAIL | Consumer | Y | Stop monitor
|