Module org.refcodes.serial

Package org.refcodes.serial

Class AbstractPort<PM extends PortMetrics>

java.lang.Object

org.refcodes.component.ConnectionAutomatonImpl<PM>

org.refcodes.serial.AbstractPort<PM>

Type Parameters:

PM - The actual PortMetrics type to use.

All Implemented Interfaces:

Flushable, org.refcodes.component.Closable, org.refcodes.component.Closable.CloseAutomaton, org.refcodes.component.ClosedAccessor, org.refcodes.component.ConnectableComponent, org.refcodes.component.ConnectableComponent.ConnectableAutomaton, org.refcodes.component.ConnectionComponent<PM>, org.refcodes.component.ConnectionComponent.ConnectionAutomaton<PM>, org.refcodes.component.ConnectionOpenable<PM>, org.refcodes.component.ConnectionOpenable.ConnectionOpenAutomaton<PM>, org.refcodes.component.ConnectionOpenable.ConnectionOpenBuilder<PM,Port<PM>>, org.refcodes.component.ConnectionStatusAccessor, org.refcodes.component.Flushable, org.refcodes.component.LinkComponent, org.refcodes.component.LinkComponent.LinkAutomaton, org.refcodes.component.Openable, org.refcodes.component.Openable.OpenAutomaton, org.refcodes.component.Openable.OpenBuilder<Port<PM>>, org.refcodes.component.OpenedAccessor, org.refcodes.io.Availability, org.refcodes.io.ByteDestination, org.refcodes.io.ByteReceiver, org.refcodes.io.BytesDestination, org.refcodes.io.ByteSource, org.refcodes.io.BytesReceiver, org.refcodes.io.BytesSource, org.refcodes.io.BytesTransceiver, org.refcodes.io.BytesTransmitter, org.refcodes.io.ByteTransceiver, org.refcodes.io.ByteTransmitter, org.refcodes.io.Receivable, org.refcodes.io.Skippable, org.refcodes.io.TimeoutInputStreamAccessor, org.refcodes.io.Transmittable, org.refcodes.mixin.AliasAccessor, org.refcodes.mixin.InputStreamAccessor, org.refcodes.mixin.OutputStreamAccessor, Port<PM>, PortMetricsAccessor<PM>, SegmentDestination, SegmentReceiver, SegmentSource, SegmentTransceiver, SegmentTransmitter, SerialReceiver, SerialTransceiver, SerialTransmitter

Direct Known Subclasses:

LoopbackPort

public abstract class AbstractPort<PM extends PortMetrics>
extends org.refcodes.component.ConnectionAutomatonImpl<PM>
implements Port<PM>, org.refcodes.component.ConnectionComponent.ConnectionAutomaton<PM>

A AbstractPort is a base Port implementation

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.mixin.AliasAccessor

org.refcodes.mixin.AliasAccessor.AliasBuilder<B extends org.refcodes.mixin.AliasAccessor.AliasBuilder<B>>, org.refcodes.mixin.AliasAccessor.AliasMutator, org.refcodes.mixin.AliasAccessor.AliasProperty

Nested classes/interfaces inherited from interface org.refcodes.io.BytesReceiver

org.refcodes.io.BytesReceiver.ReceiverInputStream

Nested classes/interfaces inherited from interface org.refcodes.io.BytesTransmitter

org.refcodes.io.BytesTransmitter.TransmitterOutputStream

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

org.refcodes.component.ConnectableComponent.ConnectableAutomaton

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

org.refcodes.component.ConnectionComponent.ConnectionAutomaton<CON extends Object>, org.refcodes.component.ConnectionComponent.ConnectionComponentBuilder<CON extends Object,B extends org.refcodes.component.ConnectionComponent.ConnectionComponentBuilder<CON,B>>

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

org.refcodes.component.ConnectionOpenable.ConnectionOpenAutomaton<CON extends Object>, org.refcodes.component.ConnectionOpenable.ConnectionOpenBuilder<CON extends Object,B extends org.refcodes.component.ConnectionOpenable.ConnectionOpenBuilder<CON,B>>

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

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

Nested classes/interfaces inherited from interface org.refcodes.mixin.InputStreamAccessor

org.refcodes.mixin.InputStreamAccessor.InputStreamBuilder<B extends org.refcodes.mixin.InputStreamAccessor.InputStreamBuilder<?>>, org.refcodes.mixin.InputStreamAccessor.InputStreamMutator, org.refcodes.mixin.InputStreamAccessor.InputStreamProperty

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

