ByteBufferPool (XNIO API 3.4.0.Final API)

java.lang.Object
- org.xnio.ByteBufferPool

public abstract class ByteBufferPool
extends Object

A fast source of pooled buffers.

Author:: David M. Lloyd

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ByteBufferPool.Set` A set of buffer pools for each size, which can either be `ByteBufferPool.Set.DIRECT` or `ByteBufferPool.Set.HEAP`.

Field Summary

Fields
Modifier and Type	Field and Description
`static ByteBufferPool`	`LARGE_DIRECT` The large direct buffer pool.
`static ByteBufferPool`	`LARGE_HEAP` The large heap buffer pool.
`static int`	`LARGE_SIZE` The size of large buffers.
`static ByteBufferPool`	`MEDIUM_DIRECT` The medium direct buffer pool.
`static ByteBufferPool`	`MEDIUM_HEAP` The medium heap buffer pool.
`static int`	`MEDIUM_SIZE` The size of medium buffers.
`static ByteBufferPool`	`SMALL_DIRECT` The small direct buffer pool.
`static ByteBufferPool`	`SMALL_HEAP` The small heap buffer pool.
`static int`	`SMALL_SIZE` The size of small buffers.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ByteBuffer`	`allocate()` Allocate a buffer from this source pool.
`void`	`allocate(ByteBuffer[] array, int offs)` Bulk-allocate buffers from this pool.
`void`	`allocate(ByteBuffer[] array, int offs, int len)` Bulk-allocate buffers from this pool.
`static void`	`free(ByteBuffer buffer)` Free a buffer into its appropriate pool based on its size.
`static void`	`free(ByteBuffer[] array, int offs, int len)` Bulk-free buffers from an array as with `free(ByteBuffer)`.
`int`	`getSize()` Get the size of buffers returned by this source.
`boolean`	`isDirect()` Determine if this source returns direct buffers.
`static void`	`zeroAndFree(ByteBuffer buffer)` Free a buffer as with `free(ByteBuffer)` except the buffer is first zeroed and cleared.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - LARGE_SIZE
```
public static final int LARGE_SIZE
```
    The size of large buffers.
    
    See Also:
    
    Constant Field Values
  - MEDIUM_SIZE
```
public static final int MEDIUM_SIZE
```
    The size of medium buffers.
    
    See Also:
    
    Constant Field Values
  - SMALL_SIZE
```
public static final int SMALL_SIZE
```
    The size of small buffers.
    
    See Also:
    
    Constant Field Values
  - LARGE_DIRECT
```
public static final ByteBufferPool LARGE_DIRECT
```
    The large direct buffer pool. This pool produces buffers of LARGE_SIZE.
  - MEDIUM_DIRECT
```
public static final ByteBufferPool MEDIUM_DIRECT
```
    The medium direct buffer pool. This pool produces buffers of MEDIUM_SIZE.
  - SMALL_DIRECT
```
public static final ByteBufferPool SMALL_DIRECT
```
    The small direct buffer pool. This pool produces buffers of SMALL_SIZE.
  - LARGE_HEAP
```
public static final ByteBufferPool LARGE_HEAP
```
    The large heap buffer pool. This pool produces buffers of LARGE_SIZE.
  - MEDIUM_HEAP
```
public static final ByteBufferPool MEDIUM_HEAP
```
    The medium heap buffer pool. This pool produces buffers of MEDIUM_SIZE.
  - SMALL_HEAP
```
public static final ByteBufferPool SMALL_HEAP
```
    The small heap buffer pool. This pool produces buffers of SMALL_SIZE.
- Method Detail
  - allocate
```
public ByteBuffer allocate()
```
    Allocate a buffer from this source pool. The buffer must be freed through the free(ByteBuffer) method.
    
    Returns:
    
    the allocated buffer
  - allocate
```
public void allocate(ByteBuffer[] array,
                     int offs)
```
    Bulk-allocate buffers from this pool. The buffer must be freed through the free(ByteBuffer) method.
    
    Parameters:
    
    array - the array of buffers to fill
    
    offs - the offset into the array to fill
  - allocate
```
public void allocate(ByteBuffer[] array,
                     int offs,
                     int len)
```
    Bulk-allocate buffers from this pool. The buffer must be freed through the free(ByteBuffer) method.
    
    Parameters:
    
    array - the array of buffers to fill
    
    offs - the offset into the array to fill
    
    len - the number of buffers to fill in the array
  - free
```
public static void free(ByteBuffer buffer)
```
    Free a buffer into its appropriate pool based on its size. Care must be taken to avoid returning a slice of a pooled buffer, since this could cause both the buffer and its slice to be separately repooled, leading to likely data corruption.
    
    Parameters:
    
    buffer - the buffer to free
  - free
```
public static void free(ByteBuffer[] array,
                        int offs,
                        int len)
```
    Bulk-free buffers from an array as with free(ByteBuffer). The freed entries will be assigned to null.
    
    Parameters:
    
    array - the buffer array
    
    offs - the offset into the array
    
    len - the number of buffers to free
  - zeroAndFree
```
public static void zeroAndFree(ByteBuffer buffer)
```
    Free a buffer as with free(ByteBuffer) except the buffer is first zeroed and cleared.
    
    Parameters:
    
    buffer - the buffer to free
  - isDirect
```
public boolean isDirect()
```
    Determine if this source returns direct buffers.
    
    Returns:
    
    true if the buffers are direct, false if they are heap
  - getSize
```
public int getSize()
```
    Get the size of buffers returned by this source. The size will be a power of two.
    
    Returns:
    
    the size of buffers returned by this source

Class ByteBufferPool

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LARGE_SIZE

MEDIUM_SIZE

SMALL_SIZE

LARGE_DIRECT

MEDIUM_DIRECT

SMALL_DIRECT

LARGE_HEAP

MEDIUM_HEAP

SMALL_HEAP

Method Detail

allocate

allocate

allocate

free

free

zeroAndFree

isDirect

getSize