driver-state

Allows the DriverShim to save any required state information that it needs when it is initialized again.

Definition

  <!ELEMENT driver-state ANY >
  

Parent

Remarks

The ANY element allows you to add tags for whatever state information your driver needs to determine whether a transaction completed successfully. The DirXML engine keeps a queue of pending transactions and does not delete a transaction until the DirXML driver sends back the state of the transaction.

A state element can be included in any output or input command which the driver sends to the DirXML engine.The DirXML engine stores the information in the DirXML-DriverStorage attribute of the DirXML-Driver object and returns the information in the init-params command when the driver shim, subscriber shim, and publisher shim are started.

Sample State Tags

The VR Test driver saves the state information for the DriverShim. This information consists of a timestamp and a count. This sample XML starts with the <input> element.

  ...
  <input>
     <init-params>
        ...
        <driver-state>
           <time-stamp>2000-02-18 10:06:52.610</time-stamp>
           <run-count>51</run-count>
        </driver-state>
     </init-params>
  </input>
  ...
  

If you have binary data to save as state information, you will need to encode it as base64.