Next:
Contents
Up:
Home Page
Contents
Status Server Client C API
Tom Vermeulen
6 February 2008
Tip: The
PostScript
or
PDF version of this document
is more suitable for printing.
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
Call syntax
Input parameters
Return value
4.2
ssLogoff()
- Disconnect from the Status Server
4.3
ssGetError()
- Get the enumerated error value
Call syntax
Return value
4.4
ssGetStrError()
- Get the enumerated error value
Call syntax
Return value
4.5
ssDisconnectCallback()
- Register a callback function in case of a disconnect
Call syntax
Input parameters
4.6
ssReconnectCallback()
- Register a callback function in case of a re-connect
Call syntax
Input parameters
4.7 Create an object or register the intent to modify or remove an object
4.7.1
ssTouchObject()
- Touch object without specifying a lifetime
Call syntax
Input parameters
Return value
4.7.2
ssTouchObjectWithLifetime()
- Touch object with a specified lifetime
Call syntax
Input parameters
Return value
4.7.3
ssTouchObjectWithAutoExpire()
- Touch object with lifetime based on duration of client connection
Call syntax
Input parameters
Return value
4.7.4
ssTouchObjectExpire()
- Touch object and set value to EXPIRED
Call syntax
Input parameters
Return value
4.8
ssTouchdir()
- Create a new directory or register the intent to remove a directory
Call syntax
Input parameters
Return value
4.9
ssUntouch()
- Remove the touch from a Status Server data object or directory
Call syntax
Input parameters
Return value
4.10 Update an object in the Status Server
4.10.1
ssPutString()
- Update with a string value
Call syntax
Input parameters
Return value
4.10.2
ssPutInt()
- Update with an integer value
Call syntax
Input parameters
Return value
4.10.3
ssPutDouble()
- Update with a double-precision floating point value
Call syntax
Input parameters
Return value
4.10.4
ssPutBoolean()
- Update with a boolean value
Call syntax
Input parameters
Return value
4.10.5
ssPutPrintf()
- Update with a printf style argument
Call syntax
Input parameters
Return value
4.11 Retrieve the value of an object from the Status Server
4.11.1
ssGetString()
- Retrieve the value as a string
Call syntax
Input parameters
Output parameters
Return value
4.11.2
ssGetInt()
- Retrieve the value as an integer
Call syntax
Input parameters
Output parameters
Return value
4.11.3
ssGetDouble()
- Retrieve the value as a double-precision floating point number
Call syntax
Input parameters
Output parameters
Return value
4.11.4
ssGetBoolean()
- Retrieve the value as a boolean
Call syntax
Input parameters
Output parameters
Return value
4.12
ssRemove()
- Remove an object from the Status Server
Call syntax
Input parameters
Return value
4.13
ssStat()
- Check for the existence and status of an object
Call syntax
Input parameters
Output parameters
Return value
4.14
ssGetAttributes()
- Retrieve the attributes of a Status Server object or directory
Call syntax
Input parameters
Return value
4.15 Place a monitor on an object
4.15.1
ssMonitorCallback()
- Place a monitor on an object and be informed of the change via a callback
Call syntax
Input parameters
Return value
4.15.2
ssMonitorString()
- Place a monitor on an object and retrieve updates as a string
Call syntax
Input parameters
Output parameters
Return value
4.15.3
ssMonitorInt()
- Place a monitor on an object and retrieve updates as an integer
Call syntax
Input parameters
Output parameters
Return value
4.15.4
ssMonitorDouble()
- Place a monitor on an object and retrieve updates as a double-precision floating point number
Call syntax
Input parameters
Output parameters
Return value
4.15.5
ssMonitorBoolean()
- Place a monitor on an object and retrieve updates as a boolean
Call syntax
Input parameters
Output parameters
Return value
4.16 Place a monitor on a directory
4.16.1
ssMonitorDirCallback()
- Place a monitor on a directory and be informed of the change via a callback
Call syntax
Input parameters
Return value
4.16.2
ssMonitorDir()
- Place a monitor on a directory
Call syntax
Input parameters
Output parameters
Return value
4.17
ssUnmonitor()
- Remove the monitor from a data object or directory
Call syntax
Input parameters
Return value
4.18
ssPoll()
- Check for and, if available, retrieve monitor updates
Call syntax
Return value
4.19
ssWait()
- Wait for a period and, if available, retrieve monitor updates
Call syntax
Input parameters
Return value
4.20
ssSync()
- Force client to synchronize itself with the server
Call syntax
Return value
4.21
ssPwd()
- Retrieve the current working directory path
Call syntax
Return value
4.22
ssChdir()
- Change the current working directory path
Call syntax
Return value
4.23
ssRmdir()
- Remove a directory from the Status Server
Call syntax
Input parameters
Return value
4.24
ssOpenDir()
- Open a Status Server directory for reading
Call syntax
Input parameters
Return value
4.25
ssReadDir()
- Retrieve the next directory listing object
Call syntax
Return value
4.26
ssGetFileDescriptor()
- Retrieve the socket file descriptor used to communicate with the Status Server
Call syntax
Output parameters
Return value
4.27
ssTraceOn()
- Turn on tracing within the Status Server
Call syntax
Return value
4.28
ssTraceOff()
- Turn off tracing within the Status Server
Call syntax
Return value
4.29
ssAutosave()
- Initiate a serialization of the Status Server
Call syntax
Return value
4.30
ssWait()
- Wait for a period and, if available, retrieve mirror updates
Call syntax
Return value
4.30.1
ssMirrorCallback()
- Mirror a Status Server and be informed of any changes via a callback
Call syntax
Input parameters
Return value
4.31
ssShutdown()
- Shutdown the Status Server
Call syntax
Return value
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
Tom Vermeulen
2008-02-07
Server Communication