fm.liveswitch.IDataChannel< TDataChannel > Interface Template Reference

Data channel interface. More...

Public Member Functions
abstract void	addOnStateChange (fm.liveswitch.IAction1< TDataChannel > value)
	Adds a handler that is raised when the state changes. More...
abstract String	getId ()
	Gets the data channel identifier. More...
abstract fm.liveswitch.DataChannelInfo	getInfo ()
	Gets the data channel info. More...
abstract boolean	getIsInternal ()
	Gets a value indicating if this is an internal data channel. More...
abstract String	getLabel ()
	Gets the label. More...
abstract fm.liveswitch.IAction1< fm.liveswitch.DataChannelReceiveArgs >	getOnReceive ()
	Gets the callback to execute when a message is received. More...
abstract boolean	getOrdered ()
	Gets a value indicating whether messages will be delivered in the order they are sent. More...
abstract fm.liveswitch.DataChannelState	getState ()
	Gets the state. More...
abstract String	getSubprotocol ()
	Gets the subprotocol. More...
abstract void	removeOnStateChange (fm.liveswitch.IAction1< TDataChannel > value)
	Removes a handler that is raised when the state changes. More...
abstract fm.liveswitch.Future< Object >	sendDataBytes (fm.liveswitch.DataBuffer dataBytes)
	Sends a byte array. More...
abstract fm.liveswitch.Future< Object >	sendDataString (String dataString)
	Sends a string. More...
abstract void	setOnReceive (fm.liveswitch.IAction1< fm.liveswitch.DataChannelReceiveArgs > value)
	Sets the callback to execute when a message is received. More...

Detailed Description

Data channel interface.

Member Function Documentation

addOnStateChange()

abstract void fm.liveswitch.IDataChannel< TDataChannel >.addOnStateChange ( fm.liveswitch.IAction1< TDataChannel >  value )

abstract

Adds a handler that is raised when the state changes.

Implemented in fm.liveswitch.DataChannelBase< TDataChannel >.

getId()

abstract String fm.liveswitch.IDataChannel< TDataChannel >.getId ( )

abstract

Gets the data channel identifier.

Implemented in fm.liveswitch.DataChannelBase< TDataChannel >.

getInfo()

abstract fm.liveswitch.DataChannelInfo fm.liveswitch.IDataChannel< TDataChannel >.getInfo ( )

abstract

Gets the data channel info.

Implemented in fm.liveswitch.DataChannelBase< TDataChannel >.

getIsInternal()

abstract boolean fm.liveswitch.IDataChannel< TDataChannel >.getIsInternal ( )

abstract

Gets a value indicating if this is an internal data channel.

Implemented in fm.liveswitch.DataChannelBase< TDataChannel >.

getLabel()

abstract String fm.liveswitch.IDataChannel< TDataChannel >.getLabel ( )

abstract

Gets the label.

Implemented in fm.liveswitch.DataChannelBase< TDataChannel >.

getOnReceive()

abstract fm.liveswitch.IAction1<fm.liveswitch.DataChannelReceiveArgs> fm.liveswitch.IDataChannel< TDataChannel >.getOnReceive ( )

abstract

Gets the callback to execute when a message is received.

Implemented in fm.liveswitch.DataChannelBase< TDataChannel >.

getOrdered()

abstract boolean fm.liveswitch.IDataChannel< TDataChannel >.getOrdered ( )

abstract

Gets a value indicating whether messages will be delivered in the order they are sent.

Implemented in fm.liveswitch.DataChannelBase< TDataChannel >.

getState()

abstract fm.liveswitch.DataChannelState fm.liveswitch.IDataChannel< TDataChannel >.getState ( )

abstract

Gets the state.

Implemented in fm.liveswitch.DataChannelBase< TDataChannel >.

getSubprotocol()

abstract String fm.liveswitch.IDataChannel< TDataChannel >.getSubprotocol ( )

abstract

Gets the subprotocol.

Implemented in fm.liveswitch.DataChannelBase< TDataChannel >.

removeOnStateChange()

abstract void fm.liveswitch.IDataChannel< TDataChannel >.removeOnStateChange ( fm.liveswitch.IAction1< TDataChannel >  value )

abstract

Removes a handler that is raised when the state changes.

Implemented in fm.liveswitch.DataChannelBase< TDataChannel >.

sendDataBytes()

abstract fm.liveswitch.Future<Object> fm.liveswitch.IDataChannel< TDataChannel >.sendDataBytes ( fm.liveswitch.DataBuffer  dataBytes )

abstract

Sends a byte array.

Implemented in fm.liveswitch.DataChannelBase< TDataChannel >.

sendDataString()

abstract fm.liveswitch.Future<Object> fm.liveswitch.IDataChannel< TDataChannel >.sendDataString ( String  dataString )

abstract

Sends a string.

Implemented in fm.liveswitch.DataChannelBase< TDataChannel >.

setOnReceive()

abstract void fm.liveswitch.IDataChannel< TDataChannel >.setOnReceive ( fm.liveswitch.IAction1< fm.liveswitch.DataChannelReceiveArgs >  value )

abstract

Sets the callback to execute when a message is received.

Implemented in fm.liveswitch.DataChannelBase< TDataChannel >.