Skip to content

WebSocketClient

WebSocketClient - ReadBinary

Reads a buffer through a web socket client

IN

Name Type Description
InWebSocketClient WebSocketClient The web socket client instance.
InTimeout Int The Timeout value in seconds.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutBuffer Buffer The read buffer.
Error ErrorState Gets the execution error message

WebSocketClient - WriteBinary

Writes a buffer through a web socket client

IN

Name Type Description
InWebSocketClient WebSocketClient The web socket client instance.
InBuffer Buffer The buffer 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

WebSocketClient - Close

Closes a web socket client

IN

Name Type Description
InWebSocketClient WebSocketClient The web socket client 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

WebSocketClient - Connect

Connects a web socket client

IN

Name Type Description
InURL String Server's URL to connect.
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutWebSocketClient WebSocketClient The web socket client instance.
Error ErrorState Gets the execution error message

WebSocketClient - ReadString

Reads a string through a web socket client

IN

Name Type Description
InWebSocketClient WebSocketClient The web socket client instance.Type : Web socket client
InTimeout Int The Timeout value in seconds.Type : Int
Name String Set the tool's name
Enable Bool Sets if current tool is enabled or not

OUT

Name Type Description
OutString String The readed string.Type : string
Error ErrorState Gets the execution error message

WebSocketClient - WriteString

Writes a string through a web socket client

IN

Name Type Description
InWebSocketClient WebSocketClient The web socket client instance.Type : Web socket client
InString String The string to write.Type : string
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