fm.liveswitch.IWebSocket Interface Reference

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

Public Member Functions

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 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 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

◆ 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
closeArgsThe 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.

◆ 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
openArgsThe open arguments.

Implemented in fm.liveswitch.WebSocket.

◆ send()

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

Sends a message to the WebSocket server.

Parameters
sendArgsThe send arguments.

Implemented in fm.liveswitch.WebSocket.