SubProtocols Property
Optional subprotocols supported by the client.
Syntax
websocket.getSubProtocols([callback]) websocket.setSubProtocols( subProtocols, [callback])
Default Value
""
Callback
The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).
The callback for the getSubProtocols([callback]) method is defined as:
function(err, data){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'data' is the value returned by the method.
The callback for the setSubProtocols([callback]) method is defined as:
function(err){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'err' has 2 properties which hold detailed information:
err.code err.message
Remarks
This property is optional. Set this property to one or more comma separated subprotocols the client supports. These should be provided in order of preference. For instance: "chat, superchat".
The server will accept one subprotocol during the connection. After the connection is established this property will be updated by the class to reflect the value the server chose. Query this property to determine the negotiated subprotocol.
This property is not available at design time.
Data Type
String