Class WebSocketFactory

WebSocketFactory is used to create instances of WebSocket by specifying the end-point and the enabled protocols.

Using WebSocketFactory instance, application developers can set the ChallengeHandler or enabled extensions that will be inherited by all the WebSocket instances created from the factory. Once the WebSocket is connected, extensions that were successfully negotiated with the server can be determined using WebSocket.extensions property.


Constructor Summary
WebSocketFactory()
            Creates a new WebSocketFactory instance.
 
Method Summary
 WebSocket createWebSocket(location, protocols)
           Creates a WebSocket to establish a full-duplex connection to the target location.
 ChallengeHandler getChallengeHandler()
           Gets the default ChallengeHandler that is used during authentication both at the connect-time as well as at subsequent revalidation-time that occurs at regular intervals.
 int getDefaultConnectTimeout()
           Gets the default connect timeout in milliseconds.
 HttpRedirectPolicy getDefaultRedirectPolicy()
           Gets the default HTTP redirect policy used in a clustered environment.
 WebSocketExtension getExtension(name)
           Gets the specified extension from the list of registered extensions.
 void setChallengeHandler(challengeHandler)
           Sets the default ChallengeHandler that is used during authentication both at the connect-time as well as at subsequent revalidation-time that occurs at regular intervals.
 void setDefaultConnectTimeout(connectTimeout)
           Sets the default connect timeout in milliseconds.
 void setDefaultRedirectPolicy(redirectPolicy)
           Sets the default HTTP redirect policy used in a clustered environment.
 void setExtension(extension)
           Registers the specified extension.
 
Constructor Detail

WebSocketFactory

WebSocketFactory()

Method Detail

createWebSocket

WebSocket createWebSocket(location, protocols)

getChallengeHandler

ChallengeHandler getChallengeHandler()

getDefaultConnectTimeout

int getDefaultConnectTimeout()

getDefaultRedirectPolicy

HttpRedirectPolicy getDefaultRedirectPolicy()

getExtension

WebSocketExtension getExtension(name)

setChallengeHandler

void setChallengeHandler(challengeHandler)

setDefaultConnectTimeout

void setDefaultConnectTimeout(connectTimeout)

setDefaultRedirectPolicy

void setDefaultRedirectPolicy(redirectPolicy)

setExtension

void setExtension(extension)

Documentation generated by JsDoc Toolkit 1.3.3 on Thu Sep 25 2014 15:48:01 GMT-0700 (PDT)