org.refcodes.component.LinkComponent.LinkAutomaton, org.refcodes.component.LinkComponent.LinkComponentBuilder<B extends org.refcodes.component.LinkComponent.LinkComponentBuilder<B>>

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

org.refcodes.component.Openable.OpenAutomaton, org.refcodes.component.Openable.OpenBuilder<B extends org.refcodes.component.Openable.OpenBuilder<B>>

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.mixin.OutputStreamAccessor

org.refcodes.mixin.OutputStreamAccessor.OutputStreamBuilder<B extends org.refcodes.mixin.OutputStreamAccessor.OutputStreamBuilder<?>>, org.refcodes.mixin.OutputStreamAccessor.OutputStreamMutator, org.refcodes.mixin.OutputStreamAccessor.OutputStreamProperty

Nested classes/interfaces inherited from interface org.refcodes.serial.PortMetricsAccessor

PortMetricsAccessor.PortMetricsBuilder<PM extends PortMetrics,B extends PortMetricsAccessor.PortMetricsBuilder<PM,B>>, PortMetricsAccessor.PortMetricsMutator<PM extends PortMetrics>, PortMetricsAccessor.PortMetricsProperty<PM extends PortMetrics>

Nested classes/interfaces inherited from interface org.refcodes.io.TimeoutInputStreamAccessor

org.refcodes.io.TimeoutInputStreamAccessor.TimeoutInputStreamBuilder<B extends org.refcodes.io.TimeoutInputStreamAccessor.TimeoutInputStreamBuilder<?>>, org.refcodes.io.TimeoutInputStreamAccessor.TimeoutInputStreamMutator, org.refcodes.io.TimeoutInputStreamAccessor.TimeoutInputStreamProperty

Field Summary

Fields

Modifier and Type	Field	Description
protected String	_alias
protected ExecutorService	_executorService
protected PM	_portMetrics

Fields inherited from class org.refcodes.component.ConnectionAutomatonImpl

_connectionComponent

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractPort(String aAlias, PM aPortMetrics)	Constructs a AbstractPort with the given properties.
protected	AbstractPort(String aAlias, PM aPortMetrics, ExecutorService aExecutorService)	Constructs a AbstractPort with the given properties and the given ExecutorService to be used by asynchronous functionality.

Method Summary

Modifier and Type	Method	Description
void	close()	Attention: Implementations of this method should do a Object.notifyAll() in order to terminate any pending asynchronous operations such as SegmentReceiver.onReceiveSegment(Segment) or SegmentReceiver.onReceiveSegment(Segment, SegmentConsumer).
<SEGMENT extends Segment> SegmentResult<SEGMENT>	doTransmitSegment(SEGMENT aSegment)	Asynchronously sends a Segment's Sequence data (does not block this thread).
<SEGMENT extends Segment> void	doTransmitSegment(SEGMENT aSegment, SegmentConsumer<SEGMENT> aSegmentConsumer)	Asynchronously sends a Segment's Sequence data (does not block this thread).
String	getAlias()	Returns the unambiguous technical name of the TTY-/COM-Port.
boolean	isOpenable()
<SEGMENT extends Segment> SegmentResult<SEGMENT>	onReceiveSegment(SEGMENT aSegment)	Asynchronously receives a Segment's Sequence data (does not block this thread) and updates the Segment by invoking Segment.fromTransmission(Sequence).
<SEGMENT extends Segment> void	onReceiveSegment(SEGMENT aSegment, SegmentConsumer<SEGMENT> aSegmentConsumer)	Asynchronously receives a Segment's Sequence data (does not block this thread) and updates the Segment by invoking Segment.fromTransmission(Sequence), passing the result to the callback SegmentConsumer.onSegment(Segment).
void	open()	Attention: Implementations of this method should do a Object.notifyAll() in order to terminate any pending asynchronous operations such as SegmentReceiver.onReceiveSegment(Segment) or SegmentReceiver.onReceiveSegment(Segment, SegmentConsumer).
void	open(PM aConnection)
<HEADER extends Segment> void	receiveSegment(HEADER aSegment)	Receives a Segment (and blocks this thread) till all it's Sequence data has been received and updates the Segment by invoking Segment.fromTransmission(Sequence).

Methods inherited from class org.refcodes.component.ConnectionAutomatonImpl

