com.clover.remote.client.transport

Class CloverTransport

java.lang.Object

com.clover.remote.client.transport.CloverTransport

All Implemented Interfaces:

ICloverTransport

Direct Known Subclasses:

DualDisplayCloverTransport, NativeCloverTransport, USBCloverTransport, WebSocketCloverTransport

public abstract class CloverTransport
extends java.lang.Object
implements ICloverTransport

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEVICE_CONNECTED
static java.lang.String	DEVICE_DISCONNECTED
static java.lang.String	DEVICE_READY

Constructor Summary

Constructors

Constructor and Description
CloverTransport()

Method Summary

Modifier and Type	Method and Description
void	addObserver(ICloverTransportObserver observer) Registers a listener to receive connect events and messages from the transport
void	dispose() Closes the connection to the underlying transport
int	getRemoteMessageVersion()
protected void	notifyDeviceConnected() Should be called by subclasses (super.notifyDeviceConnected) when the device connects (but is not ready) in order to forward to all observers
protected void	notifyDeviceDisconnected() Should be called by subclasses (super.notifyDeviceDisconnected) when the device disconnects in order to forward to all observers
protected void	notifyDeviceReady() Should be called by subclasses (super.notifyDeviceReady) when the device is ready to process messages in order to forward to all observers
protected void	onMessage(java.lang.String message) Should be called by subclasses (super.onMessage) when a message is received in order to forward to all observers
void	removeObserver(ICloverTransportObserver observer) Remove a previously added listener.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.clover.remote.client.transport.ICloverTransport

initializeConnection, sendMessage

Field Detail

DEVICE_CONNECTED

public static final java.lang.String DEVICE_CONNECTED

See Also:

Constant Field Values

DEVICE_READY

public static final java.lang.String DEVICE_READY

See Also:

Constant Field Values

DEVICE_DISCONNECTED

public static final java.lang.String DEVICE_DISCONNECTED

See Also:

Constant Field Values

Constructor Detail

CloverTransport

public CloverTransport()

Method Detail

notifyDeviceConnected

protected void notifyDeviceConnected()

Should be called by subclasses (super.notifyDeviceConnected) when the device connects (but is not ready) in order to forward to all observers

notifyDeviceReady

protected void notifyDeviceReady()

Should be called by subclasses (super.notifyDeviceReady) when the device is ready to process messages in order to forward to all observers

notifyDeviceDisconnected

protected void notifyDeviceDisconnected()

Should be called by subclasses (super.notifyDeviceDisconnected) when the device disconnects in order to forward to all observers

onMessage

protected void onMessage(java.lang.String message)

Should be called by subclasses (super.onMessage) when a message is received in order to forward to all observers

Parameters:

message - message to forward

getRemoteMessageVersion

public int getRemoteMessageVersion()

addObserver

public void addObserver(ICloverTransportObserver observer)

Description copied from interface: ICloverTransport

Registers a listener to receive connect events and messages from the transport

Specified by:

addObserver in interface ICloverTransport

Parameters:

observer - listener to add

removeObserver

public void removeObserver(ICloverTransportObserver observer)

Description copied from interface: ICloverTransport

Remove a previously added listener. If the provided listener is not registered, this call has no effect.

Specified by:

removeObserver in interface ICloverTransport

Parameters:

observer - listener to remove

dispose

public void dispose()

Description copied from interface: ICloverTransport

Closes the connection to the underlying transport

Specified by:

dispose in interface ICloverTransport