Class NettyReadBufferFactory

java.lang.Object
io.micronaut.core.io.buffer.ReadBufferFactory
io.micronaut.buffer.netty.NettyReadBufferFactory
public final class NettyReadBufferFactory extends io.micronaut.core.io.buffer.ReadBufferFactory
Netty-based ReadBufferFactory. Also has additional utilities for dealing with netty buffers.
Since:
4.10.0

  • Nested Class Summary

    Nested classes/interfaces inherited from class io.micronaut.core.io.buffer.ReadBufferFactory

    io.micronaut.core.io.buffer.ReadBufferFactory.BufferingOutputStream

  • Method Summary

    Modifier and Type
    Method
    Description
    io.micronaut.core.io.buffer.ReadBuffer
    adapt(byte[] array)
     
    io.micronaut.core.io.buffer.ReadBuffer
    adapt(io.micronaut.core.io.buffer.ByteBuffer<?> buffer)
     
    io.micronaut.core.io.buffer.ReadBuffer
    adapt(io.netty.buffer.ByteBuf buffer)
    Create a buffer with the given input data.
    io.micronaut.core.io.buffer.ReadBuffer
    adapt(ByteBuffer nioBuffer)
     
    <T extends Throwable>
    io.micronaut.core.io.buffer.ReadBuffer
    buffer(io.micronaut.core.util.functional.ThrowingConsumer<? super OutputStream, T> writer)
     
    io.micronaut.core.io.buffer.ReadBuffer
    compose(Iterable<io.micronaut.core.io.buffer.ReadBuffer> buffers)
     
    io.micronaut.core.io.buffer.ReadBuffer
    copyOf(InputStream stream)
     
    io.micronaut.core.io.buffer.ReadBuffer
    copyOf(CharSequence cs, Charset charset)
     
    io.micronaut.core.io.buffer.ReadBuffer
    copyOf(ByteBuffer nioBuffer)
     
    @Nullable io.micronaut.core.io.buffer.ReadBuffer
    copyOf(ScatteringByteChannel channel, int n)
     
    io.micronaut.core.io.buffer.ReadBuffer
    createEmpty()
     
    static NettyReadBufferFactory
    of(io.netty.buffer.ByteBufAllocator allocator)
    Get a buffer factory associated with the given allocator.
    io.micronaut.core.io.buffer.ReadBufferFactory.BufferingOutputStream
    outputStreamBuffer()
     
    static io.netty.buffer.ByteBuf
    toByteBuf(io.micronaut.core.io.buffer.ReadBuffer readBuffer)
    Convert the given ReadBuffer to a netty ByteBuf.

    Methods inherited from class io.micronaut.core.io.buffer.ReadBufferFactory

    getJdkFactory

    Methods inherited from class Object

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

  • Method Details

    • of

      public static NettyReadBufferFactory of(io.netty.buffer.ByteBufAllocator allocator)
      Get a buffer factory associated with the given allocator.
      Parameters:
      allocator - The allocator to use
      Returns:
      The buffer factory

    • createEmpty

      public io.micronaut.core.io.buffer.ReadBuffer createEmpty()
      Overrides:
      createEmpty in class io.micronaut.core.io.buffer.ReadBufferFactory

    • copyOf

      public io.micronaut.core.io.buffer.ReadBuffer copyOf(CharSequence cs, Charset charset)
      Overrides:
      copyOf in class io.micronaut.core.io.buffer.ReadBufferFactory

    • copyOf

      public io.micronaut.core.io.buffer.ReadBuffer copyOf(InputStream stream) throws IOException
      Overrides:
      copyOf in class io.micronaut.core.io.buffer.ReadBufferFactory
      Throws:
      IOException

    • copyOf

      public @Nullable io.micronaut.core.io.buffer.ReadBuffer copyOf(ScatteringByteChannel channel, int n) throws IOException
      Overrides:
      copyOf in class io.micronaut.core.io.buffer.ReadBufferFactory
      Throws:
      IOException

    • copyOf

      public io.micronaut.core.io.buffer.ReadBuffer copyOf(ByteBuffer nioBuffer)
      Overrides:
      copyOf in class io.micronaut.core.io.buffer.ReadBufferFactory

    • adapt

      public io.micronaut.core.io.buffer.ReadBuffer adapt(ByteBuffer nioBuffer)
      Overrides:
      adapt in class io.micronaut.core.io.buffer.ReadBufferFactory

    • adapt

      public io.micronaut.core.io.buffer.ReadBuffer adapt(io.micronaut.core.io.buffer.ByteBuffer<?> buffer)
      Overrides:
      adapt in class io.micronaut.core.io.buffer.ReadBufferFactory

    • adapt

      public io.micronaut.core.io.buffer.ReadBuffer adapt(byte[] array)
      Overrides:
      adapt in class io.micronaut.core.io.buffer.ReadBufferFactory

    • adapt

      public io.micronaut.core.io.buffer.ReadBuffer adapt(io.netty.buffer.ByteBuf buffer)
      Create a buffer with the given input data. Whether the data is copied or used as-is is implementation-defined. Ownership of the given buffer transfers to this class, so it should not be modified elsewhere after this method is called. Release ownership also transfers to this class.
      Parameters:
      buffer - A buffer
      Returns:
      The adapted buffer

    • toByteBuf

      public static io.netty.buffer.ByteBuf toByteBuf(io.micronaut.core.io.buffer.ReadBuffer readBuffer)
      Convert the given ReadBuffer to a netty ByteBuf. This is a consuming operation.
      Parameters:
      readBuffer - The buffer to read from
      Returns:
      The read data

    • buffer

      public <T extends Throwable> io.micronaut.core.io.buffer.ReadBuffer buffer(io.micronaut.core.util.functional.ThrowingConsumer<? super OutputStream, T> writer) throws T
      Overrides:
      buffer in class io.micronaut.core.io.buffer.ReadBufferFactory
      Throws:
      T

    • outputStreamBuffer

      public io.micronaut.core.io.buffer.ReadBufferFactory.BufferingOutputStream outputStreamBuffer()
      Overrides:
      outputStreamBuffer in class io.micronaut.core.io.buffer.ReadBufferFactory

    • compose

      public io.micronaut.core.io.buffer.ReadBuffer compose(Iterable<io.micronaut.core.io.buffer.ReadBuffer> buffers)
      Overrides:
      compose in class io.micronaut.core.io.buffer.ReadBufferFactory