https://github.com/jhg023/pbbl

A thread-safe ByteBuffer pool that allows for the automatic reuse of ByteBuffers, which can be over 30x faster than having to allocate a new ByteBuffer when needed.
https://github.com/jhg023/pbbl

byte bytebuffer bytes java java-11 pool pooling

Last synced: about 8 hours ago
JSON representation

A thread-safe ByteBuffer pool that allows for the automatic reuse of ByteBuffers, which can be over 30x faster than having to allocate a new ByteBuffer when needed.

• Host: GitHub
• URL: https://github.com/jhg023/pbbl
• Owner: jhg023
• License: mit
• Created: 2019-02-23T20:59:48.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-05-25T20:13:41.000Z (over 4 years ago)
• Last Synced: 2024-09-24T20:50:49.230Z (about 13 hours ago)
• Topics: byte, bytebuffer, bytes, java, java-11, pool, pooling
• Language: Java
• Size: 17.6 KB
• Stars: 37
• Watchers: 1
• Forks: 10
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Pbbl (pr. _pebble_, pɛbəl)

A thread-safe [Buffer](https://docs.oracle.com/en/java/javase/14/docs/api/java.base/java/nio/Buffer.html) pool that allows for the automatic reuse of `Buffer` objects (including [`ByteBuffer`](https://docs.oracle.com/en/java/javase/14/docs/api/java.base/java/nio/ByteBuffer.html), [`CharBuffer`](https://docs.oracle.com/en/java/javase/14/docs/api/java.base/java/nio/CharBuffer.html), etc.), which can be over 30x faster than having to allocate a new `Buffer`.

# Maven/Gradle Dependency

 1. Add Pbbl as a dependency using either Maven or Gradle:

Maven:

```xml

  com.github.jhg023

  Pbbl

  1.0.2

```

Gradle:

```groovy

implementation 'com.github.jhg023:Pbbl:1.0.2'

```

 2. Because Pbbl is compiled with Java 11, you must require its module in your `module-info.java`:

```java

module my.project {

    requires com.github.pbbl;

}

```

# Example(s)

1. Create `ByteBufferPool` and manually close it:

```java

// Create a ByteBufferPool (used to pool non-direct ByteBuffer objects).

var pool = new ByteBufferPool();

// Take a non-direct ByteBuffer (with 8 available bytes) from the pool.

// If the pool is empty, a new ByteBuffer will be created.

var buffer = pool.take(Long.BYTES);

// Do something with the ByteBuffer.

var array = buffer.putLong(42).array();

// Give the ByteBuffer back to the pool for re-use.

pool.give(buffer);

// Close the pool when finished.

pool.close();

```

2. Create `DirectFloatBufferPool` and automatically close it:

```java

// Create a DirectFloatBufferPool (used to pool direct FloatBuffer objects).

try (var pool = new DirectFloatBufferPool()) {

    // Take a direct FloatBuffer (with 8 available floats) from the pool.

    FloatBuffer buffer = pool.take(8);

    

    // Do something with the FloatBuffer.

    buffer.put(42f);

    

    // Give the FloatBuffer back to the pool for re-use.

    pool.give(buffer);

}

```