com.thecoderscorner.menu.mgr.ServerConnection Interface Reference

Inheritance diagram for com.thecoderscorner.menu.mgr.ServerConnection:

Public Member Functions
int	getHeartbeatFrequency ()
void	closeConnection ()
long	lastReceivedHeartbeat ()
long	lastTransmittedHeartbeat ()
void	sendCommand (MenuCommand command)
void	registerConnectionListener (BiConsumer< ServerConnection, Boolean > connectionListener)
void	registerMessageHandler (BiConsumer< ServerConnection, MenuCommand > messageHandler)
void	setConnectionMode (ServerConnectionMode mode)
ServerConnectionMode	getConnectionMode ()
String	getUserName ()
Public Member Functions inherited from com.thecoderscorner.menu.remote.RemoteDevice
String	getConnectionName ()

Detailed Description

Each connection from a remote is represented by a class implementing this interface. MenuManagerServer holds a series of ServerConnectionManager objects, that in turn contain a series of these connections. Running connections are managed by MenuManagerServer where it will deal with heartbeating, bootstrapping, incoming updates and sending local updates to the remote.

See also

MenuManagerServer

ServerConnectionManager

Member Function Documentation

closeConnection()

void com.thecoderscorner.menu.mgr.ServerConnection.closeConnection

(

)

close the current connection if it is open

Implemented in com.thecoderscorner.menu.remote.mgrclient.SocketServerConnection.

getConnectionMode()

ServerConnectionMode com.thecoderscorner.menu.mgr.ServerConnection.getConnectionMode

(

)

Returns

the connection mode for this connection

Implemented in com.thecoderscorner.menu.remote.mgrclient.SocketServerConnection.

getHeartbeatFrequency()

int com.thecoderscorner.menu.mgr.ServerConnection.getHeartbeatFrequency

(

)

Returns

the heartbeat frequency for this connection

Implemented in com.thecoderscorner.menu.remote.mgrclient.SocketServerConnection.

getUserName()

String com.thecoderscorner.menu.mgr.ServerConnection.getUserName

(

)

get the username of this connection

Returns

the username

Implements com.thecoderscorner.menu.remote.RemoteDevice.

Implemented in com.thecoderscorner.menu.remote.mgrclient.SocketServerConnection.

lastReceivedHeartbeat()

long com.thecoderscorner.menu.mgr.ServerConnection.lastReceivedHeartbeat

(

)

Returns

the last time a message was received

Implemented in com.thecoderscorner.menu.remote.mgrclient.SocketServerConnection.

lastTransmittedHeartbeat()

long com.thecoderscorner.menu.mgr.ServerConnection.lastTransmittedHeartbeat

(

)

Returns

the last successful message transmission

Implemented in com.thecoderscorner.menu.remote.mgrclient.SocketServerConnection.

registerConnectionListener()

void com.thecoderscorner.menu.mgr.ServerConnection.registerConnectionListener

(

BiConsumer< ServerConnection, Boolean >

connectionListener

)

Register the connection listener to this connection that will receive udpates on connection changes.

Parameters

connectionListener

the connection state

Implemented in com.thecoderscorner.menu.remote.mgrclient.SocketServerConnection.

registerMessageHandler()

void com.thecoderscorner.menu.mgr.ServerConnection.registerMessageHandler

(

BiConsumer< ServerConnection, MenuCommand >

messageHandler

)

Register the message handler that will receive all messages from the connection

Parameters

messageHandler

the message handler

Implemented in com.thecoderscorner.menu.remote.mgrclient.SocketServerConnection.

sendCommand()

void com.thecoderscorner.menu.mgr.ServerConnection.sendCommand

(

MenuCommand

command

)

Send a command to the remote

Parameters

command

the command to send

Implemented in com.thecoderscorner.menu.remote.mgrclient.SocketServerConnection.

setConnectionMode()

void com.thecoderscorner.menu.mgr.ServerConnection.setConnectionMode

(

ServerConnectionMode

mode

)

Set the connection mode for this connection, usually called by the menu manager to indicate state

Parameters

mode

the mode

Implemented in com.thecoderscorner.menu.remote.mgrclient.SocketServerConnection.

---

The documentation for this interface was generated from the following file:

• src/main/java/com/thecoderscorner/menu/mgr/ServerConnection.java