WebSocket_Profile (object)

WebSocket profile with configurable options

Properties (* = required):

name	type(s)	default	allowed values	description
class	string		“WebSocket_Profile”
compression	boolean	true	true, false	Available when TMOS version is 16.1 or newer and used when compressMode is ‘typed’. Specifies whether compress will be negotiated with the endpoint.
compressMode	string	“preserved”	“preserved”, “typed”	Available when TMOS version is 16.1 or newer. Specifies the mode that controls what compression operations are performed. Setting ‘masking’ to ‘preserve’ and ‘compressMode’ to ‘typed’ will not be allowed because it results in an invalid configuration.
label	string		“^[^x00-x1fx22#&*<>?x5b-x5d`x7f]*$”	Optional friendly name for this object. Allows 0-64 chars, excluding a few likely to cause trouble with string searching, JS, TCL, or HTML
masking	string	“selective”	“preserve”, “unmask”, “remask”, “selective”	Specifies the masking operation for WebSocket frames
maximumWindowSize	integer	10	8 - 15	Available when TMOS version is 16.1 or newer and used when compressMode is ‘typed’. Specifies the maximum sliding window for compression negotiated with the endpoint.
noDelay	boolean	true	true, false	Available when TMOS version is 16.1 or newer and used when compressMode is ‘typed’. Specifies whether data should be buffered for efficient compression, or compressed without delay.
remark	string		“^[^x00-x1fx22x5cx7f]*$”	Arbitrary (brief) text pertaining to this object. Allows 0-64 chars, excluding only control characters, double-quote, and backslash. This is permissive enough that you should worry about XSS attacks