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, Comparable<Port<?>>, Closable, Closable.CloseAutomaton, ClosedAccessor, ConnectableComponent, ConnectableComponent.ConnectableAutomaton, ConnectionComponent<PM>, ConnectionComponent.ConnectionAutomaton<PM>, ConnectionOpenable<PM>, ConnectionOpenable.ConnectionOpenAutomaton<PM>, ConnectionOpenable.ConnectionOpenBuilder<PM,Port<PM>>, ConnectionStatusAccessor, Flushable, LinkComponent, LinkComponent.LinkAutomaton, Openable, Openable.OpenAutomaton, Openable.OpenBuilder<Port<PM>>, OpenedAccessor, Availability, ByteDestination, ByteReceiver, BytesDestination, ByteSource, BytesReceiver, BytesSource, BytesTransceiver, BytesTransmitter, ByteTransceiver, ByteTransmitter, Receivable, Skippable, TimeoutInputStreamAccessor, Transmittable, AliasAccessor, InputStreamAccessor, 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 ConnectionAutomatonImpl<PM>
implements Port<PM>

A AbstractPort is a base Port implementation.

Nested Class Summary

Nested classes/interfaces inherited from interface AliasAccessor

AliasAccessor.AliasBuilder<B>, AliasAccessor.AliasMutator, AliasAccessor.AliasProperty

Nested classes/interfaces inherited from interface BytesReceiver

BytesReceiver.ReceiverInputStream

Nested classes/interfaces inherited from interface BytesTransmitter

BytesTransmitter.TransmitterOutputStream

Nested classes/interfaces inherited from interface Closable

Closable.CloseAutomaton, Closable.CloseBuilder<B>

Nested classes/interfaces inherited from interface ClosedAccessor

ClosedAccessor.ClosedMutator, ClosedAccessor.ClosedProperty

Nested classes/interfaces inherited from interface ConnectableComponent

ConnectableComponent.ConnectableAutomaton

Nested classes/interfaces inherited from interface ConnectionComponent

ConnectionComponent.ConnectionAutomaton<CON>, ConnectionComponent.ConnectionComponentBuilder<CON,B>

Nested classes/interfaces inherited from interface ConnectionOpenable

ConnectionOpenable.ConnectionOpenAutomaton<CON>, ConnectionOpenable.ConnectionOpenBuilder<CON,B>

Nested classes/interfaces inherited from interface ConnectionStatusAccessor

ConnectionStatusAccessor.ConnectionStatusMutator, ConnectionStatusAccessor.ConnectionStatusProperty

Nested classes/interfaces inherited from interface Flushable

Flushable.FlushBuilder<B>

Nested classes/interfaces inherited from interface InputStreamAccessor

InputStreamAccessor.InputStreamBuilder<B>, InputStreamAccessor.InputStreamMutator, InputStreamAccessor.InputStreamProperty

Nested classes/interfaces inherited from interface LinkComponent

LinkComponent.LinkAutomaton, LinkComponent.LinkComponentBuilder<B>

Nested classes/interfaces inherited from interface Openable

Openable.OpenAutomaton, Openable.OpenBuilder<B>

Nested classes/interfaces inherited from interface OpenedAccessor

OpenedAccessor.OpenedMutator, OpenedAccessor.OpenedProperty

Nested classes/interfaces inherited from interface OutputStreamAccessor

OutputStreamAccessor.OutputStreamBuilder<B>, OutputStreamAccessor.OutputStreamMutator, OutputStreamAccessor.OutputStreamProperty

Nested classes/interfaces inherited from interface PortMetricsAccessor

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

Nested classes/interfaces inherited from interface TimeoutInputStreamAccessor

TimeoutInputStreamAccessor.TimeoutInputStreamBuilder<B>, TimeoutInputStreamAccessor.TimeoutInputStreamMutator, TimeoutInputStreamAccessor.TimeoutInputStreamProperty

Field Summary

Fields

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

Fields inherited from class 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 ConnectionAutomatonImpl

getConnectionStatus, isClosable, isClosed, isOpenable, isOpened

Methods inherited from class Object

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

Methods inherited from interface Availability

hasAvailable

Methods inherited from interface BytesDestination

receiveBytes

Methods inherited from interface BytesReceiver

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

Methods inherited from interface BytesSource

transmitByte

Methods inherited from interface BytesTransmitter

getOutputStream

Methods inherited from interface Closable

closeIn, closeQuietly, closeUnchecked

Methods inherited from interface Closable.CloseAutomaton

isClosable

Methods inherited from interface ClosedAccessor

isClosed

Methods inherited from interface ConnectionOpenable

openUnchecked

Methods inherited from interface ConnectionOpenable.ConnectionOpenAutomaton

isOpenable

Methods inherited from interface ConnectionOpenable.ConnectionOpenBuilder

withOpen, withOpenUnchecked

Methods inherited from interface ConnectionStatusAccessor

getConnectionStatus, isOpened

Methods inherited from interface Flushable

flushUnchecked, isFlushable

Methods inherited from interface Openable

openUnchecked

Methods inherited from interface Openable.OpenBuilder

withOpen, withOpenUnchecked

Methods inherited from interface Port

compareTo

Methods inherited from interface PortMetricsAccessor

getPortMetrics

Methods inherited from interface SegmentTransmitter

flush

Methods inherited from interface SerialReceiver

available, receiveByte, receiveBytes, receiveSegmentWithin, receiveSequence, receiveSequenceWithin

Methods inherited from interface SerialTransceiver

transmitSegment

Methods inherited from interface SerialTransmitter

flush, transmitBytes, transmitBytes, transmitSequence, transmitSequence

Methods inherited from interface Skippable

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

Field Details

_alias

protected String _alias

_portMetrics

protected PM extends PortMetrics _portMetrics

_executorService

protected ExecutorService _executorService

Constructor Details

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 Details

getAlias

public String getAlias()

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

Specified by:

getAlias in interface AliasAccessor

Returns:

The port's name.

isOpenable

public boolean isOpenable()

Specified by:

isOpenable in interface 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 Openable

Specified by:

open in interface SerialReceiver

Throws:

IOException

open

public void open(PM aConnection)
          throws IOException

Specified by:

open in interface ConnectionOpenable<PM extends PortMetrics>

Overrides:

open in class ConnectionAutomatonImpl<PM extends PortMetrics>

Throws:

IOException

receiveSegment

public <HEADER extends Segment> void receiveSegment(HEADER aSegment)
                                             throws 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:

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 Closable

Specified by:

close in interface SerialReceiver

Overrides:

close in class ConnectionAutomatonImpl<PM extends PortMetrics>

Throws:

IOException