Module com.thecoderscorner.tcmenu.javaapi

Package com.thecoderscorner.menu.remote.socket

Class SocketBasedConnector

java.lang.Object

com.thecoderscorner.menu.remote.StreamRemoteConnector

com.thecoderscorner.menu.remote.socket.SocketBasedConnector

All Implemented Interfaces:

RemoteConnector, RemoteConnectorContext

public class SocketBasedConnector
extends StreamRemoteConnector

A remote connector that will communicate using a client socket. Normally configured with a host and port. Create using the builder below.

See Also:

SocketControllerBuilder

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
SocketBasedConnector(LocalIdentifier localId, java.util.concurrent.ScheduledExecutorService executor, java.time.Clock clock, MenuCommandProtocol protocol, java.lang.String remoteHost, int remotePort, ConnectMode mode)

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.
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, 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

SocketBasedConnector

public SocketBasedConnector(LocalIdentifier localId,
                            java.util.concurrent.ScheduledExecutorService executor,
                            java.time.Clock clock,
                            MenuCommandProtocol protocol,
                            java.lang.String remoteHost,
                            int remotePort,
                            ConnectMode mode)

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.

performConnection

public void performConnection()
                       throws java.io.IOException

Throws:

java.io.IOException

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.

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

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

getConnectionName

public java.lang.String getConnectionName()

Description copied from interface: RemoteConnector

Gets the name of this connector locally

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

Overrides:

close in class StreamRemoteConnector