A pool for RetainableByteBuffer instances.

RetainableByteBuffer that are acquired must be released by calling RetainableByteBuffer#release() otherwise the memory they hold will be leaked.

API NOTE

This interface does not have a symmetric release(RetainableByteBuffer) method, because it will be confusing to use due to the fact that the acquired instance is-a Retainable.

Imagine this (hypothetical) code sequence:

RetainableByteBuffer buffer = pool.acquire(size, direct);
buffer.retain();
pool.release(buffer);

The hypothetical call to release(RetainableByteBuffer) would appear to release the buffer to the pool, but in fact the buffer is retained one more time (and therefore still in use) and not really released to the pool. For this reason there is no release(RetainableByteBuffer) method.

Therefore, in order to track acquire/release counts both the pool and the buffer returned by acquire(int, boolean) must be wrapped, see RetainableByteBuffer.Wrapper

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	ByteBufferPool.Accumulator Accumulates a sequence of `RetainableByteBuffer` that are typically created during the generation of protocol bytes.
public static class	ByteBufferPool.NonPooling A `ByteBufferPool` that does not pool its `RetainableByteBuffer`s.
public static class	ByteBufferPool.Wrapper A wrapper for `ByteBufferPool` instances.

Method Summary

Modifier and Type	Method and Description
public RetainableByteBuffer	Returns: a `RetainableByteBuffer` with position and limit set to 0. acquire(int The size of the buffer. The returned buffer will have at least this capacity. size, boolean true if a direct memory buffer is needed, false otherwise. direct) Acquires a `RetainableByteBuffer` from this pool.
public void	clear() Removes all `non-retained` pooled instances from this pool.

Method Detail

acquire back to summary

acquire	back to summary
public RetainableByteBuffer acquire(int size, boolean direct) Acquires a `RetainableByteBuffer` from this pool. Parameters size:int The size of the buffer. The returned buffer will have at least this capacity. direct:boolean true if a direct memory buffer is needed, false otherwise. Returns:RetainableByteBuffer a `RetainableByteBuffer` with position and limit set to 0.

public RetainableByteBuffer acquire(int size, boolean direct)

Acquires a RetainableByteBuffer from this pool.

Parameters

size:int: The size of the buffer. The returned buffer will have at least this capacity.
direct:boolean: true if a direct memory buffer is needed, false otherwise.

Returns:RetainableByteBuffer

a RetainableByteBuffer with position and limit set to 0.

clear	back to summary
public void clear() Removes all `non-retained` pooled instances from this pool.

org.eclipse.jetty.io back to summary

public Class ByteBufferPool.Accumulator

Class Inheritance

extends Object

java.lang.Object
org.eclipse.jetty.io.ByteBufferPool.Accumulator

Accumulates a sequence of RetainableByteBuffer that are typically created during the generation of protocol bytes.

RetainableByteBuffers can be either appended to the sequence, or inserted at a specific position in the sequence, and then released when they are consumed.

Field Summary

Modifier and Type	Field and Description
private final List<RetainableByteBuffer>	buffers
private final List<ByteBuffer>	byteBuffers

Constructor Summary

Access	Constructor and Description
public	Accumulator()

Method Summary

Modifier and Type	Method and Description
public void	append(RetainableByteBuffer buffer)
public List<ByteBuffer>	getByteBuffers()
public int	getSize()
public long	getTotalLength()
public void	insert(int index, RetainableByteBuffer buffer)
public void	release()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

buffers	back to summary
private final List<RetainableByteBuffer> buffers

byteBuffers	back to summary
private final List<ByteBuffer> byteBuffers

Constructor Detail

Accumulator	back to summary
public Accumulator()

Method Detail

append	back to summary
public void append(RetainableByteBuffer buffer)

getByteBuffers	back to summary
public List<ByteBuffer> getByteBuffers()

getSize	back to summary
public int getSize()

getTotalLength	back to summary
public long getTotalLength()

insert	back to summary
public void insert(int index, RetainableByteBuffer buffer)

