Interface NetworkBuffer

public sealed interface NetworkBuffer

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	NetworkBuffer.AutoResize
static interface	NetworkBuffer.Builder
static interface	NetworkBuffer.IOView	Self-contained interface that extends DataInput and DataOutput for mostly reading/writing binary tags.
static interface	NetworkBuffer.Type<T extends @UnknownNullability Object>

Field Summary

Fields

Modifier and Type	Field	Description
static final NetworkBuffer.Type<BitSet>	BITSET
static final NetworkBuffer.Type<Point>	BLOCK_POSITION
static final NetworkBuffer.Type<Boolean>	BOOLEAN
static final NetworkBuffer.Type<Byte>	BYTE
static final NetworkBuffer.Type<byte[]>	BYTE_ARRAY
static final NetworkBuffer.Type<Component>	COMPONENT
static final NetworkBuffer.Type<Direction>	DIRECTION
static final NetworkBuffer.Type<Double>	DOUBLE
static final NetworkBuffer.Type<Float>	FLOAT
static final NetworkBuffer.Type<Instant>	INSTANT_MS
static final NetworkBuffer.Type<Integer>	INT
static final NetworkBuffer.Type<Component>	JSON_COMPONENT
static final NetworkBuffer.Type<Key>	KEY
static final NetworkBuffer.Type<Long>	LONG
static final NetworkBuffer.Type<long[]>	LONG_ARRAY
static final NetworkBuffer.Type<Vec>	LP_VECTOR3
static final NetworkBuffer.Type<BinaryTag>	NBT
static final NetworkBuffer.Type<CompoundBinaryTag>	NBT_COMPOUND
static final NetworkBuffer.Type<@Nullable Point>	OPT_BLOCK_POSITION
static final NetworkBuffer.Type<@Nullable Component>	OPT_CHAT
static final NetworkBuffer.Type<@Nullable Integer>	OPTIONAL_VAR_INT
static final NetworkBuffer.Type<Pos>	POS
static final NetworkBuffer.Type<EntityPose>	POSE
static final NetworkBuffer.Type<PublicKey>	PUBLIC_KEY
static final NetworkBuffer.Type<float[]>	QUATERNION
static final NetworkBuffer.Type<byte[]>	RAW_BYTES
static final NetworkBuffer.Type<Short>	SHORT
static final NetworkBuffer.Type<String>	STRING
static final NetworkBuffer.Type<String>	STRING_IO_UTF8
static final NetworkBuffer.Type<String>	STRING_TERMINATED
static final NetworkBuffer.Type<Unit>	UNIT
static final NetworkBuffer.Type<Short>	UNSIGNED_BYTE
static final NetworkBuffer.Type<Long>	UNSIGNED_INT
static final NetworkBuffer.Type<Integer>	UNSIGNED_SHORT
static final NetworkBuffer.Type<UUID>	UUID
static final NetworkBuffer.Type<Integer>	VAR_INT
static final NetworkBuffer.Type<Integer>	VAR_INT_3
static final NetworkBuffer.Type<int[]>	VAR_INT_ARRAY
static final NetworkBuffer.Type<Long>	VAR_LONG
static final NetworkBuffer.Type<long[]>	VAR_LONG_ARRAY
static final NetworkBuffer.Type<Point>	VECTOR3
static final NetworkBuffer.Type<Point>	VECTOR3B
static final NetworkBuffer.Type<Point>	VECTOR3D
static final NetworkBuffer.Type<Point>	VECTOR3I

Method Summary

