IBlockCodec

Description

interface Tinman.Core.Codec.IBlockCodec

Extended by

BlockCodec abstract

Base interface for block-based codecs (i.e. encoders/decoders).

Public / Methods

Process​Block

2 overloads

public method ProcessBlock1 → (2)

input in : ByteBuffer

[not-null]
The input data block. Must have at least BlockLengthInput of ByteBuffer.Remaining bytes.

output in : ByteBuffer

[not-null]
The output data buffer. Must have at least BlockLengthOutput of ByteBuffer.Remaining bytes.

Processes the given input data block.

public method ProcessBlock2 → (4)

input in : int8 [ ]

[not-null]
The input data block. Must contain at least BlockLengthInput bytes starting at inputOffset in.

inputOffset in : int32

[>=0]
Offset into input in to first byte of input data block.

output in : int8 [ ]

[not-null]
The output data buffer. Must contain at least BlockLengthOutput bytes starting at outputOffset in.

outputOffset in : int32

[>=0]
Offset into output in to first byte of output data buffer.

Processes the given input data block.

Public / Attributes

Block​Length​Input

public attribute BlockLengthInput → (get)

value : int32

[>0]
The input block length, in bytes.

Length of a single input block, in bytes.

This is the number of bytes that are read from the input during each call to ProcessBlock().

Block​Length​Output

public attribute BlockLengthOutput → (get)

value : int32

[>0]
The output block length, in bytes.

Length of a single output block, in bytes.

This is the number of bytes that are written to the output during each call to ProcessBlock().

Mode

public attribute Mode → (get)

value : CodecMode

The codec mode.

The mode of this block codec.

Name

public attribute Name → (get)

value : string

[not-null]
The codec name.

Name of this block codec.