release	back to summary
public void release()

org.eclipse.jetty.io back to summary

public Class ByteBufferPool.NonPooling

Class Inheritance

extends Object
implements ByteBufferPool

java.lang.Object
org.eclipse.jetty.io.ByteBufferPool.NonPooling

All Implemented Interfaces

org.eclipse.jetty.io.ByteBufferPool

A ByteBufferPool that does not pool its RetainableByteBuffers.

The returned RetainableByteBuffers are reference counted.

RetainableByteBuffers returned by this class are suitable to be wrapped in other Retainable implementations that may delegate calls to Retainable#retain().

See Also: RetainableByteBuffer#wrap(ByteBuffer)

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	ByteBufferPool.NonPooling.Buffer

Constructor Summary

Access	Constructor and Description
public	NonPooling()

Method Summary

Modifier and Type	Method and Description
public RetainableByteBuffer	acquire(int The size of the buffer. The returned buffer will have at least this capacity. size, boolean true if a direct memory buffer is needed, false otherwise. direct) Implements org.eclipse.jetty.io.ByteBufferPool.acquire. Acquires a `RetainableByteBuffer` from this pool.
public void	clear() Implements org.eclipse.jetty.io.ByteBufferPool.clear. Removes all `non-retained` pooled instances from this pool.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

NonPooling	back to summary
public NonPooling()

Method Detail

acquire back to summary

acquire	back to summary
public RetainableByteBuffer acquire(int size, boolean direct) Implements org.eclipse.jetty.io.ByteBufferPool.acquire. Doc from org.eclipse.jetty.io.ByteBufferPool.acquire. Acquires a `RetainableByteBuffer` from this pool. Parameters size:int The size of the buffer. The returned buffer will have at least this capacity. direct:boolean true if a direct memory buffer is needed, false otherwise. Returns:RetainableByteBuffer a `RetainableByteBuffer` with position and limit set to 0. Annotations @Override

public RetainableByteBuffer acquire(int size, boolean direct)

Implements org.eclipse.jetty.io.ByteBufferPool.acquire.

Doc from org.eclipse.jetty.io.ByteBufferPool.acquire.

Acquires a RetainableByteBuffer from this pool.

Parameters

size:int: The size of the buffer. The returned buffer will have at least this capacity.
direct:boolean: true if a direct memory buffer is needed, false otherwise.

Returns:RetainableByteBuffer

a RetainableByteBuffer with position and limit set to 0.

Annotations

@Override

clear back to summary

clear	back to summary
public void clear() Implements org.eclipse.jetty.io.ByteBufferPool.clear. Doc from org.eclipse.jetty.io.ByteBufferPool.clear. Removes all `non-retained` pooled instances from this pool. Annotations @Override

public void clear()

Implements org.eclipse.jetty.io.ByteBufferPool.clear.

Doc from org.eclipse.jetty.io.ByteBufferPool.clear.

Removes all non-retained pooled instances from this pool.

Annotations

@Override

org.eclipse.jetty.io back to summary

private Class ByteBufferPool.NonPooling.Buffer

Class Inheritance

extends AbstractRetainableByteBuffer

java.lang.Object
org.eclipse.jetty.io.AbstractRetainableByteBuffer
org.eclipse.jetty.io.ByteBufferPool.NonPooling.Buffer

Constructor Summary

Access	Constructor and Description
private	Buffer(ByteBuffer byteBuffer)

Method Summary

Inherited from org.eclipse.jetty.io.AbstractRetainableByteBuffer:: acquire canRetain getByteBuffer isRetained release retain toString

Constructor Detail

Buffer	back to summary
private Buffer(ByteBuffer byteBuffer)

public Interface ByteBufferPool

Nested and Inner Type Summary

Method Summary

Method Detail

public Class ByteBufferPool.Accumulator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class ByteBufferPool.NonPooling

Nested and Inner Type Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class ByteBufferPool.NonPooling.Buffer

Constructor Summary

Method Summary

Constructor Detail

public Class ByteBufferPool.Wrapper

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail