Module com.thecoderscorner.tcmenu.javaapi

Package com.thecoderscorner.menu.remote.rs232

Class Rs232RemoteConnector

java.lang.Object

com.thecoderscorner.menu.remote.StreamRemoteConnector

com.thecoderscorner.menu.remote.rs232.Rs232RemoteConnector

All Implemented Interfaces:

RemoteConnector, RemoteConnectorContext

public class Rs232RemoteConnector
extends StreamRemoteConnector

This is the R232 connector that can talk to a tcMenu library application running on an embedded Arduino. Normally one uses the Rs232ControllerBuilder to construct the whole remote stack instead of creating this directly.

Nested Class Summary

Nested classes/interfaces inherited from class com.thecoderscorner.menu.remote.StreamRemoteConnector

StreamRemoteConnector.ReadMode

Field Summary

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

clock, executor, logger, stateMachineMappings

Constructor Summary

Constructors

Constructor	Description
Rs232RemoteConnector(LocalIdentifier localId, java.lang.String portName, int baud, MenuCommandProtocol protocol, java.util.concurrent.ScheduledExecutorService executor, java.time.Clock clock, ConnectMode connectMode)

Method Summary

Modifier and Type	Method	Description
protected 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.
java.lang.String	getConnectionName()	Gets the name of this connector locally
boolean	isDeviceConnected()	Indicates if the underlying device is actually connected.
void	performConnection()
protected void	sendInternal(java.nio.ByteBuffer outputBuffer)	performs a send of all bytes in the output buffer until the output buffer is empty
void	start()	Starts the communication channel, so it will attempt to connect with the configured device
void	stop()	Stops the library and attempts to also stop any threads and other resources associated.

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

changeState, changeState, close, doesBufferHaveEOM, getAuthenticationStatus, getClock, getRemoteParty, getScheduledExecutor, handleCoreConnectionStates, logByteBuffer, notifyConnection, notifyListeners, readCommandFromStream, readCompleteMessage, registerConnectionChangeListener, registerConnectorListener, sendAcknowledgement, sendHeartbeat, sendJoin, sendMenuCommand, sendPairing, setRemoteParty

Methods inherited from class java.lang.Object

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

Constructor Detail

Rs232RemoteConnector

public Rs232RemoteConnector(LocalIdentifier localId,
                            java.lang.String portName,
                            int baud,
                            MenuCommandProtocol protocol,
                            java.util.concurrent.ScheduledExecutorService executor,
                            java.time.Clock clock,
                            ConnectMode connectMode)

Method Detail

start

public void start()

Description copied from interface: RemoteConnector

Starts the communication channel, so it will attempt to connect with the configured device

stop

public void stop()

Description copied from interface: RemoteConnector

Stops the library and attempts to also stop any threads and other resources associated.

getConnectionName

public java.lang.String getConnectionName()

Description copied from interface: RemoteConnector

Gets the name of this connector locally

isDeviceConnected

public boolean isDeviceConnected()

Description copied from interface: RemoteConnector

Indicates if the underlying device is actually connected.

Returns:

true if the underlying device is connected

performConnection

public void performConnection()
                       throws java.io.IOException

Throws:

java.io.IOException

sendInternal

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

Description copied from class: StreamRemoteConnector

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

Specified by:

sendInternal in class StreamRemoteConnector

Parameters:

outputBuffer - the buffer data to be sent

Throws:

java.io.IOException - if there are problems writing

getAtLeastBytes

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

Description copied from class: StreamRemoteConnector

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

Specified by:

getAtLeastBytes in class StreamRemoteConnector

Parameters:

inputBuffer - the buffer to read from

len - the minimum number of bytes needed

Throws:

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