Technical information

RMS NetLinx Virtual Device API
132
RMS Enterprise - NetLinx Programmer’s Guide
RMS Client Query Commands (Cont.)
Query Command Description / Response Commands
?CLIENT.ONLINE This command will query the RMS client to determine if the client is currently connected and
online with the RMS server.
The response command will be returned in the following format:
CLIENT.ONLINE-<true|false>
Please note that the client may be connected to the RMS server and thus be online, but may
not yet have been registered with the RMS server. Only after the client is registered is it
allowed to participate in RMS features and functions.
?CLIENT.OFFLINE This command will query the RMS client to determine if the client is currently disconnected and
offline with the RMS server.
The response command will be returned in the following format:
CLIENT.OFFLINE-<true|false>
?CLIENT.REGISTERED This command will query the RMS client to determine if the client has been accepted and
registered on the RMS server.
The response command will be returned in the following format:
CLIENT.REGISTERED-<true|false>
?CLIENT.CONNECTION.STATE This command will query the RMS client to determine the current connection state.
The response command will be returned in the following format:
CLIENT.CONNECTION.STATE-<state-string>
The following connections states are available:
• INIT - The client is in this state when the system first boots up. This state is prior to the RMS
client reading it's configuration settings.
• DISABLED - The client enters this state after the client configuration has been loaded and
determines that the client is either disabled or the necessary configuration settings required
to connect to a RMS server are missing.
• OFFLINE - The client enters this state after the client configuration has been loaded and
determines that the client is enabled. In this state the client will routinely attempt to connect
to the configured RMS server. The client may also enter this state if the connection with the
RMS server has been lost.
• CONNECT-SERVER - The client enters this state when attempting to connect to the RMS
server. If the connection is successful, the client transitions to the CONNECT-CLIENT state,
otherwise to the CONNECT-FAIL state.
• CONNECT-CLIENT - The client enters this state when after successfully connecting to the
RMS server in the CONNECT-SERVER state. During this state the client will attempt to
register the client gateway information with the RMS server. If the connection and client
gateway registration is successful, the client transitions to the CONNECT-LOCATION state,
otherwise to the CONNECT-FAIL state.
• CONNECT-LOCATION - The client enters this state when after successfully connecting to
the RMS server and registering the client gateway information in the CONNECT-CLIENT
state. During this state the client will attempt to obtain the default client configured RMS
location from the RMS server. If a valid location is returned is successfully, the client
transitions to the ONLINE state, otherwise if a location is not returned, meaning that this
client gateway has not been registered to a location in the RMS system, the state will
transition to the ONLINE-UNREGISTERED state.
• CONNECT-FAIL - The client enters this state if at any point the connection to the RMS server
cannot be established or is lost. After entering this state, the client will automatically
transition back to the OFFLINE state and wait for a re-connection attempt.
• ONLINE - The client enters this state after successfully connecting to the RMS server,
registering the client gateway information, and obtaining a valid RMS location from the
server. The client will remain in this state and periodically request any pending client
destined messages. If a connection attempt or request fails to the RMS server, the client will
transition to the CONNECT-FAIL state.