Modifier and Type	Method	Description
long	advanceRead(long length)
long	advanceWrite(long length)
static NetworkBuffer.Builder	builder(long size)
long	capacity()
void	cipher(Cipher cipher, long start, long length)
NetworkBuffer	clear()
void	compact()
long	compress(long start, long length, NetworkBuffer output)
default NetworkBuffer	copy(long index, long length)
NetworkBuffer	copy(long index, long length, long readIndex, long writeIndex)
static void	copy(NetworkBuffer srcBuffer, long srcOffset, NetworkBuffer dstBuffer, long dstOffset, long length)
void	copyTo(long srcOffset, byte[] dest, int destOffset, int length)
void	copyTo(long srcOffset, MemorySegment dest, long destOffset, long length)
long	decompress(long start, long length, NetworkBuffer output)
static <L,R> NetworkBuffer.Type<Either<L,R>>	Either(NetworkBuffer.Type<L> left, NetworkBuffer.Type<R> right)
void	ensureReadable(long length)
void	ensureWritable(long length)
static <E extends Enum<E>> NetworkBuffer.Type<E>	Enum(Class<E> enumClass)
static <E extends Enum<E>> NetworkBuffer.Type<EnumSet<E>>	EnumSet(Class<E> enumClass)
static boolean	equals(NetworkBuffer buffer1, NetworkBuffer buffer2)
byte[]	extractBytes(Consumer<NetworkBuffer> extractor)
static NetworkBuffer.Type<BitSet>	FixedBitSet(int length)
static NetworkBuffer.Type<byte[]>	FixedRawBytes(int length)
NetworkBuffer	index(long readIndex, long writeIndex)
NetworkBuffer.IOView	ioView()	Creates a new NetworkBuffer.IOView of this buffer.
boolean	isReadOnly()
static <T> NetworkBuffer.Type<T>	Lazy(Supplier<NetworkBuffer.Type<T>> supplier)
static byte[]	makeArray(Consumer<NetworkBuffer> writing)
static byte[]	makeArray(Consumer<NetworkBuffer> writing, @Nullable Registries registries)
static <T> byte[]	makeArray(NetworkBuffer.Type<T> type, T value)
static <T> byte[]	makeArray(NetworkBuffer.Type<T> type, T value, @Nullable Registries registries)
<T extends @UnknownNullability Object> T	read(NetworkBuffer.Type<T> type)
long	readableBytes()
<T extends @UnknownNullability Object> T	readAt(long index, NetworkBuffer.Type<T> type)
int	readChannel(ReadableByteChannel channel)
long	readIndex()
NetworkBuffer	readIndex(long readIndex)
NetworkBuffer	readOnly()
static <T> NetworkBuffer.Type<T>	Recursive(Function<NetworkBuffer.Type<T>, NetworkBuffer.Type<T>> func)
@Nullable Registries	registries()
void	registries(@Nullable Registries registries)
static NetworkBuffer	resizableBuffer()
static NetworkBuffer	resizableBuffer(int initialSize)
static NetworkBuffer	resizableBuffer(long initialSize, Registries registries)
static NetworkBuffer	resizableBuffer(Registries registries)
void	resize(long newSize)
NetworkBuffer	slice(long offset, long byteLength, long readIndex, long writeIndex)	A slice is an operation where the backing memory is used for the new buffer.
static NetworkBuffer	staticBuffer(long size)
static NetworkBuffer	staticBuffer(long size, Registries registries)
static <T,D> NetworkBuffer.Type<T>	Tagged(NetworkBuffer.Type<D> discriminator, Function<? super T, ? extends D> discriminatorFromValue, Map<? super D, ? extends NetworkBuffer.Type<? extends T>> serializerMap)
static <T,D> NetworkBuffer.Type<T>	Tagged(NetworkBuffer.Type<D> discriminator, Function<? super T, ? extends D> discriminatorFromValue, Map<? super D, ? extends NetworkBuffer.Type<? extends T>> serializerMap, @Nullable NetworkBuffer.Type<? extends T> fallback)
static <T> NetworkBuffer.Type<T>	TypedNBT(Codec<T> serializer)
static NetworkBuffer	wrap(byte[] bytes, int readIndex, int writeIndex)
static NetworkBuffer	wrap(byte[] bytes, int readIndex, int writeIndex, @Nullable Registries registries)
static NetworkBuffer	wrap(MemorySegment segment, long readIndex, long writeIndex)
static NetworkBuffer	wrap(MemorySegment segment, long readIndex, long writeIndex, @Nullable Registries registries)
long	writableBytes()
<T extends @UnknownNullability Object> void	write(NetworkBuffer.Type<T> type, T value)
<T extends @UnknownNullability Object> void	writeAt(long index, NetworkBuffer.Type<T> type, T value)
boolean	writeChannel(WritableByteChannel channel)
long	writeIndex()
NetworkBuffer	writeIndex(long writeIndex)

