DynamicCompositeByteBuf (brpc-java 2.5.9 API)

java.lang.Object
- com.baidu.brpc.buffer.DynamicCompositeByteBuf

```
public class DynamicCompositeByteBuf
extends Object
```
dynamically composite multi ByteBuf, and it can be read just like a normal ByteBuf. it can be constructed by one or many readable ByteBuf, reference count of these buffers is not retained, and are managed by DynamicCompositeByteBuf. when dynamic composite byte buffer release, it will release every sub buffers. when the readable size of a sub buffer is zero, it will be removed from dynamic composite byte buffer, and will be release. Currently, DynamicCompositeByteBuf does not support to write bytes, because netty ByteBuf has satisfied already.

构造器概要

构造器
构造器和说明
`DynamicCompositeByteBuf()`
`DynamicCompositeByteBuf(io.netty.buffer.ByteBuf buf)` construct a new `DynamicCompositeByteBuf` with netty `ByteBuf`.
`DynamicCompositeByteBuf(io.netty.buffer.ByteBuf[] bufs, int offset, int len)` construct a new `DynamicCompositeByteBuf` with netty `ByteBuf` array.
`DynamicCompositeByteBuf(int capacity)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`addBuffer(io.netty.buffer.ByteBuf buffer)` add netty `ByteBuf` to `DynamicCompositeByteBuf`.
`byte[]`	`array()` it not check hasArray for performance
`int`	`arrayOffset()` it not check hasArray for performance
`boolean`	`hasArray()`
`boolean`	`isEmpty()`
`boolean`	`isReadable()`
`io.netty.buffer.ByteBuf`	`nettyByteBuf()` convert `DynamicCompositeByteBuf` to netty `ByteBuf`, the reference count of its underlying buffers are not increased.
`ByteOrder`	`order()`
`int`	`readableBytes()`
`byte`	`readByte()` Gets a byte at the current `readerIndex` and increases the `readerIndex` by `1` in this buffer.
`DynamicCompositeByteBuf`	`readBytes(byte[] dst)`
`DynamicCompositeByteBuf`	`readBytes(byte[] dst, int dstIndex, int length)` Transfers this buffer's data to the specified destination starting at the current `readerIndex` and increases the `readerIndex` by the number of the transferred bytes (= `length`).
`char`	`readChar()` Gets a 2-byte UTF-16 character at the current `readerIndex` and increases the `readerIndex` by `2` in this buffer.
`double`	`readDouble()` Gets a 64-bit floating point number at the current `readerIndex` and increases the `readerIndex` by `8` in this buffer.
`double`	`readDoubleLE()` Gets a 64-bit floating point number at the current `readerIndex` in Little Endian Byte Order and increases the `readerIndex` by `8` in this buffer.
`int`	`readerIndex()`
`float`	`readFloat()` Gets a 32-bit floating point number at the current `readerIndex` and increases the `readerIndex` by `4` in this buffer.
`float`	`readFloatLE()` Gets a 32-bit floating point number at the current `readerIndex` in Little Endian Byte Order and increases the `readerIndex` by `4` in this buffer.
`int`	`readInt()` Gets a 32-bit integer at the current `readerIndex` and increases the `readerIndex` by `4` in this buffer.
`int`	`readIntLE()` Gets a 32-bit integer at the current `readerIndex` in the Little Endian Byte Order and increases the `readerIndex` by `4` in this buffer.
`long`	`readLong()` Gets a 64-bit integer at the current `readerIndex` and increases the `readerIndex` by `8` in this buffer.
`long`	`readLongLE()` Gets a 64-bit integer at the current `readerIndex` in the Little Endian Byte Order and increases the `readerIndex` by `8` in this buffer.
`io.netty.buffer.ByteBuf`	`readRetainedSlice(int length)` Returns a new `CompositeByteBuf` which slice the first `length` of this composite byte buffer and increases the `readerIndex` by the size of the new slice (= `length`).
`short`	`readShort()` Gets a 16-bit short integer at the current `readerIndex` and increases the `readerIndex` by `2` in this buffer.
`short`	`readShortLE()` Gets a 16-bit short integer at the current `readerIndex` in the Little Endian Byte Order and increases the `readerIndex` by `2` in this buffer.
`short`	`readUnsignedByte()` Gets an unsigned byte at the current `readerIndex` and increases the `readerIndex` by `1` in this buffer.
`int`	`readUnsignedShort()` Gets an unsigned 16-bit short integer at the current `readerIndex` and increases the `readerIndex` by `2` in this buffer.
`int`	`readUnsignedShortLE()` Gets an unsigned 16-bit short integer at the current `readerIndex` in the Little Endian Byte Order and increases the `readerIndex` by `2` in this buffer.
`void`	`release()`
`io.netty.buffer.ByteBuf`	`retainedSlice(int length)` Returns a new `CompositeByteBuf` which slice the first `length` of this composite byte buffer while they maintain separate indexes and marks.
`void`	`skipBytes(int length)`
`String`	`toString()`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 构造器详细资料
  - DynamicCompositeByteBuf
```
public DynamicCompositeByteBuf()
```
  - DynamicCompositeByteBuf
```
public DynamicCompositeByteBuf(int capacity)
```
  - DynamicCompositeByteBuf
```
public DynamicCompositeByteBuf(io.netty.buffer.ByteBuf buf)
```
    construct a new DynamicCompositeByteBuf with netty ByteBuf.
    
    参数:
    
    buf - input buf, readable size should be greater than zero.
  - DynamicCompositeByteBuf
```
public DynamicCompositeByteBuf(io.netty.buffer.ByteBuf[] bufs,
                               int offset,
                               int len)
