Technical information

RMS NetLinx Virtual Device API
133
RMS Enterprise - NetLinx Programmer’s Guide
RMS Client Instruction Commands
RMS Client Event Notification Commands
RMS Client Query Commands (Cont.)
Query Command Description / Response Commands
?CLIENT.CONNECTION.STATE
(Cont.)
• ONLINE-UNREGISTERED - The client enters this state when after successfully connecting
to the RMS server, registering the client gateway information, and failing to obtain 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. While in this state and
processing received client messages, all messages will be ignored with the exception of the
REINITIALIZE request message. If a REINITIALIZE request is received, then the client will
transition to the REINITIALIZE state to begin a client re-initialization. A REINITIALIZE
request is sent by the server when a client gateway is registered to a location in the RMS
system.
• REINITIALIZE - The client enters this state anytime a REINITIALIZE request is received from
the RMS server. A REINITIALIZE request is sent by the server when a client gateway is
registered to a location in the RMS system. After entering this state, the client will
automatically transition to the CONNECT-CLIENT state to renegotiate online status with the
RMS server.
Note that a connection state diagram is provided in Appendix A (see FIG. 17 on page 40).
RMS Client Instruction Commands
Command Description
CLIENT.CONNECT This command will force the RMS client system to immediately connect to the RMS server.
This command will only function if (a) not already connected to a RMS server and (b) the RMS
client is enabled in the RMS client configuration.
CLIENT.DISCONNECT This command will force the RMS client system to immediately disconnect from the RMS server.
This command will only function if the client is already connected to a RMS server.
CLIENT.REINIT This command will force the RMS client system to immediately disconnect from the RMS server
and then reestablish a connection to the RMS server and re-initialize all asset registrations.
This command will only function if the client is already connected to a RMS server.
CLIENT.MESSAGES.RETRIEVE This command will force the RMS client system to immediately retrieve and process all pending
client-destined messages from the RMS server.
This command will only function if the client is already connected to a RMS server.
CLIENT.TIMESYNC This command will invoke a time synchronization to take place between the client system and
RMS server.
When complete the client system will be set to the time of the server relative to the client
assigned location time zone offset.
RMS Client Event Notification Commands
Command Description
CLIENT.ONLINE This event notification command will be sent when the RMS client connects to the
RMS server and enters the ONLINE or ONLINE-UNREGISTERED state.
CLIENT.REGISTERED This event notification command will be sent when the RMS client connects to the
RMS server and enters the ONLINE state and is registered on the RMS server.
CLIENT.OFFLINE This event notification command will be sent when the RMS client enters the
OFFLINE state from the INIT state or if the RMS client is not able to communicate
with the RMS server and transitions to the CONNECT-FAIL and then OFFLINE
states.
CLIENT.CONNECTION.STATE.TRANSITION-
<old-state-string>,<new-state-string>
This event notification command will be sent when the RMS client transitions to
each connection state.
The states are listed in the CLIENT.CONNECTION.STATE Send Command.
Note that a connection state diagram is provided in Appendix A (see FIG. 17 on
page 40).