org.refcodes.connection.ext.observable

Class ObservableBidirectionalRequestTransceiverImpl<DATA extends Serializable,INPUT,OUTPUT>

java.lang.Object

org.refcodes.connection.ext.observable.ObservableBidirectionalRequestTransceiverImpl<DATA,INPUT,OUTPUT>

Type Parameters:

DATA - The type of the datagram to be operated with.

INPUT - the generic type

OUTPUT - the generic type

All Implemented Interfaces:

Flushable, org.refcodes.component.BidirectionalConnectionComponent<INPUT,OUTPUT>, org.refcodes.component.BidirectionalConnectionComponent.BidirectionalConnectionAutomaton<INPUT,OUTPUT>, org.refcodes.component.BidirectionalConnectionOpenable<INPUT,OUTPUT>, org.refcodes.component.BidirectionalConnectionOpenable.BidirectionalConnectionOpenAutomaton<INPUT,OUTPUT>, org.refcodes.component.Closable, org.refcodes.component.Closable.CloseAutomaton, org.refcodes.component.ClosedAccessor, org.refcodes.component.Component, org.refcodes.component.ConnectableComponent, org.refcodes.component.ConnectableComponent.ConnectableAutomaton, org.refcodes.component.ConnectionStatusAccessor, org.refcodes.component.Destroyable, org.refcodes.component.OpenedAccessor, ObservableBidirectionalTransceiver.ObservableBidirectionalRequestTransceiver<DATA,INPUT,OUTPUT>, org.refcodes.io.BidirectionalConnectionTransceiver<DATA,INPUT,OUTPUT>, org.refcodes.io.BlockConsumer<DATA>, org.refcodes.io.BlockProvider<DATA>, org.refcodes.io.BlockReceiver<DATA>, org.refcodes.io.BlockSender<DATA>, org.refcodes.io.Consumer<DATA>, org.refcodes.io.DatagramConsumer<DATA>, org.refcodes.io.DatagramProvider<DATA>, org.refcodes.io.DatagramReceiver<DATA>, org.refcodes.io.DatagramSender<DATA>, org.refcodes.io.DatagramTransceiver<DATA>, org.refcodes.io.Provider<DATA>, org.refcodes.io.Receivable, org.refcodes.io.Receiver<DATA>, org.refcodes.io.Sendable, org.refcodes.io.Sender<DATA>, org.refcodes.io.Transceiver<DATA>, org.refcodes.mixin.Releaseable, org.refcodes.observer.Observable<org.refcodes.component.ext.observer.ConnectionObserver.ConnectionRequestObserver>

public class ObservableBidirectionalRequestTransceiverImpl<DATA extends Serializable,INPUT,OUTPUT>
extends Object
implements ObservableBidirectionalTransceiver.ObservableBidirectionalRequestTransceiver<DATA,INPUT,OUTPUT>

The ObservableBidirectionalRequestTransceiverImpl implements the ObservableBidirectionalTransceiver for wrapping and extending a BidirectionalConnectionTransceiver with observable functionality.

TODO: Test cases are to be created!

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.component.Flushable

org.refcodes.component.Flushable.FlushBuilder<B extends org.refcodes.component.Flushable.FlushBuilder<B>>

Nested classes/interfaces inherited from interface org.refcodes.component.ConnectableComponent

org.refcodes.component.ConnectableComponent.ConnectableAutomaton

Nested classes/interfaces inherited from interface org.refcodes.component.OpenedAccessor

org.refcodes.component.OpenedAccessor.OpenedMutator, org.refcodes.component.OpenedAccessor.OpenedProperty

Nested classes/interfaces inherited from interface org.refcodes.component.Closable

org.refcodes.component.Closable.CloseAutomaton, org.refcodes.component.Closable.CloseBuilder<B extends org.refcodes.component.Closable.CloseBuilder<B>>

Nested classes/interfaces inherited from interface org.refcodes.component.ClosedAccessor