Field Details

UNIT

static final NetworkBuffer.Type<Unit> UNIT

BOOLEAN

static final NetworkBuffer.Type<Boolean> BOOLEAN

BYTE

static final NetworkBuffer.Type<Byte> BYTE

UNSIGNED_BYTE

static final NetworkBuffer.Type<Short> UNSIGNED_BYTE

SHORT

static final NetworkBuffer.Type<Short> SHORT

UNSIGNED_SHORT

static final NetworkBuffer.Type<Integer> UNSIGNED_SHORT

INT

static final NetworkBuffer.Type<Integer> INT

UNSIGNED_INT

static final NetworkBuffer.Type<Long> UNSIGNED_INT

LONG

static final NetworkBuffer.Type<Long> LONG

FLOAT

static final NetworkBuffer.Type<Float> FLOAT

DOUBLE

static final NetworkBuffer.Type<Double> DOUBLE

VAR_INT

static final NetworkBuffer.Type<Integer> VAR_INT

OPTIONAL_VAR_INT

static final NetworkBuffer.Type<@Nullable Integer> OPTIONAL_VAR_INT

VAR_INT_3

static final NetworkBuffer.Type<Integer> VAR_INT_3

VAR_LONG

static final NetworkBuffer.Type<Long> VAR_LONG

RAW_BYTES

static final NetworkBuffer.Type<byte[]> RAW_BYTES

STRING

static final NetworkBuffer.Type<String> STRING

KEY

static final NetworkBuffer.Type<Key> KEY

STRING_TERMINATED

static final NetworkBuffer.Type<String> STRING_TERMINATED

STRING_IO_UTF8

static final NetworkBuffer.Type<String> STRING_IO_UTF8

NBT

static final NetworkBuffer.Type<BinaryTag> NBT

NBT_COMPOUND

static final NetworkBuffer.Type<CompoundBinaryTag> NBT_COMPOUND

BLOCK_POSITION

static final NetworkBuffer.Type<Point> BLOCK_POSITION

COMPONENT

static final NetworkBuffer.Type<Component> COMPONENT

JSON_COMPONENT

static final NetworkBuffer.Type<Component> JSON_COMPONENT

UUID

static final NetworkBuffer.Type<UUID> UUID

POS

static final NetworkBuffer.Type<Pos> POS

BYTE_ARRAY

static final NetworkBuffer.Type<byte[]> BYTE_ARRAY

LONG_ARRAY

static final NetworkBuffer.Type<long[]> LONG_ARRAY

VAR_INT_ARRAY

static final NetworkBuffer.Type<int[]> VAR_INT_ARRAY

VAR_LONG_ARRAY

static final NetworkBuffer.Type<long[]> VAR_LONG_ARRAY

BITSET

static final NetworkBuffer.Type<BitSet> BITSET

INSTANT_MS

static final NetworkBuffer.Type<Instant> INSTANT_MS

PUBLIC_KEY

static final NetworkBuffer.Type<PublicKey> PUBLIC_KEY

VECTOR3

static final NetworkBuffer.Type<Point> VECTOR3

VECTOR3D

static final NetworkBuffer.Type<Point> VECTOR3D

VECTOR3I

static final NetworkBuffer.Type<Point> VECTOR3I

VECTOR3B

static final NetworkBuffer.Type<Point> VECTOR3B

LP_VECTOR3

