com.thecoderscorner.menu.remote.RemoteConnector Interface Reference

Inheritance diagram for com.thecoderscorner.menu.remote.RemoteConnector:

Public Member Functions
void	start ()
void	stop ()
void	sendMenuCommand (MenuCommand msg) throws IOException
String	getConnectionName ()
void	registerConnectorListener (RemoteConnectorListener listener)
void	registerConnectionChangeListener (ConnectionChangeListener listener)
void	close ()
boolean	isDeviceConnected ()
RemoteInformation	getRemoteParty ()
AuthStatus	getAuthenticationStatus ()
Public Member Functions inherited from com.thecoderscorner.menu.remote.RemoteDevice
String	getUserName ()

Detailed Description

This is the base interface implemented by all remote connectors, it provides the means to both send and receive menu commands. Most people just wanting to use a menu remotely won't need to understand the connector layer beyond creating a connector.

Member Function Documentation

close()

void com.thecoderscorner.menu.remote.RemoteConnector.close

(

)

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

Implemented in com.thecoderscorner.menu.remote.StreamRemoteConnector, and com.thecoderscorner.menu.remote.socket.SocketBasedConnector.

getAuthenticationStatus()

AuthStatus com.thecoderscorner.menu.remote.RemoteConnector.getAuthenticationStatus

(

)

Returns

the status of the connection and authentication.

Implemented in com.thecoderscorner.menu.remote.StreamRemoteConnector.

getConnectionName()

String com.thecoderscorner.menu.remote.RemoteConnector.getConnectionName

(

)

Gets the name of this connector locally

Implements com.thecoderscorner.menu.remote.RemoteDevice.

Implemented in com.thecoderscorner.menu.remote.socket.SocketBasedConnector.

getRemoteParty()

RemoteInformation com.thecoderscorner.menu.remote.RemoteConnector.getRemoteParty

(

)

Returns

the remote party information of the current connection

Implemented in com.thecoderscorner.menu.remote.StreamRemoteConnector.

isDeviceConnected()

boolean com.thecoderscorner.menu.remote.RemoteConnector.isDeviceConnected

(

)

Indicates if the underlying device is actually connected.

Returns

true if the underlying device is connected

Implemented in com.thecoderscorner.menu.remote.socket.SocketBasedConnector.

registerConnectionChangeListener()

void com.thecoderscorner.menu.remote.RemoteConnector.registerConnectionChangeListener

(

ConnectionChangeListener

listener

)

Register for information about connection state

Parameters

listener

the listener

Implemented in com.thecoderscorner.menu.remote.StreamRemoteConnector.

registerConnectorListener()

void com.thecoderscorner.menu.remote.RemoteConnector.registerConnectorListener

(

RemoteConnectorListener

listener

)

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

Parameters

listener

the listener

Implemented in com.thecoderscorner.menu.remote.StreamRemoteConnector.

sendMenuCommand()

void com.thecoderscorner.menu.remote.RemoteConnector.sendMenuCommand

(

MenuCommand

msg

)

throws IOException

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

Parameters

msg	the message to send.

start()

void com.thecoderscorner.menu.remote.RemoteConnector.start

(

)

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

Implemented in com.thecoderscorner.menu.remote.socket.SocketBasedConnector.

stop()

void com.thecoderscorner.menu.remote.RemoteConnector.stop

(

)

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

Implemented in com.thecoderscorner.menu.remote.socket.SocketBasedConnector.

---

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

• src/main/java/com/thecoderscorner/menu/remote/RemoteConnector.java