Package de.iip_ecosphere.platform.connectors

Class AbstractThreadedQueuingConnector<O,I,CO,CI,M extends ModelAccess>

java.lang.Object

de.iip_ecosphere.platform.connectors.AbstractConnector<O,I,CO,CI>

de.iip_ecosphere.platform.connectors.AbstractThreadedConnector<O,I,CO,CI,M>

de.iip_ecosphere.platform.connectors.AbstractThreadedQueuingConnector<O,I,CO,CI,M>

Type Parameters:

O - the output type from the underlying machine/platform

I - the input type to the underlying machine/platform

CO - the output type of the connector

CI - the input type of the connector

M - the model access type of the connector

All Implemented Interfaces:

Connector<O,I,CO,CI>, EventHandlingConnector, AbstractModelAccess.NotificationChangedListener

public abstract class AbstractThreadedQueuingConnector<O,I,CO,CI,M extends ModelAccess>
extends AbstractThreadedConnector<O,I,CO,CI,M>

Queues incoming data for sequential delayed processing. Further, provides a reusable base for connectors that require a ModelAccess instance per calling thread. Call startQueueProcessing() in AbstractConnector.connectImpl(ConnectorParameter) and stopQueueProcessing() in AbstractConnector.disconnectImpl().

Author:

Holger Eichelberger, SSE

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	AbstractThreadedQueuingConnector.QueueProcessor	Processes the queue.

Nested classes/interfaces inherited from class de.iip_ecosphere.platform.connectors.AbstractConnector

AbstractConnector.BasicAdapterProvider

Field Summary

Fields

Modifier and Type	Field	Description
private final SharedBuffer<CI>	queue
private final AbstractThreadedQueuingConnector<O,I,CO,CI,M>.QueueProcessor	queueProcessor

Fields inherited from class de.iip_ecosphere.platform.connectors.AbstractConnector

DEFAULT_CHANNEL

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractThreadedQueuingConnector(AdapterSelector<O,I,CO,CI> selector, ProtocolAdapter<O,I,CO,CI>... adapter)	Creates an instance and installs the protocol adapter(s).
protected	AbstractThreadedQueuingConnector(ProtocolAdapter<O,I,CO,CI>... adapter)	Creates an instance and installs the protocol adapter(s) with a default selector for the first adapter.

Method Summary

Modifier and Type	Method	Description
private void	origWrite(CI data)	The original implementation of write(Object), overwritten for queuing in this class.
protected void	startQueueProcessing()	Starts queue processing.
protected void	stopQueueProcessing()	Stops queue processing.
void	write(CI data)	Writes the given data to the underlying machine/platform.

Methods inherited from class de.iip_ecosphere.platform.connectors.AbstractThreadedConnector

configureAdapter, connect, getCleanupPeriod, getModelAccess, getModelAccess, getModelAccessSupplier, setCleanupPeriod, setModelAccessSupplier, uninstallPollTask

Methods inherited from class de.iip_ecosphere.platform.connectors.AbstractConnector

checkCache, configureModelAccess, connectImpl, createTlsContext, disconnect, disconnectImpl, dispose, doPolling, enableNotifications, enablePolling, error, getCachingStrategy, getCachingStrategyCls, getConnectorInputType, getConnectorOutputType, getConnectorParameter, getInitCachingStrategyCls, getInstanceIdentification, getProtocolInputType, getProtocolOutputType, getSelector, getStorageValue, initializeModelAccess, initSelector, installPollTask, isPolling, notificationsChanged, notifyDataTimeDifference, notifyReconfigured, read, received, received, request, request, setDataTimeDifference, setDataTimeDifferenceProvider, setInstanceIdentification, setReceptionCallback, setStorageValue, trigger, trigger, useTls, writeImpl

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.iip_ecosphere.platform.connectors.Connector

createSharedSpace, disconnectSafe, enabledEncryption, enableSharedSpace, enumerateFields, enumerateFields, setReceptionCallbackSafe, supportedEncryption

Methods inherited from interface de.iip_ecosphere.platform.connectors.events.EventHandlingConnector

getName

Field Details

queue

private final SharedBuffer<CI> queue

queueProcessor

private final AbstractThreadedQueuingConnector<O,I,CO,CI,M extends ModelAccess>.QueueProcessor queueProcessor

Constructor Details

AbstractThreadedQueuingConnector

@SafeVarargs
protected AbstractThreadedQueuingConnector(ProtocolAdapter<O,I,CO,CI>... adapter)

Creates an instance and installs the protocol adapter(s) with a default selector for the first adapter. For integration compatibility, connector constructors are supposed to accept a var-arg parameter for adapters.

Parameters:

adapter - the protocol adapter(s)

Throws:

IllegalArgumentException - if adapter is null or empty or adapters are null

See Also:

• AbstractThreadedConnector.setModelAccessSupplier(Supplier)

AbstractThreadedQueuingConnector

@SafeVarargs
protected AbstractThreadedQueuingConnector(AdapterSelector<O,I,CO,CI> selector,
 ProtocolAdapter<O,I,CO,CI>... adapter)

Creates an instance and installs the protocol adapter(s). For integration compatibility, connector constructors are supposed to accept a var-arg parameter for adapters.

Parameters:

selector - the adapter selector (null leads to a default selector for the first adapter)

adapter - the protocol adapter(s)

Throws:

IllegalArgumentException - if adapter is null or empty or adapters are null

See Also:

• AbstractThreadedConnector.setModelAccessSupplier(Supplier)

Method Details

startQueueProcessing

protected void startQueueProcessing()

Starts queue processing. If not called, data is queued but not processed.

stopQueueProcessing

protected void stopQueueProcessing()

Stops queue processing.

write

public void write(CI data)
           throws IOException

Description copied from interface: Connector

Writes the given data to the underlying machine/platform.

Specified by:

write in interface Connector<O,I,CO,CI>

Overrides:

write in class AbstractConnector<O,I,CO,CI>

Parameters:

data - the data to send to stream

Throws:

IOException - in case that problems during the connection happens

origWrite

private void origWrite(CI data)
                throws IOException

The original implementation of write(Object), overwritten for queuing in this class. Writes the given data to the underlying machine/platform.

Parameters:

data - the data to send to stream

Throws:

IOException - in case that problems during the connection happens