org.refcodes.component.ClosedAccessor.ClosedMutator, org.refcodes.component.ClosedAccessor.ClosedProperty

Nested classes/interfaces inherited from interface org.refcodes.component.ConnectionStatusAccessor

org.refcodes.component.ConnectionStatusAccessor.ConnectionStatusMutator, org.refcodes.component.ConnectionStatusAccessor.ConnectionStatusProperty

Nested classes/interfaces inherited from interface org.refcodes.component.BidirectionalConnectionComponent

org.refcodes.component.BidirectionalConnectionComponent.BidirectionalConnectionAutomaton<INPUT,OUTPUT>

Nested classes/interfaces inherited from interface org.refcodes.component.BidirectionalConnectionOpenable

org.refcodes.component.BidirectionalConnectionOpenable.BidirectionalConnectionOpenAutomaton<INPUT,OUTPUT>

Nested classes/interfaces inherited from interface org.refcodes.component.Destroyable

org.refcodes.component.Destroyable.DestroyAutomaton

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.refcodes.logger.RuntimeLogger	LOGGER

Constructor Summary

Constructors

Constructor and Description
ObservableBidirectionalRequestTransceiverImpl(org.refcodes.io.BidirectionalConnectionTransceiver<DATA,INPUT,OUTPUT> aInputOutputTransceiver) Constructs a ObservableBidirectionalRequestTransceiverImpl with the given attributes.
ObservableBidirectionalRequestTransceiverImpl(org.refcodes.io.BidirectionalConnectionTransceiver<DATA,INPUT,OUTPUT> aInputOutputTransceiver, org.refcodes.observer.EventMetaData aEventMetaData) Constructs a ObservableBidirectionalRequestTransceiverImpl with the given attributes.
ObservableBidirectionalRequestTransceiverImpl(org.refcodes.io.BidirectionalConnectionTransceiver<DATA,INPUT,OUTPUT> aInputOutputTransceiver, org.refcodes.observer.EventMetaData aEventMetaData, ExecutorService aExecutorService, org.refcodes.controlflow.ExecutionStrategy aExecutionStrategy) Constructs a ObservableBidirectionalRequestTransceiverImpl with the given attributes.
ObservableBidirectionalRequestTransceiverImpl(org.refcodes.io.BidirectionalConnectionTransceiver<DATA,INPUT,OUTPUT> aInputOutputTransceiver, org.refcodes.observer.EventMetaData aEventMetaData, Object aSource) Constructs a ObservableBidirectionalRequestTransceiverImpl with the given attributes.
ObservableBidirectionalRequestTransceiverImpl(org.refcodes.io.BidirectionalConnectionTransceiver<DATA,INPUT,OUTPUT> aInputOutputTransceiver, org.refcodes.observer.EventMetaData aEventMetaData, Object aSource, ExecutorService aExecutorService, org.refcodes.controlflow.ExecutionStrategy aExecutionStrategy) Constructs a ObservableBidirectionalRequestTransceiverImpl with the given attributes.
ObservableBidirectionalRequestTransceiverImpl(org.refcodes.io.BidirectionalConnectionTransceiver<DATA,INPUT,OUTPUT> aInputOutputTransceiver, ExecutorService aExecutorService, org.refcodes.controlflow.ExecutionStrategy aExecutionStrategy) Constructs a ObservableBidirectionalRequestTransceiverImpl with the given attributes.
ObservableBidirectionalRequestTransceiverImpl(org.refcodes.io.BidirectionalConnectionTransceiver<DATA,INPUT,OUTPUT> aInputOutputTransceiver, Object aSource) Constructs a ObservableBidirectionalRequestTransceiverImpl with the given attributes.
ObservableBidirectionalRequestTransceiverImpl(org.refcodes.io.BidirectionalConnectionTransceiver<DATA,INPUT,OUTPUT> aInputOutputTransceiver, Object aSource, ExecutorService aExecutorService, org.refcodes.controlflow.ExecutionStrategy aExecutionStrategy) Constructs a ObservableBidirectionalRequestTransceiverImpl with the given attributes.