```
    construct a new DynamicCompositeByteBuf with netty ByteBuf array.
    
    参数:
    
    bufs - byte buffer array, readable size of each element should be greater than zero.
    
    offset - offset at array
    
    len - length for create the new DynamicCompositeByteBuf
- 方法详细资料
  - readableBytes
```
public int readableBytes()
```
  - isEmpty
```
public boolean isEmpty()
```
  - hasArray
```
public boolean hasArray()
```
    返回:
    
    whether this DynamicCompositeByteBuf has a backing array
  - array
```
public byte[] array()
             throws UnsupportedOperationException
```
    it not check hasArray for performance
    
    返回:
    
    the backing array if it exists. null otherwise.
    
    抛出:
    
    UnsupportedOperationException
  - arrayOffset
```
public int arrayOffset()
                throws UnsupportedOperationException
```
    it not check hasArray for performance
    
    返回:
    
    The offset within this buffer's array of the first element of the buffer
    
    抛出:
    
    UnsupportedOperationException
  - readerIndex
```
public int readerIndex()
```
  - isReadable
```
public boolean isReadable()
```
  - nettyByteBuf
```
public io.netty.buffer.ByteBuf nettyByteBuf()
```
    convert DynamicCompositeByteBuf to netty ByteBuf, the reference count of its underlying buffers are not increased.
    
    返回:
    
    netty ByteBuf
  - addBuffer
```
public void addBuffer(io.netty.buffer.ByteBuf buffer)
```
    add netty ByteBuf to DynamicCompositeByteBuf. the reference count of netty byte buffer will be managed by DynamicCompositeByteBuf.
    
    参数:
    
    buffer - netty byte buffer
  - readRetainedSlice
```
public io.netty.buffer.ByteBuf readRetainedSlice(int length)
```
    Returns a new CompositeByteBuf which slice the first length of this composite byte buffer and increases the readerIndex by the size of the new slice (= length).
    
    参数:
    
    length - the size of the new composite byte buffer
    
    返回:
    
    the newly created composite byte buffer
    
    抛出:
    
    IndexOutOfBoundsException - if length is greater than this.readableBytes
  - retainedSlice
```
public io.netty.buffer.ByteBuf retainedSlice(int length)
```
    Returns a new CompositeByteBuf which slice the first length of this composite byte buffer while they maintain separate indexes and marks. This method does not modify readerIndex or writerIndex of this buffer.
    
    参数:
    
    length - the size of the new composite byte buffer
    
    返回:
    
    the newly created composite byte buffer
    
    抛出:
    
    IndexOutOfBoundsException - if length is greater than this.readableBytes
  - skipBytes
```
public void skipBytes(int length)
```
  - readBytes
```
public DynamicCompositeByteBuf readBytes(byte[] dst)
```
  - readBytes
```
public DynamicCompositeByteBuf readBytes(byte[] dst,
                                         int dstIndex,
                                         int length)
