Raritan Dominion SX16, Installation And Operation Manual, Page: 148 / 162

134 D
OMINION
SX I
NSTALLATION AND
O
PERATIONS
M
ANUAL
ampclosesocket [socket_id]
Closes the socket represented by the socket ID. If the command fails or the arguments are invalid, the command will
return an error with an error message.
Command Return Messages
0 (TCL_OK)
•
No message returned
1 (TCL_ERROR) •
wrong # args: should be ampclosesocket
socketDescriptor
•
Invalid Socket Descriptor %s
•
close socket failed
ampreadsocket [socket_id length timeout]
A non-blocking call: reads from the socket represented by the socket ID until either the length or timeout is reached.
Timeout is specified in microseconds; a timeout of zero indicates the socket will be polled and the results returned
immediately. The command returns a buffer with the data read, and if the data available to read is less than the
length requested, the command returns a buffer with the data read. If there is no data read or timeout occurs, the
command returns an “OK” with an empty buffer. If the command fails or the arguments are invalid, the command
will return an error with an error message.
Command Return Messages
0 (TCL_OK) •
No data read
•
Actual data read
•
Timeout occurred
1 (TCL_ERROR) •
Command failed: "not enough memory"
•
Command failed: "Invalid Socket
Descriptor OR read socket failed"
•
Arguments invalid: "wrong # args: should
be ampreadsocket socketDescriptor
messagelength timeout"
•
Arguments invalid: "Invalid Socket
Descriptor %s"
•
Arguments invalid: "invalid length %s,
only digits allowed"
•
Arguments invalid: "invalid timeout %s,
only digits allowed"
Note: Issue an ampclear command to clear old data before starting any new operations.
ampgetmacaddress
Returns the Ethernet MAC address of the unit.