Method Summary

Modifier and Type	Method and Description
void	close()
void	destroy()
void	flush()
org.refcodes.component.ConnectionStatus	getConnectionStatus()
boolean	hasDatagram()
boolean	hasObserverSubscription(org.refcodes.component.ext.observer.ConnectionObserver.ConnectionRequestObserver aObserver)
boolean	isClosable()
boolean	isClosed()
boolean	isOpenable(INPUT aInputConnection, OUTPUT aOutputConnection)
boolean	isOpened()
void	open(INPUT aInputConnection, OUTPUT aOutputConnection)
DATA	readDatagram()
void	releaseAll()
boolean	subscribeObserver(org.refcodes.component.ext.observer.ConnectionObserver.ConnectionRequestObserver aObserver)
boolean	unsubscribeObserver(org.refcodes.component.ext.observer.ConnectionObserver.ConnectionRequestObserver aObserver)
void	writeDatagram(DATA aDatagram)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.io.Sender

writeDatagrams

Methods inherited from interface org.refcodes.io.Consumer

writeDatagrams

Methods inherited from interface org.refcodes.io.Receiver

readDatagrams, readDatagrams

Methods inherited from interface org.refcodes.component.Flushable

flushUnchecked, isFlushable

Methods inherited from interface org.refcodes.component.Closable

closeIn, closeQuietly, closeUnchecked

Methods inherited from interface org.refcodes.component.ConnectionStatusAccessor

isConnectionOpened

Field Detail

LOGGER

protected static org.refcodes.logger.RuntimeLogger LOGGER

Constructor Detail

ObservableBidirectionalRequestTransceiverImpl

public ObservableBidirectionalRequestTransceiverImpl(org.refcodes.io.BidirectionalConnectionTransceiver<DATA,INPUT,OUTPUT> aInputOutputTransceiver)

Constructs a ObservableBidirectionalRequestTransceiverImpl with the given attributes.

Parameters:

aInputOutputTransceiver - The BidirectionalConnectionTransceiver to which the connection method calls are to be delegated to.

ObservableBidirectionalRequestTransceiverImpl

public ObservableBidirectionalRequestTransceiverImpl(org.refcodes.io.BidirectionalConnectionTransceiver<DATA,INPUT,OUTPUT> aInputOutputTransceiver,
                                                     Object aSource)

Constructs a ObservableBidirectionalRequestTransceiverImpl with the given attributes.

Parameters:

aInputOutputTransceiver - The BidirectionalConnectionTransceiver to which the connection method calls are to be delegated to.

aSource - The source instance to be used when firing events in case the source is to be different from this class' instance.

ObservableBidirectionalRequestTransceiverImpl

public ObservableBidirectionalRequestTransceiverImpl(org.refcodes.io.BidirectionalConnectionTransceiver<DATA,INPUT,OUTPUT> aInputOutputTransceiver,
                                                     org.refcodes.observer.EventMetaData aEventMetaData)

Constructs a ObservableBidirectionalRequestTransceiverImpl with the given attributes.

Parameters:

aInputOutputTransceiver - The BidirectionalConnectionTransceiver to which the connection method calls are to be delegated to.

aEventMetaData - The EventMetaData to be used when firing events in case the EventMetaData is to be different from the auto-generated EventMetaData.

ObservableBidirectionalRequestTransceiverImpl

public ObservableBidirectionalRequestTransceiverImpl(org.refcodes.io.BidirectionalConnectionTransceiver<DATA,INPUT,OUTPUT> aInputOutputTransceiver,
                                                     org.refcodes.observer.EventMetaData aEventMetaData,
                                                     Object aSource)

Constructs a ObservableBidirectionalRequestTransceiverImpl with the given attributes.

Parameters:

aInputOutputTransceiver - The BidirectionalConnectionTransceiver to which the connection method calls are to be delegated to.

