net.openhft.chronicle.bytes.util

Enum BinaryLengthLength

java.lang.Object

java.lang.Enum<BinaryLengthLength>

net.openhft.chronicle.bytes.util.BinaryLengthLength

All Implemented Interfaces:

Serializable, Comparable<BinaryLengthLength>

public enum BinaryLengthLength
extends Enum<BinaryLengthLength>

Defines strategies for encoding and writing the length prefix of binary data segments. Supported prefixes are 8, 16 and 32-bit fields. After writing the payload the caller must invoke writeLength(Bytes, long, long) exactly once to store the final length.

Maximum storable lengths:

• 8-bit: 255 bytes
• 16-bit: 65 535 bytes
• 32-bit: 2 147 483 647 bytes

Note: Each writeLength call performs a store fence as required by JSR-133 to ensure the length is visible to other threads.

Enum Constant Summary

Enum Constants

Enum Constant and Description
LENGTH_16BIT Represents a 16-bit length prefix.
LENGTH_32BIT Represents a 32-bit length prefix allowing data up to 2,147,483,647 bytes.
LENGTH_8BIT Represents an 8-bit length prefix capable of encoding data lengths from 0 to 255 bytes.

Method Summary

Modifier and Type	Method and Description
abstract int	code() Returns the BinaryWireCode identifying this length field in the binary stream.
abstract long	initialise(@NotNull BytesOut<?> bytes) Writes the identifying code and reserves space for the length field.
static BinaryLengthLength	valueOf(String name) Returns the enum constant of this type with the specified name.
static BinaryLengthLength[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
abstract void	writeLength(@NotNull Bytes<?> bytes, long positionReturnedFromInitialise, long end) Writes the actual length at the supplied offset after the data segment has been written.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LENGTH_8BIT

public static final BinaryLengthLength LENGTH_8BIT

Represents an 8-bit length prefix capable of encoding data lengths from 0 to 255 bytes. The prefix consists of one byte identifying the type and one byte holding the length value.

LENGTH_16BIT

public static final BinaryLengthLength LENGTH_16BIT

Represents a 16-bit length prefix. The prefix comprises one code byte and two bytes storing the length, allowing data up to 65535 bytes.

LENGTH_32BIT

public static final BinaryLengthLength LENGTH_32BIT

Represents a 32-bit length prefix allowing data up to 2,147,483,647 bytes. The prefix comprises one code byte followed by four bytes of length.

Method Detail

values

public static BinaryLengthLength[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BinaryLengthLength c : BinaryLengthLength.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static BinaryLengthLength valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

code

public abstract int code()

Returns the BinaryWireCode identifying this length field in the binary stream.

Returns:

the code used in the wire format

initialise

public abstract long initialise(@NotNull
                                @NotNull BytesOut<?> bytes)

Writes the identifying code and reserves space for the length field.

Parameters:

bytes - the output bytes to write to

Returns:

the absolute offset at which the length should be written later

writeLength

public abstract void writeLength(@NotNull
                                 @NotNull Bytes<?> bytes,
                                 long positionReturnedFromInitialise,
                                 long end)

Writes the actual length at the supplied offset after the data segment has been written.

Parameters:

bytes - the bytes to update

positionReturnedFromInitialise - the offset from initialise(BytesOut)

end - the absolute end of the data