Module org.refcodes.serial
Package org.refcodes.serial

Class CipherSegmentDecorator<DECORATEE extends Segment>

java.lang.Object
org.refcodes.serial.AbstractTransmissionDecorator<DECORATEE>
org.refcodes.serial.AbstractCipherTransmissionDecorator<DECORATEE>
org.refcodes.serial.CipherSegmentDecorator<DECORATEE>
Type Parameters:
DECORATEE - The Segment type describing the Segment subclass to be enriched.s
All Implemented Interfaces:
Serializable, org.refcodes.mixin.DecorateeAccessor<DECORATEE>, org.refcodes.mixin.LengthAccessor, org.refcodes.mixin.Schemable, Segment, Transmission, Transmission.TransmissionMixin
public class CipherSegmentDecorator<DECORATEE extends Segment> extends AbstractCipherTransmissionDecorator<DECORATEE> implements Segment
A CipherSegmentDecorator is a transmission applying an Invertible on outgoing bytes (as of Transmission.transmitTo(java.io.OutputStream) or the like) and the inverse function on any incoming bytes.
See Also:

  • Constructor Details

    • CipherSegmentDecorator

      public CipherSegmentDecorator(DECORATEE aDecoratee, Cipher aCipher)

  • Method Details

    • fromTransmission

      public int fromTransmission(Sequence aSequence, int aOffset) throws TransmissionException
      (Re-)initializes this instance with the the given Sequence data.
      Specified by:
      fromTransmission in interface Segment
      Parameters:
      aSequence - The Sequence data from which to (re-)initialize this instance.
      aOffset - The offset where to start processing the provided Sequence.
      Returns:
      The index after the last offset into the given Sequence processed by this method.
      Throws:
      TransmissionException - thrown in case a given Sequence cannot be processed.

    • receiveFrom

      public void receiveFrom(InputStream aInputStream, OutputStream aReturnStream) throws IOException, TransmissionException
      (Re-)initializes this instance by receiving the according Sequence from the given InputStream. Implementations providing error correction methods use the provided feedback OutputStream to do some sort of "stop-and-wait ARQ" or apply similar methods to ensure correctness of the received data.
      Specified by:
      receiveFrom in interface Segment
      Parameters:
      aInputStream - The InputStream from which to read the instance's (re-)initialization Sequence from.
      aReturnStream - An OutputStream being the return channel to handle "stop-and-wait ARQ" or the like in case of a bidirectional connection. Can be null in case we have a unidirectional connection.
      Throws:
      IOException - thrown in case reading data from the InputStream caused problems.
      TransmissionException - thrown in case a given transmission cannot be processed.