Module com.thecoderscorner.tcmenu.javaapi

Package com.thecoderscorner.menu.remote.mgrclient

Class SocketServerConnection

java.lang.Object

com.thecoderscorner.menu.remote.SharedStreamConnection

com.thecoderscorner.menu.remote.mgrclient.SocketServerConnection

All Implemented Interfaces:

ServerConnection, RemoteDevice

public class SocketServerConnection
extends SharedStreamConnection
implements ServerConnection

Field Summary

Fields inherited from class com.thecoderscorner.menu.remote.SharedStreamConnection

cmdBuffer, inputBuffer, MAX_MSG_EXPECTED, protocol

Constructor Summary

Constructors

Constructor	Description
SocketServerConnection(Socket socket, MenuCommandProtocol protocol, Clock clock)

Method Summary

Modifier and Type	Method	Description
boolean	canSendMessageNow(MenuCommand cmd)
void	closeConnection()	close the current connection if it is open
protected void	getAtLeastBytes(ByteBuffer inputBuffer, int len, StreamRemoteConnector.ReadMode mode)	Reads at least the number of bytes requested waiting if need be for more data.
ServerConnectionMode	getConnectionMode()
String	getConnectionName()
int	getHeartbeatFrequency()
String	getUserName()	get the username of this connection
boolean	isDeviceConnected()
long	lastReceivedHeartbeat()
long	lastTransmittedHeartbeat()
void	registerConnectionListener(BiConsumer<ServerConnection,Boolean> connectionListener)	Register the connection listener to this connection that will receive udpates on connection changes.
void	registerMessageHandler(BiConsumer<ServerConnection,MenuCommand> messageHandler)	Register the message handler that will receive all messages from the connection
void	sendCommand(MenuCommand command)	Send a command to the remote
protected void	sendInternal(ByteBuffer cmdBuffer)
void	setConnectionMode(ServerConnectionMode mode)	Set the connection mode for this connection, usually called by the menu manager to indicate state
String	toString()

Methods inherited from class com.thecoderscorner.menu.remote.SharedStreamConnection

connectionLog, doesBufferHaveEOM, logByteBuffer, readCommandFromStream, readCompleteMessage, sendMenuCommand

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

SocketServerConnection

public SocketServerConnection(Socket socket,
 MenuCommandProtocol protocol,
 Clock clock)

Method Details

getHeartbeatFrequency

public int getHeartbeatFrequency()

Specified by:

getHeartbeatFrequency in interface ServerConnection

Returns:

the heartbeat frequency for this connection

closeConnection

public void closeConnection()

Description copied from interface: ServerConnection

close the current connection if it is open

Specified by:

closeConnection in interface ServerConnection

lastReceivedHeartbeat

public long lastReceivedHeartbeat()

Specified by:

lastReceivedHeartbeat in interface ServerConnection

Returns:

the last time a message was received

lastTransmittedHeartbeat

public long lastTransmittedHeartbeat()

Specified by:

lastTransmittedHeartbeat in interface ServerConnection

Returns:

the last successful message transmission

sendCommand

public void sendCommand(MenuCommand command)

Description copied from interface: ServerConnection

Send a command to the remote

Specified by:

sendCommand in interface ServerConnection

Parameters:

command - the command to send

registerConnectionListener

public void registerConnectionListener(BiConsumer<ServerConnection,Boolean> connectionListener)

Description copied from interface: ServerConnection

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

Specified by:

registerConnectionListener in interface ServerConnection

Parameters:

connectionListener - the connection state

registerMessageHandler

public void registerMessageHandler(BiConsumer<ServerConnection,MenuCommand> messageHandler)

Description copied from interface: ServerConnection

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

Specified by:

registerMessageHandler in interface ServerConnection

Parameters:

messageHandler - the message handler

setConnectionMode

public void setConnectionMode(ServerConnectionMode mode)

Description copied from interface: ServerConnection

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

Specified by:

setConnectionMode in interface ServerConnection

Parameters:

mode - the mode

getConnectionMode

public ServerConnectionMode getConnectionMode()

Specified by:

getConnectionMode in interface ServerConnection

Returns:

the connection mode for this connection

getUserName

public String getUserName()

Description copied from interface: ServerConnection

get the username of this connection

Specified by:

getUserName in interface RemoteDevice

Specified by:

getUserName in interface ServerConnection

Returns:

the username

getConnectionName

public String getConnectionName()

Specified by:

getConnectionName in interface RemoteDevice

Specified by:

getConnectionName in class SharedStreamConnection

getAtLeastBytes

protected void getAtLeastBytes(ByteBuffer inputBuffer,
 int len,
 StreamRemoteConnector.ReadMode mode)
                        throws IOException

Description copied from class: SharedStreamConnection

Reads at least the number of bytes requested waiting if need be for more data.

Specified by:

getAtLeastBytes in class SharedStreamConnection

Parameters:

inputBuffer - the buffer to read from

len - the minimum number of bytes needed

Throws:

IOException - if there are problems reading.

sendInternal

protected void sendInternal(ByteBuffer cmdBuffer)
                     throws IOException

Specified by:

sendInternal in class SharedStreamConnection

Throws:

IOException

isDeviceConnected

public boolean isDeviceConnected()

Specified by:

isDeviceConnected in class SharedStreamConnection

canSendMessageNow

public boolean canSendMessageNow(MenuCommand cmd)

Specified by:

canSendMessageNow in class SharedStreamConnection

toString

public String toString()

Overrides:

toString in class Object