Actions YAML Reference
Properties | List of all members
ReadFromNetworkSocketAction Class Reference

Reads from a TCP or UDP socket for incoming data. More...

Inherits IntegrationAction, and IYamlConvertibleExt.

Properties

SocketProtocol Protocol [get, set]
 Specifies the socket protocol to use: Tcp or Udp. The default value is Tcp. More...
 
Int32 Port [get, set]
 Specifies the port number of the network socket. The default value is 5170. More...
 
StreamDataEvent StopReadingWhen [get, set]
 Specifies the event that causes the action to stop reading.
More...
 
int ReadTimeout [get, set]
 Specifies the amount of time, in milliseconds, that the action waits for the socket to read the data before it times out. Valid only for Protocol.TCP. The default value is 0 ("Wait forever"). More...
 
int WriteTimeout [get, set]
 Specifies the amount of time, in milliseconds, that the action waits for the socket to write the data before it times out. Valid only for Protocol.TCP. The default value is 0 ("Wait forever"). More...
 
SerializableString WelcomeMessage [get, set]
 Specifies the acknowledgment message to display when the client connects. More...
 
SerializableString ResponseMessage [get, set]
 Specifies the message that is sent after the action runs. More...
 
ActionTextEncoding Encoding [get, set]
 Specifies the text encoding scheme of the messages that are received. The default value is UnicodeUTF8. More...
 
string ResponseAddress [get, set]
 Specifies that the response is sent to the specified network computer name or IP address. If ResponseAddress is used, ResponsePort must be set. More...
 
Int32 ResponsePort [get, set]
 Specifies the port to send the response message to. More...
 
string HostIPAddress [get, set]
 Specifies which IP host address to bind to. Used for hosts that have multiple IP addresses (multihome). More...
 
string RemoteHostName [get, set]
 Specifies the remote server that the action should connect to. The action will receive data from the remote server. The default value is "" (disabled). That is, the action should be accepting client connections instead of connecting to a remote server. More...
 
ContentDataType InputDataType [get, set]
 Specifies the input data type and how to process the data that is read. The following options are available: More...
 
bool DataInSoapMessage [get, set]
 Specifies whether data is contained in a SOAP message. The default value is false. More...
 
string InputDataVariable [get, set]
 Specifies the name of the variable to save input data to. More...
 
CommonActionProperties

Describes the common action properties for Actions and ActionGroups.

string Name [get, set]
 Specifies the name. This property cannot be empty and must be unique in the YAML script. More...
 
string Description [get, set]
 Specifies the description. The default value is "". More...
 
ActionRunType RunType [get, set]
 Runs the action by using one of the following types: More...
 
bool IgnoreErrors [get, set]
 Specifies whether to ignore errors and continue with the next action. Valid only for Action and ActionGroup. The default value is false. More...
 
int FailureRetries [get, set]
 Specifies the number of times that the action is retried if it fails. Available only for Action. The default value is 0. More...
 
int RetryInterval [get, set]
 Specifies the interval, in milliseconds, that elapses when a failed action is retried. Valid only when the value of FailureRetries is greater than 0. Available only for Action. The default value is 10000. More...
 

Detailed Description

Reads from a TCP or UDP socket for incoming data.

For common action properties, see IntegrationAction. Example:

Actions:
- ReadFromNetworkSocketAction:
Port: 1234
StopReadingWhen.CharacterSequence:
CharacterSequence: <eom>
WelcomeMessage: <acknowledgement>
ResponseMessage: '%LastErrorMessage%'
InputDataType: TextCSV
Name: Read from Network Socket
# And more common action properties
...
StreamDataEvent StopReadingWhen
Specifies the event that causes the action to stop reading.
Definition: ReadFromNetworkSocketAction.Properties.cs:139
bool DataInSoapMessage
Specifies whether data is contained in a SOAP message. The default value is false.
Definition: ReadFromNetworkSocketAction.Properties.cs:223
Int32 Port
Specifies the port number of the network socket. The default value is 5170.
Definition: ReadFromNetworkSocketAction.Properties.cs:107
ActionTextEncoding Encoding
Specifies the text encoding scheme of the messages that are received. The default value is UnicodeUTF...
Definition: ReadFromNetworkSocketAction.Properties.cs:177
ContentDataType InputDataType
Specifies the input data type and how to process the data that is read. The following options are ava...
Definition: ReadFromNetworkSocketAction.Properties.cs:213
SerializableString ResponseMessage
Specifies the message that is sent after the action runs.
Definition: ReadFromNetworkSocketAction.Properties.cs:169
SerializableString WelcomeMessage
Specifies the acknowledgment message to display when the client connects.
Definition: ReadFromNetworkSocketAction.Properties.cs:162
string Name
Specifies the name. This property cannot be empty and must be unique in the YAML script.
Definition: IntegrationAction.Properties.cs:87
@ USWesternEurope_1252
US, Western Europe (ANSI, 1252)