aEventMetaData - The EventMetaData to be used when firing events in case the EventMetaData is to be different from the auto-generated EventMetaData.

aSource - The source instance to be used when firing events in case the source is to be different from this class' instance.

ObservableBidirectionalRequestTransceiverImpl

public ObservableBidirectionalRequestTransceiverImpl(org.refcodes.io.BidirectionalConnectionTransceiver<DATA,INPUT,OUTPUT> aInputOutputTransceiver,
                                                     ExecutorService aExecutorService,
                                                     org.refcodes.controlflow.ExecutionStrategy aExecutionStrategy)

Constructs a ObservableBidirectionalRequestTransceiverImpl with the given attributes.

Parameters:

aInputOutputTransceiver - The BidirectionalConnectionTransceiver to which the connection method calls are to be delegated to.

aExecutorService - The executor service to be used when firing ActionEvent instances in multiple threads (if null then a default one is used).

aExecutionStrategy - The ExecutionStrategy to be used when firing ActionEvent instance (if null then the default ExecutionStrategy.SEQUENTIAL is used).

ObservableBidirectionalRequestTransceiverImpl

public ObservableBidirectionalRequestTransceiverImpl(org.refcodes.io.BidirectionalConnectionTransceiver<DATA,INPUT,OUTPUT> aInputOutputTransceiver,
                                                     Object aSource,
                                                     ExecutorService aExecutorService,
                                                     org.refcodes.controlflow.ExecutionStrategy aExecutionStrategy)

Constructs a ObservableBidirectionalRequestTransceiverImpl with the given attributes.

Parameters:

aInputOutputTransceiver - The BidirectionalConnectionTransceiver to which the connection method calls are to be delegated to.

aSource - The source instance to be used when firing events in case the source is to be different from this class' instance.

aExecutorService - The executor service to be used when firing ActionEvent instances in multiple threads (if null then a default one is used).

aExecutionStrategy - The ExecutionStrategy to be used when firing ActionEvent instance (if null then the default ExecutionStrategy.SEQUENTIAL is used).

ObservableBidirectionalRequestTransceiverImpl

public ObservableBidirectionalRequestTransceiverImpl(org.refcodes.io.BidirectionalConnectionTransceiver<DATA,INPUT,OUTPUT> aInputOutputTransceiver,
                                                     org.refcodes.observer.EventMetaData aEventMetaData,
                                                     ExecutorService aExecutorService,
                                                     org.refcodes.controlflow.ExecutionStrategy aExecutionStrategy)

Constructs a ObservableBidirectionalRequestTransceiverImpl with the given attributes.

Parameters:

aInputOutputTransceiver - The BidirectionalConnectionTransceiver to which the connection method calls are to be delegated to.

aEventMetaData - The EventMetaData to be used when firing events in case the EventMetaData is to be different from the auto-generated EventMetaData.

aExecutorService - The executor service to be used when firing ActionEvent instances in multiple threads (if null then a default one is used).

aExecutionStrategy - The ExecutionStrategy to be used when firing ActionEvent instance (if null then the default ExecutionStrategy.SEQUENTIAL is used).

ObservableBidirectionalRequestTransceiverImpl

public ObservableBidirectionalRequestTransceiverImpl(org.refcodes.io.BidirectionalConnectionTransceiver<DATA,INPUT,OUTPUT> aInputOutputTransceiver,
                                                     org.refcodes.observer.EventMetaData aEventMetaData,
                                                     Object aSource,
                                                     ExecutorService aExecutorService,
                                                     org.refcodes.controlflow.ExecutionStrategy aExecutionStrategy)

Constructs a ObservableBidirectionalRequestTransceiverImpl with the given attributes.

Parameters:

aInputOutputTransceiver - The BidirectionalConnectionTransceiver to which the connection method calls are to be delegated to.

aEventMetaData - The EventMetaData to be used when firing events in case the EventMetaData is to be different from the auto-generated EventMetaData.

