Module com.thecoderscorner.tcmenu.javaapi

Package com.thecoderscorner.menu.remote

Class StreamRemoteConnector

java.lang.Object

com.thecoderscorner.menu.remote.StreamRemoteConnector

All Implemented Interfaces:

RemoteConnector, RemoteConnectorContext

Direct Known Subclasses:

Rs232RemoteConnector, SocketBasedConnector

public abstract class StreamRemoteConnector
extends java.lang.Object
implements RemoteConnector, RemoteConnectorContext

Stream remote connector is the base class for all stream implementations, such as Socket and RS232. Any remote with stream like semantics can use this as the base for building out an adapter.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StreamRemoteConnector.ReadMode

Field Summary

Fields

Modifier and Type	Field	Description
protected java.time.Clock	clock
protected java.util.concurrent.ScheduledExecutorService	executor
protected java.lang.System.Logger	logger
protected java.util.Map<AuthStatus,java.lang.Class<? extends RemoteConnectorState>>	stateMachineMappings

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StreamRemoteConnector(LocalIdentifier ourLocalId, MenuCommandProtocol protocol, java.util.concurrent.ScheduledExecutorService executor, java.time.Clock clock)

Method Summary

Modifier and Type	Method	Description
void	changeState(AuthStatus desiredState)
void	changeState(RemoteConnectorState newState)
void	close()	Force close a connection when its known to be bad, the connector will try and establish a new connection.
static boolean	doesBufferHaveEOM(java.nio.ByteBuffer inputBuffer)
protected abstract void	getAtLeastBytes(java.nio.ByteBuffer inputBuffer, int len, StreamRemoteConnector.ReadMode mode)	Reads at least the number of bytes requested waiting if need be for more data.
AuthStatus	getAuthenticationStatus()
java.time.Clock	getClock()
RemoteInformation	getRemoteParty()
java.util.concurrent.ScheduledExecutorService	getScheduledExecutor()
protected void	handleCoreConnectionStates(ConnectMode connectMode)
protected void	logByteBuffer(java.lang.String msg, java.nio.ByteBuffer inBuffer)	Helper method that logs the entire message buffer when at debug logging level.
protected void	notifyConnection()	Helper method that notifies all connection listeners of a change in connectivity
void	notifyListeners(MenuCommand mc)	Helper method that notifies all listeners of a new command message
MenuCommand	readCommandFromStream()
protected void	readCompleteMessage(java.nio.ByteBuffer inputBuffer)
void	registerConnectionChangeListener(ConnectionChangeListener listener)	Register for connection change events, when there is a change in connectivity status on the underlying transport.
void	registerConnectorListener(RemoteConnectorListener listener)	Register for connector messages, when new messages are received from this stream.
void	sendAcknowledgement(AckStatus ackStatus)
void	sendHeartbeat(int frequency, MenuHeartbeatCommand.HeartbeatMode mode)
protected abstract void	sendInternal(java.nio.ByteBuffer outputBuffer)	performs a send of all bytes in the output buffer until the output buffer is empty
void	sendJoin()
void	sendMenuCommand(MenuCommand msg)	Sends a command to the remote with the protocol and usual headers.
void	sendPairing()
void	setRemoteParty(RemoteInformation remote)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.thecoderscorner.menu.remote.RemoteConnector

getConnectionName, isDeviceConnected, start, stop

Methods inherited from interface com.thecoderscorner.menu.remote.states.RemoteConnectorContext

getConnectionName, isDeviceConnected, performConnection

Field Detail

logger

protected final java.lang.System.Logger logger

executor

protected final java.util.concurrent.ScheduledExecutorService executor

clock

protected final java.time.Clock clock

stateMachineMappings

protected final java.util.Map<AuthStatus,java.lang.Class<? extends RemoteConnectorState>> stateMachineMappings

Constructor Detail

StreamRemoteConnector

protected StreamRemoteConnector(LocalIdentifier ourLocalId,
                                MenuCommandProtocol protocol,
                                java.util.concurrent.ScheduledExecutorService executor,
                                java.time.Clock clock)

Method Detail

readCommandFromStream

public MenuCommand readCommandFromStream()
                                  throws java.io.IOException

Specified by:

readCommandFromStream in interface RemoteConnectorContext

Throws:

