TCP.readIntoPayload()

Signature

Event readIntoPayload(String sessionNickName, int maxNumBytesToRead, String uriOfResponseEvent)

Domain

Parameters

NameTypeDescription
sessionNickNameStringNick name of the session
maxNumBytesToReadintIf the end of the stream is received before this number of bytes are read, then the reading stops and returns the data collected so far.
uriOfResponseEventStringThe event that will be created and the bytes read will be set as a payload into that event before returning it.

Returns

TypeDescription
EventThe event with the payload containing the data. null if End-of-stream is reached.