```
    Transfers this buffer's data to the specified destination starting at the current readerIndex and increases the readerIndex by the number of the transferred bytes (= length).
    
    参数:
    
    dstIndex - the first index of the destination
    
    length - the number of bytes to transfer
    
    抛出:
    
    IndexOutOfBoundsException - if the specified dstIndex is less than 0, if length is greater than this.readableBytes, or if dstIndex + length is greater than dst.length
  - readByte
```
public byte readByte()
```
    Gets a byte at the current readerIndex and increases the readerIndex by 1 in this buffer.
    
    抛出:
    
    IndexOutOfBoundsException - if this.readableBytes is less than 1
  - readUnsignedByte
```
public short readUnsignedByte()
```
    Gets an unsigned byte at the current readerIndex and increases the readerIndex by 1 in this buffer.
    
    抛出:
    
    IndexOutOfBoundsException - if this.readableBytes is less than 1
  - readShort
```
public short readShort()
```
    Gets a 16-bit short integer at the current readerIndex and increases the readerIndex by 2 in this buffer.
    
    抛出:
    
    IndexOutOfBoundsException - if this.readableBytes is less than 2
  - readShortLE
```
public short readShortLE()
```
    Gets a 16-bit short integer at the current readerIndex in the Little Endian Byte Order and increases the readerIndex by 2 in this buffer.
    
    抛出:
    
    IndexOutOfBoundsException - if this.readableBytes is less than 2
  - readUnsignedShort
```
public int readUnsignedShort()
```
    Gets an unsigned 16-bit short integer at the current readerIndex and increases the readerIndex by 2 in this buffer.
    
    抛出:
    
    IndexOutOfBoundsException - if this.readableBytes is less than 2
  - readUnsignedShortLE
```
public int readUnsignedShortLE()
```
    Gets an unsigned 16-bit short integer at the current readerIndex in the Little Endian Byte Order and increases the readerIndex by 2 in this buffer.
    
    抛出:
    
    IndexOutOfBoundsException - if this.readableBytes is less than 2
  - readInt
```
public int readInt()
```
    Gets a 32-bit integer at the current readerIndex and increases the readerIndex by 4 in this buffer.
    
    抛出:
    
    IndexOutOfBoundsException - if this.readableBytes is less than 4
  - readIntLE
```
public int readIntLE()
```
    Gets a 32-bit integer at the current readerIndex in the Little Endian Byte Order and increases the readerIndex by 4 in this buffer.
    
    抛出:
    
    IndexOutOfBoundsException - if this.readableBytes is less than 4
  - readLong
```
public long readLong()
```
    Gets a 64-bit integer at the current readerIndex and increases the readerIndex by 8 in this buffer.
    
    抛出:
    
    IndexOutOfBoundsException - if this.readableBytes is less than 8
  - readLongLE
```
public long readLongLE()
```
    Gets a 64-bit integer at the current readerIndex in the Little Endian Byte Order and increases the readerIndex by 8 in this buffer.
    
    抛出:
    
    IndexOutOfBoundsException - if this.readableBytes is less than 8
  - readChar
```
public char readChar()
```
    Gets a 2-byte UTF-16 character at the current readerIndex and increases the readerIndex by 2 in this buffer.
    
    抛出:
    
    IndexOutOfBoundsException - if this.readableBytes is less than 2
  - readFloat
```
public float readFloat()
```
    Gets a 32-bit floating point number at the current readerIndex and increases the readerIndex by 4 in this buffer.
    
    抛出:
    
    IndexOutOfBoundsException - if this.readableBytes is less than 4
  - readFloatLE
```
public float readFloatLE()
```
    Gets a 32-bit floating point number at the current readerIndex in Little Endian Byte Order and increases the readerIndex by 4 in this buffer.
    
    抛出:
    
    IndexOutOfBoundsException - if this.readableBytes is less than 4
  - readDouble
```
public double readDouble()
```
    Gets a 64-bit floating point number at the current readerIndex and increases the readerIndex by 8 in this buffer.
    
    抛出:
    
    IndexOutOfBoundsException - if this.readableBytes is less than 8
  - readDoubleLE
```
public double readDoubleLE()
```
    Gets a 64-bit floating point number at the current readerIndex in Little Endian Byte Order and increases the readerIndex by 8 in this buffer.
    
    抛出:
    
    IndexOutOfBoundsException - if this.readableBytes is less than 8
  - order
```
public ByteOrder order()
```
  - release
```
public void release()
```
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object

类 DynamicCompositeByteBuf

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

DynamicCompositeByteBuf

DynamicCompositeByteBuf

DynamicCompositeByteBuf

DynamicCompositeByteBuf

方法详细资料

readableBytes

isEmpty

hasArray

array

arrayOffset

readerIndex

isReadable

nettyByteBuf

addBuffer

readRetainedSlice

retainedSlice

skipBytes

readBytes

readBytes

readByte

readUnsignedByte

readShort

readShortLE

readUnsignedShort

readUnsignedShortLE

readInt

readIntLE

readLong

readLongLE

readChar

readFloat

readFloatLE

readDouble

readDoubleLE

order

release

toString