fm.liveswitch.WebSocketOpenArgs Class Reference

Open arguments for the fm.liveswitch.WebSocket class. More...

Public Member Functions

int getHandshakeTimeout ()
 Gets the timeout for the handshake (in ms). More...
 
java.util.HashMap< String, String > getHeaders ()
 Gets headers to send with the handshake request. More...
 
fm.liveswitch.IAction1< fm.liveswitch.WebSocketOpenFailureArgsgetOnFailure ()
 Gets the callback to invoke when a connection could not be established. More...
 
fm.liveswitch.IAction1< fm.liveswitch.WebSocketReceiveArgsgetOnReceive ()
 Gets the callback to invoke when a message is received. More...
 
fm.liveswitch.IAction1< fm.liveswitch.HttpRequestCreatedArgsgetOnRequestCreated ()
 Gets the callback to invoke before the handshake request is sent. More...
 
fm.liveswitch.IAction1< fm.liveswitch.HttpResponseReceivedArgsgetOnResponseReceived ()
 Gets the callback to invoke after the handshake response is received. More...
 
fm.liveswitch.IAction1< fm.liveswitch.WebSocketStreamFailureArgsgetOnStreamFailure ()
 Gets the callback to invoke when a successful connection breaks down. More...
 
fm.liveswitch.IAction1< fm.liveswitch.WebSocketOpenSuccessArgsgetOnSuccess ()
 Gets the callback to invoke when a successful connection has been established. More...
 
Object getSender ()
 Gets the sender of the request. More...
 
int getStreamTimeout ()
 Gets the timeout for the stream (in ms). More...
 
void setHandshakeTimeout (int value)
 Sets the timeout for the handshake (in ms). More...
 
void setHeaders (java.util.HashMap< String, String > value)
 Sets headers to send with the handshake request. More...
 
void setOnFailure (fm.liveswitch.IAction1< fm.liveswitch.WebSocketOpenFailureArgs > value)
 Sets the callback to invoke when a connection could not be established. More...
 
void setOnReceive (fm.liveswitch.IAction1< fm.liveswitch.WebSocketReceiveArgs > value)
 Sets the callback to invoke when a message is received. More...
 
void setOnRequestCreated (fm.liveswitch.IAction1< fm.liveswitch.HttpRequestCreatedArgs > value)
 Sets the callback to invoke before the handshake request is sent. More...
 
void setOnResponseReceived (fm.liveswitch.IAction1< fm.liveswitch.HttpResponseReceivedArgs > value)
 Sets the callback to invoke after the handshake response is received. More...
 
void setOnStreamFailure (fm.liveswitch.IAction1< fm.liveswitch.WebSocketStreamFailureArgs > value)
 Sets the callback to invoke when a successful connection breaks down. More...
 
void setOnSuccess (fm.liveswitch.IAction1< fm.liveswitch.WebSocketOpenSuccessArgs > value)
 Sets the callback to invoke when a successful connection has been established. More...
 
void setSender (Object value)
 Sets the sender of the request. More...
 
void setStreamTimeout (int value)
 Sets the timeout for the stream (in ms). More...
 
 WebSocketOpenArgs ()
 Creates a new instance of. More...
 
- Public Member Functions inherited from fm.liveswitch.Dynamic
java.util.HashMap< String, Object > getDynamicProperties ()
 Gets the dynamic properties on this instance. More...
 
Object getDynamicValue (String key)
 Gets a property value from the local cache. More...
 
void setDynamicValue (String key, Object value)
 Sets a property value in the local cache. More...
 
boolean unsetDynamicValue (String key)
 Unsets a property value in the local cache. More...
 

Additional Inherited Members

- Protected Member Functions inherited from fm.liveswitch.Dynamic
 Dynamic ()
 
- Protected Member Functions inherited from fm.liveswitch.Serializable
boolean getIsDirty ()
 Gets a value indicating whether this instance is dirty. More...
 
 Serializable ()
 Initializes a new instance of the fm.liveswitch.Serializable class. More...
 
void setIsDirty (boolean value)
 Sets a value indicating whether this instance is dirty. More...
 

Detailed Description

Open arguments for the fm.liveswitch.WebSocket class.

Constructor & Destructor Documentation

◆ WebSocketOpenArgs()

fm.liveswitch.WebSocketOpenArgs.WebSocketOpenArgs ( )

Creates a new instance of.

Member Function Documentation

◆ getHandshakeTimeout()

int fm.liveswitch.WebSocketOpenArgs.getHandshakeTimeout ( )

Gets the timeout for the handshake (in ms).

◆ getHeaders()

java.util.HashMap<String,String> fm.liveswitch.WebSocketOpenArgs.getHeaders ( )

Gets headers to send with the handshake request.

◆ getOnFailure()

fm.liveswitch.IAction1<fm.liveswitch.WebSocketOpenFailureArgs> fm.liveswitch.WebSocketOpenArgs.getOnFailure ( )

Gets the callback to invoke when a connection could not be established.

◆ getOnReceive()

fm.liveswitch.IAction1<fm.liveswitch.WebSocketReceiveArgs> fm.liveswitch.WebSocketOpenArgs.getOnReceive ( )

Gets the callback to invoke when a message is received.

◆ getOnRequestCreated()

fm.liveswitch.IAction1<fm.liveswitch.HttpRequestCreatedArgs> fm.liveswitch.WebSocketOpenArgs.getOnRequestCreated ( )

Gets the callback to invoke before the handshake request is sent.

◆ getOnResponseReceived()

fm.liveswitch.IAction1<fm.liveswitch.HttpResponseReceivedArgs> fm.liveswitch.WebSocketOpenArgs.getOnResponseReceived ( )

Gets the callback to invoke after the handshake response is received.

◆ getOnStreamFailure()

fm.liveswitch.IAction1<fm.liveswitch.WebSocketStreamFailureArgs> fm.liveswitch.WebSocketOpenArgs.getOnStreamFailure ( )

Gets the callback to invoke when a successful connection breaks down.

◆ getOnSuccess()

fm.liveswitch.IAction1<fm.liveswitch.WebSocketOpenSuccessArgs> fm.liveswitch.WebSocketOpenArgs.getOnSuccess ( )

Gets the callback to invoke when a successful connection has been established.

◆ getSender()

Object fm.liveswitch.WebSocketOpenArgs.getSender ( )

Gets the sender of the request.

◆ getStreamTimeout()

int fm.liveswitch.WebSocketOpenArgs.getStreamTimeout ( )

Gets the timeout for the stream (in ms).

◆ setHandshakeTimeout()

void fm.liveswitch.WebSocketOpenArgs.setHandshakeTimeout ( int  value)

Sets the timeout for the handshake (in ms).

◆ setHeaders()

void fm.liveswitch.WebSocketOpenArgs.setHeaders ( java.util.HashMap< String, String >  value)

Sets headers to send with the handshake request.

◆ setOnFailure()

void fm.liveswitch.WebSocketOpenArgs.setOnFailure ( fm.liveswitch.IAction1< fm.liveswitch.WebSocketOpenFailureArgs value)

Sets the callback to invoke when a connection could not be established.

◆ setOnReceive()

void fm.liveswitch.WebSocketOpenArgs.setOnReceive ( fm.liveswitch.IAction1< fm.liveswitch.WebSocketReceiveArgs value)

Sets the callback to invoke when a message is received.

◆ setOnRequestCreated()

void fm.liveswitch.WebSocketOpenArgs.setOnRequestCreated ( fm.liveswitch.IAction1< fm.liveswitch.HttpRequestCreatedArgs value)

Sets the callback to invoke before the handshake request is sent.

◆ setOnResponseReceived()

void fm.liveswitch.WebSocketOpenArgs.setOnResponseReceived ( fm.liveswitch.IAction1< fm.liveswitch.HttpResponseReceivedArgs value)

Sets the callback to invoke after the handshake response is received.

◆ setOnStreamFailure()

void fm.liveswitch.WebSocketOpenArgs.setOnStreamFailure ( fm.liveswitch.IAction1< fm.liveswitch.WebSocketStreamFailureArgs value)

Sets the callback to invoke when a successful connection breaks down.

◆ setOnSuccess()

void fm.liveswitch.WebSocketOpenArgs.setOnSuccess ( fm.liveswitch.IAction1< fm.liveswitch.WebSocketOpenSuccessArgs value)

Sets the callback to invoke when a successful connection has been established.

◆ setSender()

void fm.liveswitch.WebSocketOpenArgs.setSender ( Object  value)

Sets the sender of the request.

◆ setStreamTimeout()

void fm.liveswitch.WebSocketOpenArgs.setStreamTimeout ( int  value)

Sets the timeout for the stream (in ms).