Contents

• Contents
• 1. Purpose
• 2. Status Server Overview
  • 2.1 Client Server Communication
  • 2.2 Directory Structure
  • 2.3 Directory and Data Object Information
• 3. API Primer
• 4. Detailed API
  • 4.1 ssLogon() - Establish a connection to the Status Server
  • 4.2 ssLogoff() - Disconnect from the Status Server
  • 4.3 ssGetError() - Get the enumerated error value
  • 4.4 ssGetStrError() - Get the enumerated error value
  • 4.5 ssDisconnectCallback() - Register a callback function in case of a disconnect
  • 4.6 ssReconnectCallback() - Register a callback function in case of a re-connect
  • 4.7 Create an object or register the intent to modify or remove an object
  • 4.8 ssTouchdir() - Create a new directory or register the intent to remove a directory
  • 4.9 ssUntouch() - Remove the touch from a Status Server data object or directory
  • 4.10 Update an object in the Status Server
  • 4.11 Retrieve the value of an object from the Status Server
  • 4.12 ssRemove() - Remove an object from the Status Server
  • 4.13 ssStat() - Check for the existence and status of an object
  • 4.14 ssGetAttributes() - Retrieve the attributes of a Status Server object or directory
  • 4.15 Place a monitor on an object
  • 4.16 Place a monitor on a directory
  • 4.17 ssUnmonitor() - Remove the monitor from a data object or directory
  • 4.18 ssPoll() - Check for and, if available, retrieve monitor updates
  • 4.19 ssWait() - Wait for a period and, if available, retrieve monitor updates
  • 4.20 ssSync() - Force client to synchronize itself with the server
  • 4.21 ssPwd() - Retrieve the current working directory path
  • 4.22 ssChdir() - Change the current working directory path
  • 4.23 ssRmdir() - Remove a directory from the Status Server
  • 4.24 ssOpenDir() - Open a Status Server directory for reading
  • 4.25 ssReadDir() - Retrieve the next directory listing object
  • 4.26 ssGetFileDescriptor() - Retrieve the socket file descriptor used to communicate with the Status Server
  • 4.27 ssTraceOn() - Turn on tracing within the Status Server
  • 4.28 ssTraceOff() - Turn off tracing within the Status Server
  • 4.29 ssAutosave() - Initiate a serialization of the Status Server
  • 4.30 ssWait() - Wait for a period and, if available, retrieve mirror updates
  • 4.31 ssShutdown() - Shutdown the Status Server
• 5. Examples
  • 5.1 Retrieve the value of an object from the Status Server
  • 5.2 Update the value of a Status Server object
  • 5.3 Monitor a Status Server object
• 6. Document Change Log