java.io.IOException

close

public void close()

Description copied from interface: RemoteConnector

Force close a connection when its known to be bad, the connector will try and establish a new connection.

Specified by:

close in interface RemoteConnector

Specified by:

close in interface RemoteConnectorContext

sendMenuCommand

public void sendMenuCommand(MenuCommand msg)
                     throws java.io.IOException

Sends a command to the remote with the protocol and usual headers.

Specified by:

sendMenuCommand in interface RemoteConnector

Parameters:

msg - the message to send.

Throws:

java.io.IOException - if there are issues with the transport

handleCoreConnectionStates

protected void handleCoreConnectionStates(ConnectMode connectMode)

sendInternal

protected abstract void sendInternal(java.nio.ByteBuffer outputBuffer)
                              throws java.io.IOException

performs a send of all bytes in the output buffer until the output buffer is empty

Parameters:

outputBuffer - the buffer data to be sent

Throws:

java.io.IOException - if there are problems writing

getAtLeastBytes

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

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

Parameters:

inputBuffer - the buffer to read from

len - the minimum number of bytes needed

Throws:

java.io.IOException - if there are problems reading.

readCompleteMessage

protected void readCompleteMessage(java.nio.ByteBuffer inputBuffer)
                            throws java.io.IOException

Throws:

java.io.IOException

registerConnectorListener

public void registerConnectorListener(RemoteConnectorListener listener)

Register for connector messages, when new messages are received from this stream.

Specified by:

registerConnectorListener in interface RemoteConnector

Parameters:

listener - the listener to be registered

registerConnectionChangeListener

public void registerConnectionChangeListener(ConnectionChangeListener listener)

Register for connection change events, when there is a change in connectivity status on the underlying transport.

Specified by:

registerConnectionChangeListener in interface RemoteConnector

Parameters:

listener - the listener

notifyListeners

public void notifyListeners(MenuCommand mc)

Helper method that notifies all listeners of a new command message

Specified by:

notifyListeners in interface RemoteConnectorContext

Parameters:

mc - the message to notify

notifyConnection

protected void notifyConnection()

Helper method that notifies all connection listeners of a change in connectivity

logByteBuffer

protected void logByteBuffer(java.lang.String msg,
                             java.nio.ByteBuffer inBuffer)

Helper method that logs the entire message buffer when at debug logging level.

Parameters:

msg - the message to print first

inBuffer - the buffer to be logged

doesBufferHaveEOM

public static boolean doesBufferHaveEOM(java.nio.ByteBuffer inputBuffer)

changeState

public void changeState(AuthStatus desiredState)

Specified by:

changeState in interface RemoteConnectorContext

changeState

public void changeState(RemoteConnectorState newState)

Specified by:

changeState in interface RemoteConnectorContext

getRemoteParty

public RemoteInformation getRemoteParty()

Specified by:

getRemoteParty in interface RemoteConnector

Returns:

the remote party information of the current connection

setRemoteParty

public void setRemoteParty(RemoteInformation remote)

Specified by:

setRemoteParty in interface RemoteConnectorContext

getAuthenticationStatus

public AuthStatus getAuthenticationStatus()

Specified by:

getAuthenticationStatus in interface RemoteConnector

Returns:

the status of the connection and authentication.

sendHeartbeat

public void sendHeartbeat(int frequency,
                          MenuHeartbeatCommand.HeartbeatMode mode)

Specified by:

sendHeartbeat in interface RemoteConnectorContext

sendJoin

public void sendJoin()
              throws java.io.IOException

Specified by:

sendJoin in interface RemoteConnectorContext

Throws:

java.io.IOException

sendAcknowledgement

public void sendAcknowledgement(AckStatus ackStatus)
                         throws java.io.IOException

Specified by:

sendAcknowledgement in interface RemoteConnectorContext

Throws:

java.io.IOException

sendPairing

public void sendPairing()
                 throws java.io.IOException

Specified by:

sendPairing in interface RemoteConnectorContext

Throws:

java.io.IOException

getScheduledExecutor

public java.util.concurrent.ScheduledExecutorService getScheduledExecutor()

Specified by:

getScheduledExecutor in interface RemoteConnectorContext

getClock

public java.time.Clock getClock()

Specified by:

getClock in interface RemoteConnectorContext