Package io.netty.buffer

Class UnpooledByteBufAllocator.DecrementingCleanableDirectBuffer

java.lang.Object

io.netty.buffer.UnpooledByteBufAllocator.DecrementingCleanableDirectBuffer

All Implemented Interfaces:

CleanableDirectBuffer

Enclosing class:

UnpooledByteBufAllocator

private static final class UnpooledByteBufAllocator.DecrementingCleanableDirectBuffer
extends java.lang.Object
implements CleanableDirectBuffer

Field Summary

Fields

Modifier and Type	Field	Description
private UnpooledByteBufAllocator	alloc
private CleanableDirectBuffer	delegate

Constructor Summary

Constructors

Modifier	Constructor	Description
private	DecrementingCleanableDirectBuffer(ByteBufAllocator alloc, CleanableDirectBuffer delegate)
private	DecrementingCleanableDirectBuffer(ByteBufAllocator alloc, CleanableDirectBuffer delegate, int capacityConsumed)

Method Summary

Modifier and Type	Method	Description
java.nio.ByteBuffer	buffer()	Get the buffer instance.
void	clean()	Deallocate the buffer.
boolean	hasMemoryAddress()
long	memoryAddress()	Get the native memory address, but only if CleanableDirectBuffer.hasMemoryAddress() returns true, otherwise this may return an unspecified value or throw an exception.

Methods inherited from class java.lang.Object

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

Field Detail

alloc

private final UnpooledByteBufAllocator alloc

delegate

private final CleanableDirectBuffer delegate

Constructor Detail

DecrementingCleanableDirectBuffer

private DecrementingCleanableDirectBuffer(ByteBufAllocator alloc,
                                          CleanableDirectBuffer delegate)

DecrementingCleanableDirectBuffer

private DecrementingCleanableDirectBuffer(ByteBufAllocator alloc,
                                          CleanableDirectBuffer delegate,
                                          int capacityConsumed)

Method Detail

buffer

public java.nio.ByteBuffer buffer()

Description copied from interface: CleanableDirectBuffer

Get the buffer instance.

Note: the buffer must not be accessed after the CleanableDirectBuffer.clean() method has been called.

Specified by:

buffer in interface CleanableDirectBuffer

Returns:

The ByteBuffer instance.

clean

public void clean()

Description copied from interface: CleanableDirectBuffer

Deallocate the buffer. This method can only be called once per instance, and all usages of the buffer must have ceased before this method is called, and the buffer must not be accessed again after this method has been called.

Specified by:

clean in interface CleanableDirectBuffer

hasMemoryAddress

public boolean hasMemoryAddress()

Specified by:

hasMemoryAddress in interface CleanableDirectBuffer

Returns:

true if the native memory address is available, otherwise false.

memoryAddress

public long memoryAddress()

Description copied from interface: CleanableDirectBuffer

Get the native memory address, but only if CleanableDirectBuffer.hasMemoryAddress() returns true, otherwise this may return an unspecified value or throw an exception.

Specified by:

memoryAddress in interface CleanableDirectBuffer

Returns:

The native memory address of this buffer, if available.