SendToNetworkSocketAction Class Reference

Sends data over a TCP or UDP socket. More...

Inherits SocketAction.

Properties
DataTarget	Source [get, set]
	Specifies the source of the data to send. More...
int	SendBufferSize [get, set]
	Specifies the buffer size of the source data, in bytes. The default value is 8192. More...
ActionTextEncoding	Encoding [get, set]
	Specifies the text encoding scheme to use when sending the data. The default value is UnicodeUTF8. More...
string	HostName [get, set]
	Specifies the remote endpoint to connect to. This can be either a host name or a IPv4/v6 address. More...
Int32	Port [get, set]
	Specifies the port address to send data to. More...
bool	TerminateWhenDone [get, set]
	Specifies whether the connection is closed when the action is completed. The default value is false. More...
int	SendTimeout [get, set]
	Specifies the amount of time, in milliseconds, to wait for the socket to send data. A value that is less than or equal to 0 specifies "wait forever." The default value is 0. More...
SocketProtocol	Protocol [get, set]
	Specifies the socket protocol, as follows: 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

Sends data over a TCP or UDP socket.

For common action properties, see IntegrationAction.
Example:

Actions:
- SendToNetworkSocketAction:
    Source: '%EventData%'
    HostName: myDesktopPC
    Port: 1027
    TerminateWhenDone: true
    Name: Send to Network Socket
    # And more common action properties
    ... 

Property Documentation

Source

DataTarget Source

getset

Specifies the source of the data to send.

SendBufferSize

int SendBufferSize

getset

Specifies the buffer size of the source data, in bytes. The default value is 8192.

Encoding

ActionTextEncoding Encoding

getsetinherited

Specifies the text encoding scheme to use when sending the data. The default value is UnicodeUTF8.

HostName

string HostName

getsetinherited

Specifies the remote endpoint to connect to. This can be either a host name or a IPv4/v6 address.

Port

Int32 Port

getsetinherited

Specifies the port address to send data to.

TerminateWhenDone

bool TerminateWhenDone

getsetinherited

Specifies whether the connection is closed when the action is completed. The default value is false.

SendTimeout

int SendTimeout

getsetinherited

Specifies the amount of time, in milliseconds, to wait for the socket to send data. A value that is less than or equal to 0 specifies "wait forever." The default value is 0.

Protocol

SocketProtocol Protocol

getsetinherited

Specifies the socket protocol, as follows:

• Tcp (default)
• Udp

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:

• SendToNetworkSocketAction.Properties.cs