WS::response

Description

WS::response protocol

Returns the value of Sec-WebSocket-Protocol header field in server response.

WS::response extension

Returns the value of Sec-WebSocket-Extensions header field in server response.

WS::response version

Returns the value of Sec-WebSocket-Version header field in server response.

WS::response key

Returns the value of Sec-WebSocket-Accept header field in server response.

WS::response valid

Returns whether the client request and server response resulted in a successful Websocket upgrade.

Syntax

WS::response ('protocol' | 'extension' | 'version' | 'key' | 'valid' )

Return Value

This command can be used to lookup the values of various Websocket header fields seen in a server response.

Valid During

WS_RESPONSE

Examples

when WS_RESPONSE {
     if { [WS::response key] equals "s3pPLMBiTxaQ9kYGzzhZRbK+xOo="} {
         WS::enabled false
     }
 }

Change Log

@BIGIP-12.1 –First introduced the command.

The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.