Name
|
Description
|
Attributes
|
DeclaredName
|
The name of the object as declared.
|
Type: String
Access: Read-Only
|
DisplayName
|
The name displayed for this object in output windows such as views, plots, and reports.
|
Type: String
Access: Read/Write
|
ErrorAction
|
How to respond to a socket error. "Abort" is the default; this causes the script to terminate with an error. ErrorAction may also be set to "Ignore"; this causes the socket to be closed (except when opening a socket which is already open or for timeouts when sending or receiving data), and the Status and StatusString properties to be set to an error code and error description.
|
Type: String
Access: Read/Write
|
IPAddress
|
For a Client Socket, this is the name or IP address of the remote machine on which the server resides. For a Server Socket, this should typically be left blank (""), but on machines with more than one interface card this may be set to one of the IP addresses to allow connections only on that address.
|
Type: String
Access: Read/Write
|
IsOpen
|
0/1 Flag indicating whether or not the Socket has been opened.
|
Type: Variable
Access: Read-Only
|
ObjectId
|
The unique identifier for the object.
|
Type: Variable
Access: Read-Only
|
ObjectType
|
The type of the object.
|
Type: String
Access: Read-Only
|
PortNumber
|
For a Client Socket, the port number to connect to. For a Server Socket, the port number on which the Socket listens for connections.
|
Type: Variable
Access: Read/Write
|
RecvTranslation
|
Valid only for binary data transfer. "swap" is used to swap bytes on received integers and real numbers, required for communications between computer platforms with different endian (see Notes).
|
Type: String
Access: Read/Write
|
SendTranslation
|
Valid only for binary data transfer. "swap" is used to swap bytes on integers and real numbers before they are sent, required for communications between computer platforms with different endian (see Notes).
|
Type: String
Access: Read/Write
|
SepChars
|
Defines the characters that separate data elements of ASCII data transfers. When sending data, characters are inserted between all data elements. When receiving data, characters delineate the incoming data elements. The special value "whitespace" may be used to match arbitrary whitespace sequences on a Receive, and causes a single space character to separate fields on a Send.
|
Type: String
Access: Read/Write
|
SocketIsAscii
|
Type of data transfer, 1 for ASCII or 0 for binary.
|
Type: Variable
Access: Read/Write
|
SocketTimeout
|
The number of seconds allowed before a socket operation times out. Value of "-1" represents an infinite time out.
|
Type: Variable
Access: Read/Write
Units: s
|
SocketType
|
The type of socket connection where "client" refers to a direct connect mode and "server" refers to a listen mode.
|
Type: String
Access: Read/Write
|
Status
|
The status code of the socket. This property is not used unless ErrorAction is set to "Ignore". In this case, the property starts with the value 0, indicating no error. If a socket operation causes an error, the property's value will be changed to the positive integer error code from the failed operation. After inspecting the error code, the property should be set back to 0 in the script - a subsequent successful socket operation will not reset the value.
|
Type: Variable
Access: Read/Write
|
StatusString
|
A text description of the status code of the socket. This property is not used unless ErrorAction is set to "Ignore". In this case, the property starts out as an empty string, indicating no error. If a socket operation causes an error, the property's value will be changed to a text description of the error which occurred. After inspecting the error string, the property should be set back to an empty string in the script - a subsequent successful socket operation will not reset the value.
|
Type: String
Access: Read/Write
|
TermChars
|
Defines the end of an ASCII data string. Character(s) are inserted after the last data element when using with the Send command. Character(s) define the end of a data string when using the Receive command. The special value "whitespace" may be used to match arbitrary whitespace sequences on a Receive, and causes a carriage return and line feed to be added on a Send.
|
Type: String
Access: Read/Write
|
TransportType
|
Type of data interface method. Currently only "TCP" is supported.
|
Type: String
Access: Read/Write
|
