Interface SerialTransceiver

All Superinterfaces:

Availability, ByteDestination, ByteReceiver, BytesDestination, ByteSource, BytesReceiver, BytesSource, BytesTransceiver, BytesTransmitter, ByteTransceiver, ByteTransmitter, Closable, Closable.CloseAutomaton, ClosedAccessor, ConnectableComponent, ConnectableComponent.ConnectableAutomaton, ConnectionStatusAccessor, Flushable, Flushable, InputStreamAccessor, LinkComponent, LinkComponent.LinkAutomaton, Openable, Openable.OpenAutomaton, OpenedAccessor, OutputStreamAccessor, Receivable, SegmentDestination, SegmentReceiver, SegmentSource, SegmentTransceiver, SegmentTransmitter, SerialReceiver, SerialTransmitter, Skippable, TimeoutInputStreamAccessor, Transmittable

All Known Subinterfaces:

Port<PM>

All Known Implementing Classes:

AbstractPort, AbstractPortDecorator, CrossoverLoopbackPort, LoopbackPort

public interface SerialTransceiver
extends BytesTransceiver, SegmentTransceiver, SerialTransmitter, SerialReceiver

A SerialTransceiver combines SerialReceiver and SerialTransmitter functionality.

Nested Class Summary

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 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 TimeoutInputStreamAccessor

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

Method Summary

Modifier and Type	Method	Description
default <SEGMENT extends Segment> void	receiveSegment(SEGMENT 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).
default <SEGMENT extends Segment> void	transmitSegment(SEGMENT aSegment)	Transmits a Segment (and blocks this thread) till all it's Sequence data (as of Transmission.toSequence()) has been sent.

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 ConnectionStatusAccessor

getConnectionStatus, isOpened

Methods inherited from interface Flushable

flushUnchecked, isFlushable

Methods inherited from interface Openable

openUnchecked

Methods inherited from interface Openable.OpenAutomaton

isOpenable

Methods inherited from interface SegmentReceiver

onReceiveSegment, onReceiveSegment

Methods inherited from interface SegmentTransmitter

doTransmitSegment, doTransmitSegment, flush

Methods inherited from interface SerialReceiver

available, close, open, receiveByte, receiveBytes, receiveSegmentWithin, receiveSequence, receiveSequenceWithin

Methods inherited from interface SerialTransmitter

flush, transmitBytes, transmitBytes, transmitSequence, transmitSequence

Methods inherited from interface Skippable

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

Method Details

receiveSegment

default <SEGMENT extends Segment> void receiveSegment(SEGMENT 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

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.

Throws:

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

transmitSegment

default <SEGMENT extends Segment> void transmitSegment(SEGMENT aSegment)
                                                throws IOException

Transmits a Segment (and blocks this thread) till all it's Sequence data (as of Transmission.toSequence()) has been sent.

Specified by:

transmitSegment in interface SegmentSource

Specified by:

transmitSegment in interface SerialTransmitter

Type Parameters:

SEGMENT - The Segment type describing the Segment subclass used.

Parameters:

aSegment - The Segment's data to be sent.

Throws:

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