ltm rule command WS collect

iRule(1)						BIG-IP TMSH Manual						  iRule(1)

WS::collect
       This command can be used to collect payload of current Websocket frame. When the system collects the specified amount of
       data, it calls the Tcl event WS_CLIENT_DATA or WS_SERVER_DATA.

SYNOPSIS
       WS::collect ('frame' (LENGTH)? )

DESCRIPTION
       WS::collect frame Collects the entire Websocket frame payload.

       Note that if multiple iRules invoke WS::collect simultaneously, (perhaps by being called by the same event in multiple
       iRule scripts) then the result is undefined.  This is because the amount of payload collected for the WS_CLIENT_DATA or
       WS_SERVER_DATA event cannot satisfy the perhaps differing amounts wanted by the callers. iRules should arbitrate amoungst
       themselves to prevent this situation from occuring, and have only one WS::collect call outstanding at a time.

       WS::collect frame 
	   Collects an amount of Websocket frame payload, optionally specified with the  argument.

RETURN VALUE
VALID DURING
       WS_CLIENT_FRAME WS_SERVER_FRAME WS_CLIENT_DATA WS_SERVER_DATA

EXAMPLES
	when WS_CLIENT_FRAME {
	    WS::collect frame
	}
	when WS_CLIENT_FRAME {
	    WS::collect frame 1000
	}

HINTS
SEE ALSO
CHANGE LOG
       @BIGIP-12.1.0 --First introduced the command.

BIG-IP							    2022-04-12							  iRule(1)