Example for using Establish connection to remote machine:

Actions:
- ReadFromNetworkSocketAction:
RemoteHostName="localhost"
Port: 1234
StopReadingWhen.CharacterSequence:
CharacterSequence: 'End'
WelcomeMessage: 'Welcome %EventTime%'
ResponseMessage: 'Bye %EventTime%'
InputDataType: TextCSV
Name: Read from Network Socket
# And more common action properties
...
string RemoteHostName
Specifies the remote server that the action should connect to. The action will receive data from the ...
Definition: ReadFromNetworkSocketAction.Properties.cs:206

Property Documentation

◆ Protocol

SocketProtocol Protocol
getset

Specifies the socket protocol to use: Tcp or Udp. The default value is Tcp.

◆ Port

Int32 Port
getset

Specifies the port number of the network socket. The default value is 5170.

◆ StopReadingWhen

StreamDataEvent StopReadingWhen
getset

Specifies the event that causes the action to stop reading.

Example of the default "Socket is disconnected" event:

StopReadingWhen.Disconnected: {}


Example of the "Sequence of characters is received" event:

StopReadingWhen.CharacterSequence:
CharacterSequence: _eom_
IncludeInStreamData: false


Example of the "Number of characters is received" event:

StopReadingWhen.CharacterNumber:
CharacterCount: 100


Example of the "Port becomes idle" event:

IdleUntilMilliSeconds: 3000

◆ ReadTimeout

int ReadTimeout
getset

Specifies the amount of time, in milliseconds, that the action waits for the socket to read the data before it times out. Valid only for Protocol.TCP. The default value is 0 ("Wait forever").

◆ WriteTimeout

int WriteTimeout
getset

Specifies the amount of time, in milliseconds, that the action waits for the socket to write the data before it times out. Valid only for Protocol.TCP. The default value is 0 ("Wait forever").


◆ WelcomeMessage

SerializableString WelcomeMessage
getset

Specifies the acknowledgment message to display when the client connects.

◆ ResponseMessage

SerializableString ResponseMessage
getset

Specifies the message that is sent after the action runs.

◆ Encoding

ActionTextEncoding Encoding
getset

Specifies the text encoding scheme of the messages that are received. The default value is UnicodeUTF8.


◆ ResponseAddress

string ResponseAddress
getset

Specifies that the response is sent to the specified network computer name or IP address. If ResponseAddress is used, ResponsePort must be set.

◆ ResponsePort

Int32 ResponsePort
getset

Specifies the port to send the response message to.

◆ HostIPAddress

string HostIPAddress
getset

Specifies which IP host address to bind to. Used for hosts that have multiple IP addresses (multihome).

◆ RemoteHostName

string RemoteHostName
getset

Specifies the remote server that the action should connect to. The action will receive data from the remote server. The default value is "" (disabled). That is, the action should be accepting client connections instead of connecting to a remote server.

◆ InputDataType

ContentDataType InputDataType
getset

Specifies the input data type and how to process the data that is read. The following options are available:

  • Unstructured (default)

XmlVariables

  • JsonVariables
  • XML
  • BTXML
  • TextCSV
  • TextTabDelimited
  • PrintCommandScript

◆ DataInSoapMessage

bool DataInSoapMessage
getset

Specifies whether data is contained in a SOAP message. The default value is false.

◆ InputDataVariable

string InputDataVariable
getset

Specifies the name of the variable to save input data to.

◆ Name

string Name
getsetinherited

Specifies the name. This property cannot be empty and must be unique in the YAML script.

◆ Description

string Description
getsetinherited

Specifies the description. The default value is "".

◆ RunType

ActionRunType RunType
getsetinherited

Runs the action by using one of the following types:

  • Always (default)
  • Never

◆ IgnoreErrors

bool IgnoreErrors
getsetinherited

Specifies whether to ignore errors and continue with the next action. Valid only for Action and ActionGroup. The default value is false.

◆ FailureRetries

int FailureRetries
getsetinherited

Specifies the number of times that the action is retried if it fails. Available only for Action. The default value is 0.

◆ RetryInterval

int RetryInterval
getsetinherited

Specifies the interval, in milliseconds, that elapses when a failed action is retried. Valid only when the value of FailureRetries is greater than 0. Available only for Action. The default value is 10000.


The documentation for this class was generated from the following file: