fm.liveswitch.IWebSocket Interface Reference

Contract for an implementation of the WebSocket protocol v8. More...

Public Member Functions
abstract void	addOnLatestRoundTripTime (fm.liveswitch.IAction1< Integer > value)
	Adds a handler that is raised when the latest round trip time is calculated. More...
abstract void	close ()
	Closes the WebSocket connection. More...
abstract void	close (fm.liveswitch.WebSocketCloseArgs closeArgs)
	Closes the WebSocket connection. More...
abstract int	getBufferedAmount ()
	Gets the number of bytes buffered in the send queue. More...
abstract boolean	getIsOpen ()
	Gets a value indicating whether the WebSocket is connected. More...
abstract int	getLastRoundTripTime ()
	Gets the last round trip time. More...
abstract boolean	getSecure ()
	Gets a value indicating whether the WebSocket is secure. More...
abstract void	open (fm.liveswitch.WebSocketOpenArgs openArgs)
	Opens the WebSocket connection. More...
abstract void	removeOnLatestRoundTripTime (fm.liveswitch.IAction1< Integer > value)
	Removes a handler that is raised when the latest round trip time is calculated. More...
abstract void	send (fm.liveswitch.WebSocketSendArgs sendArgs)
	Sends a message to the WebSocket server. More...

Detailed Description

Contract for an implementation of the WebSocket protocol v8.

Member Function Documentation

addOnLatestRoundTripTime()

abstract void fm.liveswitch.IWebSocket.addOnLatestRoundTripTime ( fm.liveswitch.IAction1< Integer >  value )

abstract

Adds a handler that is raised when the latest round trip time is calculated.

close() [1/2]

abstract void fm.liveswitch.IWebSocket.close ( )

abstract

Closes the WebSocket connection.

Implemented in fm.liveswitch.WebSocket.

close() [2/2]

abstract void fm.liveswitch.IWebSocket.close ( fm.liveswitch.WebSocketCloseArgs  closeArgs )

abstract

Closes the WebSocket connection.

Parameters

closeArgs

The close arguments

Implemented in fm.liveswitch.WebSocket.

getBufferedAmount()

abstract int fm.liveswitch.IWebSocket.getBufferedAmount ( )

abstract

Gets the number of bytes buffered in the send queue.

Implemented in fm.liveswitch.WebSocket.

getIsOpen()

abstract boolean fm.liveswitch.IWebSocket.getIsOpen ( )

abstract

Gets a value indicating whether the WebSocket is connected.

Implemented in fm.liveswitch.WebSocket.

getLastRoundTripTime()

abstract int fm.liveswitch.IWebSocket.getLastRoundTripTime ( )

abstract

Gets the last round trip time.

getSecure()

abstract boolean fm.liveswitch.IWebSocket.getSecure ( )

abstract

Gets a value indicating whether the WebSocket is secure.

Implemented in fm.liveswitch.WebSocket.

open()

abstract void fm.liveswitch.IWebSocket.open ( fm.liveswitch.WebSocketOpenArgs  openArgs )

abstract

Opens the WebSocket connection.

Parameters

openArgs

The open arguments.

Implemented in fm.liveswitch.WebSocket.

removeOnLatestRoundTripTime()

abstract void fm.liveswitch.IWebSocket.removeOnLatestRoundTripTime ( fm.liveswitch.IAction1< Integer >  value )

abstract

Removes a handler that is raised when the latest round trip time is calculated.

send()

abstract void fm.liveswitch.IWebSocket.send ( fm.liveswitch.WebSocketSendArgs  sendArgs )

abstract

Sends a message to the WebSocket server.

Parameters

sendArgs

The send arguments.

Implemented in fm.liveswitch.WebSocket.