RingDirectBuffer (Voovan-码云(gitee.com))

java.lang.Object
- org.voovan.tools.buffer.RingDirectBuffer

public class RingDirectBuffer
extends Object

环形缓冲区

Constructor Summary

Constructors
Constructor and Description
`RingDirectBuffer()` 使用默认容量构造一个环形缓冲区
`RingDirectBuffer(ByteBuffer byteBuffer)` 使用指定容量构造一个环形缓冲区
`RingDirectBuffer(int capacity)` 使用指定容量构造一个环形缓冲区

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`avaliable()` 缓冲区可写空间
`void`	`clear()` 清理缓冲区
`void`	`compact()`
`int`	`get(byte[] bytes, int offset, int length)` 读取所有缓冲区的数据不影响读写位置
`int`	`get(ByteBuffer byteBuffer)` 读取所有缓冲区的数据不影响读写位置
`byte`	`get(int offset)` 获得基于索引位置的数据
`long`	`getAddress()` 获得环形缓冲区的基地址
`ByteBuffer`	`getByteBuffer()` 获得一个只读的 ByteBuffer 类型的数据
`int`	`getCapacity()` 获得容量
`int`	`getReadPositon()` 获得读指针位置
`int`	`getWritePositon()` 获得写指针位置
`int`	`indexOf(byte[] mark)` 查找特定 byte 标识的位置 byte 标识数组第一个字节的索引位置
`Boolean`	`isEmpty()` 缓冲区空判断
`Boolean`	`isFull()` 缓冲区满判断
`boolean`	`isReleased()`
`byte`	`read()` 读取一个 byte
`int`	`read(byte[] bytes, int offset, int length)` 读取缓冲区的数据
`int`	`read(ByteBuffer byteBuffer)` 读取缓冲区的数据
`String`	`readLine()` 读取一行
`void`	`release()` 释放内存中的数据
`int`	`remaining()` 缓冲区可读数据量
`void`	`resetAddress()`
`void`	`saveToFile(String filePath, long length)` 保存到文件
`boolean`	`skip(int offset)` 读指针跳过特定的偏移量
`boolean`	`startWith(byte[] mark)`
`byte[]`	`toArray()` 读取所有缓冲区的数据不影响读写位置
`String`	`toString()`
`boolean`	`tryExpansion(int dataSize)` 重新分配内存空间的大小
`boolean`	`waitData(byte[] mark, int timeout, Runnable supplier)` 从头部开始判断是否收到期望的数据
`boolean`	`waitData(int length, int timeout, Runnable supplier)` 等待期望的数据长度
`void`	`write(byte b)` 写入一个 byte
`int`	`write(byte[] bytes, int offset, int length)` 写入一个 byte[] 数据
`int`	`write(ByteBuffer byteBuffer)` 写入一个 byteBuffer

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

- Constructor Detail
  - RingDirectBuffer
```
public RingDirectBuffer()
```
    使用默认容量构造一个环形缓冲区
  - RingDirectBuffer
```
public RingDirectBuffer(int capacity)
```
    使用指定容量构造一个环形缓冲区
    
    Parameters:
    
    capacity - 分配的容量
  - RingDirectBuffer
```
public RingDirectBuffer(ByteBuffer byteBuffer)
```
    使用指定容量构造一个环形缓冲区
    
    Parameters:
    
    byteBuffer - ByteBuffer 对象
- Method Detail
  - getAddress
```
public long getAddress()
```
    获得环形缓冲区的基地址
    
    Returns:
    
    环形缓冲区的基地址
  - getReadPositon
```
public int getReadPositon()
```
    获得读指针位置
    
    Returns:
    
    读指针位置
  - getWritePositon
```
public int getWritePositon()
```
    获得写指针位置
    
    Returns:
    
    写指针位置
  - getCapacity
```
public int getCapacity()
```
    获得容量
    
    Returns:
    
    容量
  - skip
```
public boolean skip(int offset)
```
    读指针跳过特定的偏移量
    
    Parameters:
    
    offset - 偏移量
    
    Returns:
    
    true: 成功, false: 失败
  - isEmpty
```
public Boolean isEmpty()
```
    缓冲区空判断
    
    Returns:
    
    true: 缓冲区无可用数据, false: 缓冲区有可用数据
  - isFull
```
public Boolean isFull()
```
    缓冲区满判断
    
    Returns:
    
    true: 缓冲区已满, false: 缓冲区未满
  - clear
```
public void clear()
```
    清理缓冲区
  - get
```
public byte get(int offset)
```
    获得基于索引位置的数据
    
    Parameters:
    
    offset - 偏移量
    
    Returns:
    
    byte 数据
  - get
```
public int get(ByteBuffer byteBuffer)
```
    读取所有缓冲区的数据不影响读写位置
    
    Parameters:
    
    byteBuffer - ByteBuffer 对象
    
    Returns:
    
    读取数据大小
  - get
```
public int get(byte[] bytes,
               int offset,
               int length)
```
    读取所有缓冲区的数据不影响读写位置
    
    Parameters:
    
    bytes - 用于读取数据的 byte 数组
    
    offset - 偏移量
    
    length - 数据长度
    
    Returns:
    
    读取数据大小
  - toArray
```
public byte[] toArray()
```
    读取所有缓冲区的数据不影响读写位置
    
    Returns:
    
    读取数据
  - write
```
public void write(byte b)
```
    写入一个 byte
    
    Parameters:
    
    b - byte 数据
  - write
```
public int write(byte[] bytes,
                 int offset,
                 int length)
```
    写入一个 byte[] 数据
    
    Parameters:
    
    bytes - byte[] 对象
    
    offset - 针对 byte[] 的偏移量
    
    length - 写入数据的长度
    
    Returns:
    
    写入数据长度
  - write
```
public int write(ByteBuffer byteBuffer)
```
    写入一个 byteBuffer
    
    Parameters:
    
    byteBuffer - ByteBuffer 对象
    
    Returns:
    
    写入数据长度
  - remaining
```
public int remaining()
```
    缓冲区可读数据量
    
    Returns:
    
    缓冲区可用数据量
  - avaliable
```
public int avaliable()
```
    缓冲区可写空间
    
    Returns:
    
    缓冲区可写空间
  - read
```
public byte read()
```
    读取一个 byte
    
    Returns:
    
    byte 数据
  - read
```
public int read(ByteBuffer byteBuffer)
```
    读取缓冲区的数据
    
    Parameters:
    
    byteBuffer - ByteBuffer 对象
    
    Returns:
    
    读取数据大小
  - read
```
public int read(byte[] bytes,
                int offset,
                int length)
```
    读取缓冲区的数据
    
    Parameters:
    
    bytes - 用于读取数据的 byte 数组
    
    offset - 偏移量
    
    length - 读取数据的长度
    
    Returns:
    
    读取数据大小
  - getByteBuffer
```
public ByteBuffer getByteBuffer()
```
    获得一个只读的 ByteBuffer 类型的数据
    
    Returns:
    
    ByteBuffer 对象
  - compact
```
public void compact()
```
  - indexOf
```
public int indexOf(byte[] mark)
```
    查找特定 byte 标识的位置 byte 标识数组第一个字节的索引位置
    
    Parameters:
    
    mark - byte 标识数组
    
    Returns:
    
    第一个字节的索引位置
  - startWith
```
public boolean startWith(byte[] mark)
```
  - waitData
```
public boolean waitData(int length,
                        int timeout,
                        Runnable supplier)
```
    等待期望的数据长度
    
    Parameters:
    
    length - 期望的数据长度
    
    timeout - 超时时间,单位: 毫秒
    
    supplier - 每次等待数据所做的操作
    
    Returns:
    
    true: 具备期望长度的数据, false: 等待数据超时
  - waitData
```
public boolean waitData(byte[] mark,
                        int timeout,
                        Runnable supplier)
```
    从头部开始判断是否收到期望的数据
    
    Parameters:
    
    mark - 期望出现的数据
    
    timeout - 超时时间,单位: 毫秒
    
    supplier - 每次等待数据所做的操作
    
    Returns:
    
    true: 具备期望长度的数据, false: 等待数据超时
  - readLine
```
public String readLine()
```
    读取一行
    
    Returns:
    
    字符串
  - saveToFile
```
public void saveToFile(String filePath,
                       long length)
                throws IOException
```
    保存到文件
    
    Parameters:
    
    filePath - 文件路径
    
    length - 需要保存的长度
    
    Throws:
    
    IOException - Io 异常
  - isReleased
```
public boolean isReleased()
```
  - release
```
public void release()
```
    释放内存中的数据
  - tryExpansion
```
public boolean tryExpansion(int dataSize)
                     throws LargerThanMaxSizeException
```
    重新分配内存空间的大小
    
    Parameters:
    
    dataSize - 重新分配的空间大小
    
    Returns:
    
    true:成功, false:失败
    
    Throws:
    
    LargerThanMaxSizeException - 通道容量不足的一场
  - resetAddress
```
public void resetAddress()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class RingDirectBuffer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RingDirectBuffer

RingDirectBuffer

RingDirectBuffer

Method Detail

getAddress

getReadPositon

getWritePositon

getCapacity

skip

isEmpty

isFull

clear

get

get

get

toArray

write

write

write

remaining

avaliable

read

read

read

getByteBuffer

compact

indexOf

startWith

waitData

waitData

readLine

saveToFile

isReleased

release

tryExpansion

resetAddress

toString