Buffer (oceanbase-client 2.4.11 API)

java.lang.Object
- com.oceanbase.jdbc.internal.com.read.Buffer

```
public class Buffer
extends Object
```

字段概要

字段
限定符和类型字段和说明

byte[] buf

static byte[] EMPTY_BYTE_ARRAY

int limit

int position

字段
限定符和类型	字段和说明
`byte[]`	`buf`
`static byte[]`	`EMPTY_BYTE_ARRAY`
`int`	`limit`
`int`	`position`

构造器概要

构造器
构造器和说明

Buffer()

Buffer(byte[] buf)
Constructor with default limit and offset.

Buffer(byte[] buf, int limit)

构造器
构造器和说明
`Buffer()`
`Buffer(byte[] buf)` Constructor with default limit and offset.
`Buffer(byte[] buf, int limit)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`checkRemainder(long need)`
`int`	`fastSkipLenString()`
`byte`	`getByte()` Read current buffer byte without incrementing position.
`byte`	`getByteAt(int position)`
`byte[]`	`getByteBuffer()` Returns the array of bytes this Buffer is using to read from.
`byte[]`	`getBytes(int len)`
`byte[]`	`getBytes(int offset, int len)`
`Buffer`	`getLengthEncodedBuffer()` Get next data bytes from length encoded prefix.
`byte[]`	`getLengthEncodedBytes()` Get next data bytes with length encoded prefix.
`long`	`getLengthEncodedNumeric()` Get next binary data length.
`int`	`getLimit()`
`int`	`getPosition()`
`byte`	`readByte()` Reads a byte from the buffer.
`byte[]`	`readBytes(int numberOfBytes)` Read raw data.
`byte[]`	`readBytesNullEnd()` Reads a byte array from the buffer, looks for a 0 to end the array.
`long`	`readFieldLength()`
`int`	`readInt()` Read a int (4 bytes) from the buffer.
`int`	`readInt2Bytes()` Read a int (2 bytes) from the buffer.
`int`	`readInt2BytesV1()`
`int`	`readInt3Bytes()` Read 24 bit integer.
`byte[]`	`readLenByteArray(int offset)`
`long`	`readLong()` Read a long (8 bytes) from the buffer.
`long`	`readLong4BytesV1()` Read a long (4 bytes) from the buffer.
`long`	`readLongV1()`
`int`	`readnBytes()`
`short`	`readShort()` Read a short (2 bytes) from the buffer.
`String`	`readString(int numberOfBytes)` Read String with defined length.
`String`	`readStringLengthEncoded(Charset charset)` Reads length-encoded string.
`String`	`readStringNullEnd(Charset charset)` Reads a string from the buffer, looks for a 0 to end the string.
`String`	`readStringRestOfPacket(Charset charset)` If a string is the last component of a packet, its length can be calculated from the overall packet length minus the current position.
`int`	`remaining()`
`void`	`setPosition(int position)`
`void`	`skipByte()`
`void`	`skipBytes(int bytesToSkip)`
`void`	`skipLengthEncodedBytes()` Skip next length encode binary data.
`void`	`skipLengthEncodedNumeric()` Skip length encoded numeric
`void`	`skipRestOfPacket()`
`void`	`writeByte(byte b)`
`void`	`writeBytes(byte[] bytes, int off, int length)`
`void`	`writeBytes(byte header, byte[] bytes)` Write bytes.
`void`	`writeInt(int num)`
`void`	`writeIntV2(int num)`
`void`	`writeLength(long length)` Write length.
`void`	`writeLongFromHighToLow(long num)`
`void`	`writeLongFromLowToHigh(long num)`
`void`	`writeLongInt(int num)`
`void`	`writeNBytes(long num, int n)`
`void`	`writeShort(short num)`
`void`	`writeShortV2(short num)`
`void`	`writeString(String str)`
`void`	`writeStringLength(byte[] bytes)` Write value with length encoded prefix.
`void`	`writeStringLength(String value, Charset charset)` Write value with length encoded prefix.
`void`	`writeStringSmallLength(byte[] value)` Write value with length encoded prefix. value length MUST be less than 251 char

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

- 字段详细资料
  - buf
```
public byte[] buf
```
  - position
```
public int position
```
  - limit
```
public int limit
```
  - EMPTY_BYTE_ARRAY
```
public static final byte[] EMPTY_BYTE_ARRAY
```
- 构造器详细资料
  - Buffer
```
public Buffer(byte[] buf,
              int limit)
