Package io.activej.csp.process.frames

Interface FrameFormat

All Known Implementing Classes:
LZ4FrameFormat, LZ4LegacyFrameFormat
public interface FrameFormat
This interface specifies data encoding format which utilizes block structure.

A format may or may not compress data that is being encoded.

A typical format starts with a Stream Header that contains 'magic' bytes required to identify a stream format and some initial settings for the stream.

Stream Header is followed by 0 to N Data Blocks which may have their own headers and footers.

A stream ends with some special End-Of-Stream Block

  • Method Details

    • createEncoder

      BlockEncoder createEncoder()
      Creates an encoder which transforms input bufs into bufs of encoded data
      Returns:
      block encoder

    • createDecoder

      BlockDecoder createDecoder()
      Creates a decoder which decodes data encoded by BlockEncoder
      Returns:
      block decoder