Skip to content

Tcp

Tcp - Accept

Accepts a TCP connection and returns the socket instance.The execution stops until a connection has been performed

IN

Name Type Description
InPort Int The port to listen.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutSocket Socket The socket instance.
Error ErrorState Gets the execution error message

Tcp - Close

Close a TCP connection

IN

Name Type Description
InSocket Socket The socket instance.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
Error ErrorState Gets the execution error message

Tcp - Connect

Connect a client TCP to a listening server and returns the socket instance

IN

Name Type Description
InAddress String The address to connect to.
InPort Int The port to connect.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutSocket Socket The socket instance.
Error ErrorState Gets the execution error message

Tcp - CountAvailable

Counts the number of bytes that are available to be read from socket

IN

Name Type Description
InSocket Socket The socket instance.
OutCount Int The the count of available bytes.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
Error ErrorState Gets the execution error message

Tcp - ReadBytes

Reads an array of bytes from socket

IN

Name Type Description
InSocket Socket The socket instance.
InCount Int The number of bytes to be read.
InTimeout Int The timeout,in milliseconds,to wait for string.If <0, waits forever.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutBytes ByteArray The read bytes.
Error ErrorState Gets the execution error message

Tcp - ReadString

Reads a string value from TCP socket

IN

Name Type Description
InSocket Socket The socket instance.
InEncoding Enum < EncodingText > The encoding value for string.
InTerminationChar String The termination value for string.Any char can be used, including \r,\t,\n,\0.
InTimeout Int The timeout,in milliseconds,to wait for string.If <0, waits forever.
InReadTerminationChar Bool Sets if termination char has to be read.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutText String The read string.
Error ErrorState Gets the execution error message

Tcp - WriteBytes

Writes an array of bytes to socket

IN

Name Type Description
InSokcet Socket The socket instance.
InBytes ByteArray The bytes to write.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
Error ErrorState Gets the execution error message

Tcp - WriteString

Writes string value to TCP socket

IN

Name Type Description
InSocket Socket The socket instance.
InEncoding Enum < EncodingText > The encoding value for string.
InTerminationChar String The termination value for string.
InText String The string to write.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
Error ErrorState Gets the execution error message