Read String
- Updated2023-02-17
- 2 minute(s) read
Read String
Returns the next available message. If no message is available, the node waits for either a new message or for the specified timeout to elapse.
If the WebSocket session becomes invalid, then the node stops waiting and returns an error.
Inputs/Outputs
websocket session in
Unique value that identifies the websocket session.
timeout
Time, in seconds, that this node waits for a new message to be available before returning a timeout error. A value of -1 indicates to wait indefinitely.
error in
Error conditions that occur before this node runs.
The node responds to this input according to standard error behavior.
Default value: No error
websocket session out
Unique value that identifies the websocket session.
string response
The next message available as a string. This is a UTF-8 encoded string.
error out
Error information.
The node produces this output according to standard error behavior.