Package io.netty5.buffer.api

Class BufferRef

java.lang.Object

io.netty5.buffer.api.BufferHolder<BufferRef>

io.netty5.buffer.api.BufferRef

All Implemented Interfaces:

Resource<BufferRef>, AutoCloseable

public final class BufferRef
extends BufferHolder<BufferRef>

A mutable reference to a buffer.

Constructor Summary

Constructors

Constructor	Description
BufferRef(Send<Buffer> send)	Create a reference that holds the exclusive ownership of the sent buffer.

Method Summary

Modifier and Type	Method	Description
Buffer	content()	Access the buffer in this reference.
protected BufferRef	receive(Buffer buf)	Called when a sent BufferHolder is received by the recipient.
void	replace(Send<Buffer> send)	Replace the underlying referenced buffer with the given buffer.

Methods inherited from class io.netty5.buffer.api.BufferHolder

close, equals, getBuffer, getBufferVolatile, hashCode, isAccessible, replaceBuffer, replaceBufferVolatile, send, touch

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BufferRef

public BufferRef(Send<Buffer> send)

Create a reference that holds the exclusive ownership of the sent buffer.

Parameters:

send - The sent buffer to take ownership of.

Method Detail

receive

protected BufferRef receive(Buffer buf)

Description copied from class: BufferHolder

Called when a sent BufferHolder is received by the recipient. The BufferHolder should return a new concrete instance, that wraps the given Buffer object.

Specified by:

receive in class BufferHolder<BufferRef>

Parameters:

buf - The Buffer that is received by the recipient, and needs to be wrapped in a new BufferHolder instance.

Returns:

A new buffer holder instance, containing the given buffer.

replace

public void replace(Send<Buffer> send)

Replace the underlying referenced buffer with the given buffer.

Note: this method closes the current buffer, and takes exclusive ownership of the received buffer.

The buffer assignment is performed using a volatile store.

Parameters:

send - The Send with the new Buffer instance that is replacing the currently held buffer.

content

public Buffer content()

Access the buffer in this reference.

Returns:

The buffer held by the reference.