getConnectionStatus, isClosable, isClosed, isOpenable, isOpened

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

hasAvailable

Methods inherited from interface org.refcodes.io.BytesDestination

receiveBytes

Methods inherited from interface org.refcodes.io.BytesReceiver

getInputStream, getInputStream, receiveAllBytes, receiveBytesWithin, receiveBytesWithin, receiveByteWithin, skip

Methods inherited from interface org.refcodes.io.BytesSource

transmitByte

Methods inherited from interface org.refcodes.io.BytesTransmitter

getOutputStream

Methods inherited from interface org.refcodes.component.Closable

closeIn, closeQuietly, closeUnchecked

Methods inherited from interface org.refcodes.component.Closable.CloseAutomaton

isClosable

Methods inherited from interface org.refcodes.component.ClosedAccessor

isClosed

Methods inherited from interface org.refcodes.component.ConnectionOpenable

openUnchecked

Methods inherited from interface org.refcodes.component.ConnectionOpenable.ConnectionOpenAutomaton

isOpenable

Methods inherited from interface org.refcodes.component.ConnectionOpenable.ConnectionOpenBuilder

withOpen, withOpenUnchecked

Methods inherited from interface org.refcodes.component.ConnectionStatusAccessor

getConnectionStatus, isOpened

Methods inherited from interface org.refcodes.component.Flushable

flushUnchecked, isFlushable

Methods inherited from interface org.refcodes.component.Openable

openUnchecked

Methods inherited from interface org.refcodes.component.Openable.OpenBuilder

withOpen, withOpenUnchecked

Methods inherited from interface org.refcodes.serial.PortMetricsAccessor

getPortMetrics

Methods inherited from interface org.refcodes.serial.SegmentTransmitter

flush

Methods inherited from interface org.refcodes.serial.SerialReceiver

available, receiveByte, receiveBytes, receiveSegmentWithin, receiveSequence, receiveSequenceWithin

Methods inherited from interface org.refcodes.serial.SerialTransceiver

transmitSegment

Methods inherited from interface org.refcodes.serial.SerialTransmitter

flush, transmitAllBytes, transmitBytes, transmitSequence, transmitSequence

Methods inherited from interface org.refcodes.io.Skippable

available, skipAvailable, skipAvailableExcept, skipAvailableTill, skipAvailableTillSilenceFor, skipAvailableTillSilenceFor, skipAvailableWithin, skipAvailableWithin

Field Detail

_alias

protected String _alias

_portMetrics

protected PM extends PortMetrics _portMetrics

_executorService

protected ExecutorService _executorService

Constructor Detail

AbstractPort

protected AbstractPort(String aAlias,
                       PM aPortMetrics)

Constructs a AbstractPort with the given properties. The alias corresponds to the underlying TTY-/COM-Port's name.

Parameters:

aAlias - The unambiguous technical name for this AbstractPort.

aPortMetrics - The metrics of the AbstractPort.

AbstractPort

protected AbstractPort(String aAlias,
                       PM aPortMetrics,
                       ExecutorService aExecutorService)

Constructs a AbstractPort with the given properties and the given ExecutorService to be used by asynchronous functionality. The alias corresponds to the underlying TTY-/COM-Port's name.

Parameters:

aAlias - The unambiguous technical name for this AbstractPort.

aPortMetrics - The metrics of the AbstractPort.

aExecutorService - The ExecutorService to be used when invoking asynchronously working methods.

Method Detail

getAlias

public String getAlias()

Returns the unambiguous technical name of the TTY-/COM-Port.

Specified by:

getAlias in interface org.refcodes.mixin.AliasAccessor

Returns:

The port's name.

isOpenable

public boolean isOpenable()

Specified by:

isOpenable in interface org.refcodes.component.Openable.OpenAutomaton

open

public void open()
          throws IOException

Attention: Implementations of this method should do a Object.notifyAll() in order to terminate any pending asynchronous operations such as SegmentReceiver.onReceiveSegment(Segment) or SegmentReceiver.onReceiveSegment(Segment, SegmentConsumer).

Specified by:

open in interface org.refcodes.component.Openable

Specified by:

open in interface SerialReceiver

Throws:

IOException

open

public void open(PM aConnection)
          throws IOException

Specified by:

open in interface org.refcodes.component.ConnectionOpenable<PM extends PortMetrics>

Overrides:

