ltm rule command WS masking

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

WS::masking
       This command determines the behavior of Websocket processing. If preserve is set, the client or server frames
       recevied will not be unmasked for processing by other modules. If remask is set, the client-to-server frames
       will be remasked using a randomly generated mask before being sent to the server.

SYNOPSIS
       WS::masking ( 'preserve' | 'remask' )

DESCRIPTION
       WS::masking preserve
	   The WebSockets module will not unmask the payload. Data received from the end-points will be sent
       untouched to other modules for further processing.

       WS::masking remask
	   The data received from the end-points is unmasked and sent to other modules for further processing. The
       client-to-server frame's payload is then masked with the specified mask before sending data out on the wire
       again.

RETURN VALUE
VALID DURING
       WS_REQUEST WS_RESPONSE

EXAMPLES
	when WS_REQUEST {
	    WS::masking preserve
	    WS::masking remask
	}
	when WS_RESPONSE {
	    WS::masking preserve
	    WS::masking remask
	}

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

BIG-IP						      2020-06-23					     iRule(1)