Package com.thecoderscorner.menu.remote.rs232

Class Rs232RemoteConnector

java.lang.Object

com.thecoderscorner.menu.remote.rs232.Rs232RemoteConnector

All Implemented Interfaces:

RemoteConnector

public class Rs232RemoteConnector
extends Object
implements RemoteConnector

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.

Constructor Summary

Constructors

Constructor	Description
Rs232RemoteConnector(String portName, int baud, MenuCommandProtocol protocol, ScheduledExecutorService executor)

Method Summary

Modifier and Type	Method	Description
void	close()	Force close a connection when its known to be bad, the connector will try and establish a new connection.
String	getConnectionName()	Gets the name of this connector locally (for example rs232-comport)
boolean	isConnected()	Gets the underlying connection state for this connector.
void	registerConnectionChangeListener(ConnectionChangeListener listener)	Register for information about connection state
void	registerConnectorListener(RemoteConnectorListener listener)	register a listener that will receive any messages sent by the menu library
void	sendMenuCommand(MenuCommand msg)	Sends a command to the menu library running on the embedded hardware.
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 java.lang.Object

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

Constructor Detail

Rs232RemoteConnector

public Rs232RemoteConnector(String portName,
                            int baud,
                            MenuCommandProtocol protocol,
                            ScheduledExecutorService executor)

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

Specified by:

start in interface RemoteConnector

stop

public void stop()

Description copied from interface: RemoteConnector

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

Specified by:

stop in interface RemoteConnector

sendMenuCommand

public void sendMenuCommand(MenuCommand msg)
                     throws IOException

Description copied from interface: RemoteConnector

Sends a command to the menu library running on the embedded hardware. If not connected the action is connector dependent.

Specified by:

sendMenuCommand in interface RemoteConnector

Parameters:

msg - the message to send.

Throws:

IOException

isConnected

public boolean isConnected()

Description copied from interface: RemoteConnector

Gets the underlying connection state for this connector.

Specified by:

isConnected in interface RemoteConnector

Returns:

the underlying connection state.

getConnectionName

public String getConnectionName()

Description copied from interface: RemoteConnector

Gets the name of this connector locally (for example rs232-comport)

Specified by:

getConnectionName in interface RemoteConnector

registerConnectorListener

public void registerConnectorListener(RemoteConnectorListener listener)

Description copied from interface: RemoteConnector

register a listener that will receive any messages sent by the menu library

Specified by:

registerConnectorListener in interface RemoteConnector

Parameters:

listener - the listener

registerConnectionChangeListener

public void registerConnectionChangeListener(ConnectionChangeListener listener)

Description copied from interface: RemoteConnector

Register for information about connection state

Specified by:

registerConnectionChangeListener in interface RemoteConnector

Parameters:

listener - the listener

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