open in class org.refcodes.component.ConnectionAutomatonImpl<PM extends PortMetrics>

Throws:

IOException

receiveSegment

public <HEADER extends Segment> void receiveSegment(HEADER aSegment)
                                             throws TransmissionException,
                                                    IOException

Receives a Segment (and blocks this thread) till all it's Sequence data has been received and updates the Segment by invoking Segment.fromTransmission(Sequence). This method blocks till all bytes are read.

Specified by:

receiveSegment in interface SegmentDestination

Specified by:

receiveSegment in interface SerialReceiver

Specified by:

receiveSegment in interface SerialTransceiver

Type Parameters:

HEADER - The Segment type describing the Segment subclass of implementing Segment types.

Parameters:

aSegment - The Segment to be (re-)initialized with the received data.

Throws:

TransmissionException - Thrown in case the received data cannot be used to (re-)initialize the given Segment.

IOException - thrown in case of I/O issues (e.g. a timeout) while receiving.

onReceiveSegment

public <SEGMENT extends Segment> void onReceiveSegment(SEGMENT aSegment,
                                                       SegmentConsumer<SEGMENT> aSegmentConsumer)
                                                throws IOException

Asynchronously receives a Segment's Sequence data (does not block this thread) and updates the Segment by invoking Segment.fromTransmission(Sequence), passing the result to the callback SegmentConsumer.onSegment(Segment).

Specified by:

onReceiveSegment in interface SegmentReceiver

Type Parameters:

SEGMENT - The Segment type describing the Segment subclass of implementing Segment types.

Parameters:

aSegment - The Segment to be (re-)initialized with the received data.

aSegmentConsumer - The callback asynchronously invoked upon having received the Segment.

Throws:

IOException - thrown in case of I/O issues (e.g. a closed connection) while receiving.

onReceiveSegment

public <SEGMENT extends Segment> SegmentResult<SEGMENT> onReceiveSegment(SEGMENT aSegment)
                                                                  throws IOException

Asynchronously receives a Segment's Sequence data (does not block this thread) and updates the Segment by invoking Segment.fromTransmission(Sequence). The result is provided by the returned SegmentResult instance providing the (asynchronously) (re-)initialized provided Segment instance.

Specified by:

onReceiveSegment in interface SegmentReceiver

Type Parameters:

SEGMENT - The Segment type describing the Segment subclass used.

Parameters:

aSegment - The Segment to be (re-)initialized with the received data.

Returns:

The SegmentResult which provides the result (asynchronously).

Throws:

IOException - thrown in case of I/O issues (e.g. a closed connection) while receiving.

doTransmitSegment

public <SEGMENT extends Segment> SegmentResult<SEGMENT> doTransmitSegment(SEGMENT aSegment)
                                                                   throws IOException

Asynchronously sends a Segment's Sequence data (does not block this thread).

Specified by:

doTransmitSegment in interface SegmentTransmitter

Type Parameters:

SEGMENT - The Segment type describing the Segment subclass used.

Parameters:

aSegment - The Segment to be sent.

Returns:

The SegmentResult which provides the result of the operation (asynchronously), e.g. the Segment being sent or an IOException having occurred.

Throws:

IOException - thrown in case of I/O issues (e.g. a closed connection upon the time of invocation).

doTransmitSegment

public <SEGMENT extends Segment> void doTransmitSegment(SEGMENT aSegment,
                                                        SegmentConsumer<SEGMENT> aSegmentConsumer)
                                                 throws IOException

Asynchronously sends a Segment's Sequence data (does not block this thread).

Specified by:

doTransmitSegment in interface SegmentTransmitter

Type Parameters:

SEGMENT - The Segment type describing the Segment subclass used.

Parameters:

aSegment - The Segment to be sent.

aSegmentConsumer - The callback asynchronously invoked upon having sent the Segment.

Throws:

IOException - thrown in case of I/O issues (e.g. a closed connection upon the time of invocation).

close

public void close()
           throws IOException

Attention: Implementations of this method should do a Object.notifyAll() in order to terminate any pending asynchronous operations such as SegmentReceiver.onReceiveSegment(Segment) or SegmentReceiver.onReceiveSegment(Segment, SegmentConsumer).

Specified by:

close in interface org.refcodes.component.Closable

Specified by:

close in interface SerialReceiver

Overrides:

close in class org.refcodes.component.ConnectionAutomatonImpl<PM extends PortMetrics>

Throws:

IOException