```
  - Buffer
```
public Buffer(byte[] buf)
```
    Constructor with default limit and offset.
    
    参数:
    
    buf - byte array
  - Buffer
```
public Buffer()
```
- 方法详细资料
  - remaining
```
public int remaining()
```
  - checkRemainder
```
public void checkRemainder(long need)
                    throws IOException
```
    抛出:
    
    IOException
  - readStringNullEnd
```
public String readStringNullEnd(Charset charset)
```
    Reads a string from the buffer, looks for a 0 to end the string.
    
    参数:
    
    charset - the charset to use, for example ASCII
    
    返回:
    
    the read string
  - readBytesNullEnd
```
public byte[] readBytesNullEnd()
```
    Reads a byte array from the buffer, looks for a 0 to end the array.
    
    返回:
    
    the read array
  - readString
```
public String readString(int numberOfBytes)
```
    Read String with defined length.
    
    参数:
    
    numberOfBytes - raw data length.
    
    返回:
    
    String value
  - readShort
```
public short readShort()
```
    Read a short (2 bytes) from the buffer.
    
    返回:
    
    an short
  - readInt2Bytes
```
public int readInt2Bytes()
```
    Read a int (2 bytes) from the buffer.
    
    返回:
    
    a int
  - readInt2BytesV1
```
public int readInt2BytesV1()
```
  - readInt3Bytes
```
public int readInt3Bytes()
```
    Read 24 bit integer.
    
    返回:
    
    length
  - readInt
```
public int readInt()
```
    Read a int (4 bytes) from the buffer.
    
    返回:
    
    a int
  - readnBytes
```
public int readnBytes()
```
  - readLong4BytesV1
```
public long readLong4BytesV1()
```
    Read a long (4 bytes) from the buffer.
    
    返回:
    
    a long
  - readLong
```
public long readLong()
```
    Read a long (8 bytes) from the buffer.
    
    返回:
    
    a long
  - readLongV1
```
public long readLongV1()
```
  - readByte
```
public byte readByte()
```
    Reads a byte from the buffer.
    
    返回:
    
    the byte
  - readLenByteArray
```
public byte[] readLenByteArray(int offset)
```
  - getByte
```
public byte getByte()
```
    Read current buffer byte without incrementing position.
    
    返回:
    
    the byte
  - skipByte
```
public void skipByte()
```
  - getByteAt
```
public byte getByteAt(int position)
```
  - readBytes
```
public byte[] readBytes(int numberOfBytes)
```
    Read raw data.
    
    参数:
    
    numberOfBytes - raw data length.
    
    返回:
    
    raw data
  - getBytes
```
public byte[] getBytes(int len)
```
  - getBytes
```
public byte[] getBytes(int offset,
                       int len)
```
  - skipBytes
```
public void skipBytes(int bytesToSkip)
```
  - getLengthEncodedBytes
```
public byte[] getLengthEncodedBytes()
```
    Get next data bytes with length encoded prefix.
    
    返回:
    
    the raw binary data
  - skipLengthEncodedBytes
```
public void skipLengthEncodedBytes()
```
    Skip next length encode binary data.
  - getLengthEncodedNumeric
```
public long getLengthEncodedNumeric()
```
    Get next binary data length.
    
    返回:
    
    length of next binary data
  - skipLengthEncodedNumeric
```
public void skipLengthEncodedNumeric()
```
    Skip length encoded numeric
  - getLengthEncodedBuffer
```
public Buffer getLengthEncodedBuffer()
```
    Get next data bytes from length encoded prefix.
    
    返回:
    
    buffer
  - readStringRestOfPacket
```
public String readStringRestOfPacket(Charset charset)
```
    If a string is the last component of a packet, its length can be calculated from the overall packet length minus the current position.
    
    参数:
    
    charset - the charset to use, for example ASCII
    
    返回:
    
    the read string
  - skipRestOfPacket
```
public void skipRestOfPacket()
```
  - readStringLengthEncoded
```
public String readStringLengthEncoded(Charset charset)
```
    Reads length-encoded string.
    
    参数:
    
    charset - the charset to use, for example ASCII
    
    返回:
    
    the read string
  - fastSkipLenString
```
public int fastSkipLenString()
```
  - readFieldLength
```
public final long readFieldLength()
```
  - writeByte
```
public void writeByte(byte b)
```
  - writeBytes
```
public void writeBytes(byte[] bytes,
                       int off,
                       int length)
```
  - writeBytes
```
public void writeBytes(byte header,
                       byte[] bytes)
```
    Write bytes.
    
    参数:
    
    header - header byte
    
    bytes - command bytes
  - writeShort
```
public void writeShort(short num)
```
  - writeShortV2
```
public void writeShortV2(short num)
```
  - writeLongInt
```
public void writeLongInt(int num)
```
  - writeInt
```
public void writeInt(int num)
```
  - writeIntV2
```
public void writeIntV2(int num)
```
  - writeNBytes
```
public void writeNBytes(long num,
                        int n)
```
  - writeLongFromLowToHigh
```
public void writeLongFromLowToHigh(long num)
```
  - writeLongFromHighToLow
```
public void writeLongFromHighToLow(long num)
```
  - writeString
```
public void writeString(String str)
```
  - writeStringLength
```
public void writeStringLength(String value,
                              Charset charset)
```
    Write value with length encoded prefix.
    
    参数:
    
    value - value to write
  - writeStringLength
```
public void writeStringLength(byte[] bytes)
```
    Write value with length encoded prefix.
    
    参数:
    
    bytes - value to write
  - writeStringSmallLength
```
public void writeStringSmallLength(byte[] value)
```
    Write value with length encoded prefix. value length MUST be less than 251 char
    
    参数:
    
    value - value to write
  - writeLength
```
public void writeLength(long length)
```
    Write length.
    
    参数:
    
    length - length
  - getPosition
```
public int getPosition()
```
  - setPosition
```
public void setPosition(int position)
```
  - getLimit
```
public int getLimit()
```
  - getByteBuffer
```
public byte[] getByteBuffer()
```
    Returns the array of bytes this Buffer is using to read from.
    
    返回:
    
    byte array being read from

类 Buffer

字段概要

构造器概要

方法概要

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

字段详细资料

buf

position

limit

EMPTY_BYTE_ARRAY

构造器详细资料

Buffer

Buffer

Buffer

方法详细资料

remaining

checkRemainder

readStringNullEnd

readBytesNullEnd

readString

readShort

readInt2Bytes

readInt2BytesV1

readInt3Bytes

readInt

readnBytes

readLong4BytesV1

readLong

readLongV1

readByte

readLenByteArray

getByte

skipByte

getByteAt

readBytes

getBytes

getBytes

skipBytes

getLengthEncodedBytes

skipLengthEncodedBytes

getLengthEncodedNumeric

skipLengthEncodedNumeric

getLengthEncodedBuffer

readStringRestOfPacket

skipRestOfPacket

readStringLengthEncoded

fastSkipLenString

readFieldLength

writeByte

writeBytes

writeBytes

writeShort

writeShortV2

writeLongInt

writeInt

writeIntV2

writeNBytes

writeLongFromLowToHigh

writeLongFromHighToLow

writeString

writeStringLength

writeStringLength

writeStringSmallLength

writeLength

getPosition

setPosition

getLimit

getByteBuffer