interface IBlockCodec in Tinman.Core.Codec

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

interface

IBlockCodec

base of

BlockCodec

Attributes

BlockLengthInput

Length of a single input block, in bytes.

property	BlockLengthInput { get }
type	int32
value	[>0]	The input block length, in bytes.

Remarks:

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

BlockLengthOutput

Length of a single output block, in bytes.

property	BlockLengthOutput { get }
type	int32
value	[>0]	The output block length, in bytes.

Remarks:

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

Mode

The mode of this block codec.

property	Mode { get }
type	CodecMode
value		The codec mode.

Name

Name of this block codec.

property	Name { get }
type	string
value	[not-null]	The codec name.

Methods

ProcessBlock

Processes the given input data block.

method	ProcessBlock (ByteBuffer input, ByteBuffer output)
params	input	[not-null]	The input data block. Must have at least BlockLengthInput of Remaining bytes.
	output	[not-null]	The output data buffer. Must have at least BlockLengthOutput of Remaining bytes.

---

Processes the given input data block.

method	ProcessBlock (int8[] input, int32 inputOffset, int8[] output, int32 outputOffset)
params	input	[not-null]	The input data block. Must contain at least BlockLengthInput bytes starting at inputOffset.
	inputOffset	[>=0]	Offset into input to first byte of input data block.
	output	[not-null]	The output data buffer. Must contain at least BlockLengthOutput bytes starting at outputOffset.
	outputOffset	[>=0]	Offset into output to first byte of output data buffer.