WS::request

Description

WS::request protocol

Returns the value of Sec-WebSocket-Protocol header field in client request.

WS::request extension

Returns the value of Sec-WebSocket-Extensions header field in client request.

WS::request version

Returns the value of Sec-WebSocket-Version header field in client request.

WS::request key

Returns the value of Sec-WebSocket-Key header field in client request.

Syntax

WS::request ('protocol' | 'extension' | 'version' | 'key' )

Return Value

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

Valid During

WS_REQUEST

Examples

when WS_REQUEST {
     if { [WS::request protocol] equals "chat" } {
         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.