static final NetworkBuffer.Type<Vec> LP_VECTOR3

QUATERNION

static final NetworkBuffer.Type<float[]> QUATERNION

OPT_CHAT

static final NetworkBuffer.Type<@Nullable Component> OPT_CHAT

OPT_BLOCK_POSITION

static final NetworkBuffer.Type<@Nullable Point> OPT_BLOCK_POSITION

DIRECTION

static final NetworkBuffer.Type<Direction> DIRECTION

POSE

static final NetworkBuffer.Type<EntityPose> POSE

Method Details

Enum

static <E extends Enum<E>> NetworkBuffer.Type<E> Enum(Class<E> enumClass)

EnumSet

static <E extends Enum<E>>
NetworkBuffer.Type<EnumSet<E>> EnumSet(Class<E> enumClass)

FixedBitSet

static NetworkBuffer.Type<BitSet> FixedBitSet(int length)

FixedRawBytes

static NetworkBuffer.Type<byte[]> FixedRawBytes(int length)

Lazy

static <T> NetworkBuffer.Type<T> Lazy(Supplier<NetworkBuffer.Type<T>> supplier)

TypedNBT

static <T> NetworkBuffer.Type<T> TypedNBT(Codec<T> serializer)

Either

static <L,R> NetworkBuffer.Type<Either<L,R>> Either(NetworkBuffer.Type<L> left,
 NetworkBuffer.Type<R> right)

Recursive

static <T> NetworkBuffer.Type<T> Recursive(Function<NetworkBuffer.Type<T>, NetworkBuffer.Type<T>> func)

Tagged

static <T,D> NetworkBuffer.Type<T> Tagged(NetworkBuffer.Type<D> discriminator,
 Function<? super T, ? extends D> discriminatorFromValue,
 Map<? super D, ? extends NetworkBuffer.Type<? extends T>> serializerMap,
 @Nullable
 @Nullable NetworkBuffer.Type<? extends T> fallback)

Tagged

static <T,D> NetworkBuffer.Type<T> Tagged(NetworkBuffer.Type<D> discriminator,
 Function<? super T, ? extends D> discriminatorFromValue,
 Map<? super D, ? extends NetworkBuffer.Type<? extends T>> serializerMap)

write

<T extends @UnknownNullability Object> void write(NetworkBuffer.Type<T> type,
 T value)
                                           throws IndexOutOfBoundsException

Throws:

IndexOutOfBoundsException

read

<T extends @UnknownNullability Object> T read(NetworkBuffer.Type<T> type)
                                       throws IndexOutOfBoundsException

Throws:

IndexOutOfBoundsException

writeAt

<T extends @UnknownNullability Object> void writeAt(long index,
 NetworkBuffer.Type<T> type,
 T value)
                                             throws IndexOutOfBoundsException

Throws:

IndexOutOfBoundsException

readAt

<T extends @UnknownNullability Object> T readAt(long index,
 NetworkBuffer.Type<T> type)
                                         throws IndexOutOfBoundsException

Throws:

IndexOutOfBoundsException

copyTo

void copyTo(long srcOffset,
 byte[] dest,
 int destOffset,
 int length)

copyTo

void copyTo(long srcOffset,
 MemorySegment dest,
 long destOffset,
 long length)

extractBytes

byte[] extractBytes(Consumer<NetworkBuffer> extractor)

clear

NetworkBuffer clear()

writeIndex

long writeIndex()

readIndex

long readIndex()

writeIndex

NetworkBuffer writeIndex(long writeIndex)

readIndex

NetworkBuffer readIndex(long readIndex)

index

NetworkBuffer index(long readIndex,
 long writeIndex)

advanceWrite

long advanceWrite(long length)

advanceRead

long advanceRead(long length)

readableBytes

long readableBytes()

writableBytes

long writableBytes()

capacity

long capacity()

readOnly

@Contract(pure=true,
          value="-> new")
NetworkBuffer readOnly()