aSource - The source instance to be used when firing events in case the source is to be different from this class' instance.

aExecutorService - The executor service to be used when firing ActionEvent instances in multiple threads (if null then a default one is used).

aExecutionStrategy - The ExecutionStrategy to be used when firing ActionEvent instance (if null then the default ExecutionStrategy.SEQUENTIAL is used).

Method Detail

isClosed

public boolean isClosed()

Specified by:

isClosed in interface org.refcodes.component.ClosedAccessor

isOpened

public boolean isOpened()

Specified by:

isOpened in interface org.refcodes.component.OpenedAccessor

getConnectionStatus

public org.refcodes.component.ConnectionStatus getConnectionStatus()

Specified by:

getConnectionStatus in interface org.refcodes.component.ConnectionStatusAccessor

releaseAll

public void releaseAll()

Specified by:

releaseAll in interface org.refcodes.mixin.Releaseable

flush

public void flush()
           throws org.refcodes.component.OpenException

Specified by:

flush in interface Flushable

Specified by:

flush in interface org.refcodes.io.Sender<DATA extends Serializable>

Throws:

org.refcodes.component.OpenException

close

public void close()
           throws org.refcodes.component.CloseException

Specified by:

close in interface org.refcodes.component.Closable

Throws:

org.refcodes.component.CloseException

open

public void open(INPUT aInputConnection,
                 OUTPUT aOutputConnection)
          throws org.refcodes.component.OpenException

Specified by:

open in interface org.refcodes.component.BidirectionalConnectionOpenable<INPUT,OUTPUT>

Throws:

org.refcodes.component.OpenException

readDatagram

public DATA readDatagram()
                  throws org.refcodes.component.OpenException,
                         InterruptedException

Specified by:

readDatagram in interface org.refcodes.io.DatagramProvider<DATA extends Serializable>

Throws:

org.refcodes.component.OpenException

InterruptedException

writeDatagram

public void writeDatagram(DATA aDatagram)
                   throws org.refcodes.component.OpenException

Specified by:

writeDatagram in interface org.refcodes.io.Consumer<DATA extends Serializable>

Specified by:

writeDatagram in interface org.refcodes.io.DatagramConsumer<DATA extends Serializable>

Throws:

org.refcodes.component.OpenException

isClosable

public boolean isClosable()

Specified by:

isClosable in interface org.refcodes.component.Closable.CloseAutomaton

isOpenable

public boolean isOpenable(INPUT aInputConnection,
                          OUTPUT aOutputConnection)

Specified by:

isOpenable in interface org.refcodes.component.BidirectionalConnectionOpenable.BidirectionalConnectionOpenAutomaton<INPUT,OUTPUT>

hasDatagram

public boolean hasDatagram()
                    throws org.refcodes.component.OpenException

Specified by:

hasDatagram in interface org.refcodes.io.Receivable

Throws:

org.refcodes.component.OpenException

hasObserverSubscription

public boolean hasObserverSubscription(org.refcodes.component.ext.observer.ConnectionObserver.ConnectionRequestObserver aObserver)

Specified by:

hasObserverSubscription in interface org.refcodes.observer.Observable<org.refcodes.component.ext.observer.ConnectionObserver.ConnectionRequestObserver>

subscribeObserver

public boolean subscribeObserver(org.refcodes.component.ext.observer.ConnectionObserver.ConnectionRequestObserver aObserver)

Specified by:

subscribeObserver in interface org.refcodes.observer.Observable<org.refcodes.component.ext.observer.ConnectionObserver.ConnectionRequestObserver>

unsubscribeObserver

public boolean unsubscribeObserver(org.refcodes.component.ext.observer.ConnectionObserver.ConnectionRequestObserver aObserver)

Specified by:

unsubscribeObserver in interface org.refcodes.observer.Observable<org.refcodes.component.ext.observer.ConnectionObserver.ConnectionRequestObserver>

destroy

public void destroy()

Specified by:

destroy in interface org.refcodes.component.Destroyable