isReadOnly

boolean isReadOnly()

resize

void resize(long newSize)

ensureWritable

void ensureWritable(long length)
             throws IndexOutOfBoundsException

Throws:

IndexOutOfBoundsException

ensureReadable

void ensureReadable(long length)
             throws IndexOutOfBoundsException

Throws:

IndexOutOfBoundsException

compact

void compact()

copy

NetworkBuffer copy(long index,
 long length,
 long readIndex,
 long writeIndex)

copy

default NetworkBuffer copy(long index,
 long length)

readChannel

int readChannel(ReadableByteChannel channel)
         throws IOException

Throws:

IOException

writeChannel

boolean writeChannel(WritableByteChannel channel)
              throws IOException

Throws:

IOException

cipher

void cipher(Cipher cipher,
 long start,
 long length)

compress

long compress(long start,
 long length,
 NetworkBuffer output)

decompress

long decompress(long start,
 long length,
 NetworkBuffer output)
         throws DataFormatException

Throws:

DataFormatException

registries

@Nullable
@Nullable Registries registries()

registries

void registries(@Nullable
 @Nullable Registries registries)

slice

@Contract(pure=true,
          value="_, _, _, _ -> new")
NetworkBuffer slice(long offset,
 long byteLength,
 long readIndex,
 long writeIndex)

A slice is an operation where the backing memory is used for the new buffer. Consider it a view over the backing memory region.

Parameters:

offset - the position to start the slice

byteLength - the length of the slice, equal to capacity()

readIndex - the read index

writeIndex - the write index

Returns:

a new buffer

Throws:

IllegalArgumentException - if this buffer is a dummy

API Note:

With resized segments, you could observe behavior where you may see stale data or close arenas. To avoid this, do not use resizable segments in a way where they are written or resized like resize(long).

Implementation Note:

registries() are copied into the new buffer

ioView

@Experimental
@Contract(pure=true,
          value="-> new")
NetworkBuffer.IOView ioView()

Creates a new NetworkBuffer.IOView of this buffer.
Useful to interface with API's that support DataInput or DataOutput.

Returns:

the io view.

builder

static NetworkBuffer.Builder builder(long size)

staticBuffer

static NetworkBuffer staticBuffer(long size,
 Registries registries)

staticBuffer

static NetworkBuffer staticBuffer(long size)

resizableBuffer

static NetworkBuffer resizableBuffer(long initialSize,
 Registries registries)

resizableBuffer

static NetworkBuffer resizableBuffer(int initialSize)

resizableBuffer

static NetworkBuffer resizableBuffer(Registries registries)

resizableBuffer

static NetworkBuffer resizableBuffer()

wrap

static NetworkBuffer wrap(MemorySegment segment,
 long readIndex,
 long writeIndex,
 @Nullable
 @Nullable Registries registries)

wrap

static NetworkBuffer wrap(MemorySegment segment,
 long readIndex,
 long writeIndex)

wrap

static NetworkBuffer wrap(byte[] bytes,
 int readIndex,
 int writeIndex,
 @Nullable
 @Nullable Registries registries)

wrap

static NetworkBuffer wrap(byte[] bytes,
 int readIndex,
 int writeIndex)

makeArray

static byte[] makeArray(Consumer<NetworkBuffer> writing,
 @Nullable
 @Nullable Registries registries)

makeArray

static byte[] makeArray(Consumer<NetworkBuffer> writing)

makeArray

static <T> byte[] makeArray(NetworkBuffer.Type<T> type,
 T value,
 @Nullable
 @Nullable Registries registries)

makeArray

static <T> byte[] makeArray(NetworkBuffer.Type<T> type,
 T value)

copy

static void copy(NetworkBuffer srcBuffer,
 long srcOffset,
 NetworkBuffer dstBuffer,
 long dstOffset,
 long length)

equals

static boolean equals(NetworkBuffer buffer1,
 NetworkBuffer buffer2)