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

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

```
public class ByteBufferChannel
extends Object
```
ByteBuffer双向通道默认: 非线程安全模式

Author:

helyho Voovan Framework. WebSite: https://github.com/helyho/Voovan Licence: Apache v2 License

Constructor Summary

Constructors
Constructor and Description
`ByteBufferChannel()` 构造函数
`ByteBufferChannel(ByteBuffer byteBuffer)` 构造函数
`ByteBufferChannel(int capacity)` 构造函数
`ByteBufferChannel(int capacity, Integer maxSize)` 构造函数

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`byte[]`	`array()` 获取缓冲区有效字节数组的一个拷贝修改这个数组将不会影响当前对象返回 0 到 size 的有效数据从堆外复制到堆内
`int`	`available()` 当前数组空闲的大小
`int`	`capacity()` 返回当前分配的容量
`void`	`clear()` 清空通道
`boolean`	`compact()` 收缩通道将通过 getByteBuffer() 方法获得 ByteBuffer 对象的操作同步到 ByteBufferChannel 如果之前最后一次通过 getByteBuffer() 方法获得过 ByteBuffer,则使用这个 ByteBuffer 来收缩通道将 (position 到 limit) 之间的数据移动到 (0 到 limit - position) 其他情形将不做任何操作所以必须 getByteBuffer() 和 compact() 成对操作
`String`	`content()` 获取内容
`int`	`get(byte[] dst)` 获取某个偏移量位置的 byte 数据数组该操作不会导致通道内的数据发生变化
`int`	`get(byte[] dst, int position, int length)` 获取某个位置的 byte 数据数组该操作不会导致通道内的数据发生变化
`int`	`get(ByteBuffer srcByteBuffer)` 读取数据到 srcByteBuffer
`byte`	`get(int position)` 获取某个位置的 byte 数据该操作不会导致通道内的数据发生变化
`ByteBuffer`	`getByteBuffer()` 获取缓冲区返回 0 到 size 的有效数据为了保证数据一致性, 这里会加锁在调用getByteBuffer()方法后,跨线程的读写操作都会被阻塞.
`int`	`getMaxSize()`
`int`	`indexOf(byte[] mark)` 查找特定 byte 标识的位置 byte 标识数组第一个字节的索引位置
`void`	`init(ByteBuffer byteBuffer)` 初始化函数
`boolean`	`isEmpty()` 缓冲通道是否空
`boolean`	`isFull()` 缓冲通道是否已满
`boolean`	`isReleased()` 是否已经释放
`boolean`	`isThreadSafe()` 获取是否是线程安全的
`void`	`lock()`
`ByteBuffer`	`newBuffer()` 更换内部的 ByteBuffer 为新的 ByteBuffer
`int`	`read(int readPosition, ByteBuffer dst)` 从缓冲区某个位置开始读取数据
`int`	`readEnd(ByteBuffer dst)` 从缓冲区尾部读取数据
`int`	`readHead(ByteBuffer dst)` 从缓冲区头部读取数据
`String`	`readLine()` 读取一行
`ByteBuffer`	`readWithSplit(byte[] splitByte)` 读取一段,使用 byte数组分割返回的 byte数组中不包含分割 byte 数组的内容
`boolean`	`reallocate(int newSize)` 重新分配内存空间的大小
`void`	`release()` 立刻释放内存
`void`	`saveToFile(String filePath, long length)` 保存到文件
`void`	`setMaxSize(int maxSize)`
`void`	`setThreadSafe(boolean threadSafe)` 设置是否启用线程安全模式
`boolean`	`shrink(int shrinkSize)` 收缩通道内的数据
`boolean`	`shrink(int shrinkPosition, int shrinkSize)` 从某一个偏移量位置开始收缩数据
`int`	`size()` 当前数据大小
`ByteBuffer`	`slice(int size)` 获取 bytebuffer 的 hashcode
`boolean`	`startWith(byte[] mark)`
`String`	`toString()`
`void`	`unlock()`
`boolean`	`waitData(byte[] mark, int timeout, Runnable supplier)` 从头部开始判断是否收到期望的数据
`boolean`	`waitData(int length, int timeout, Runnable supplier)` 等待期望的数据长度
`int`	`write(int writePosition, byte[] srcBytes, int offset, int length)` 缓冲区某个位置写入数据
`int`	`write(int writePosition, ByteBuffer src)` 缓冲区某个位置写入数据
`int`	`writeEnd(byte[] srcBytes, int offset, int length)` 缓冲区头部写入
`int`	`writeEnd(ByteBuffer src)` 缓冲区头部写入
`int`	`writeHead(byte[] srcBytes, int offset, int length)` 缓冲区尾部写入
`int`	`writeHead(ByteBuffer src)` 缓冲区尾部写入

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

- Constructor Detail
  - ByteBufferChannel
```
public ByteBufferChannel(int capacity)
```
    构造函数
    
    Parameters:
    
    capacity - 初始分配的容量, 会自动扩容 maxSize 的大小, 如果容量不够抛出异常
  - ByteBufferChannel
```
public ByteBufferChannel(int capacity,
                         Integer maxSize)
```
    构造函数
    
    Parameters:
    
    capacity - 初始分配的容量, 会自动扩容 maxSize 的大小, 如果容量不够抛出异常
    
    maxSize - 通道地最大容量
  - ByteBufferChannel
```
public ByteBufferChannel(ByteBuffer byteBuffer)
```
    构造函数
    
    Parameters:
    
    byteBuffer - 初始分配的容量, 会自动扩容 maxSize 的大小, 如果容量不够抛出异常
  - ByteBufferChannel
```
public ByteBufferChannel()
```
    构造函数
- Method Detail
  - newBuffer
```
public ByteBuffer newBuffer()
```
    更换内部的 ByteBuffer 为新的 ByteBuffer
    
    Returns:
    
    旧的 ByteBuffer
  - init
```
public void init(ByteBuffer byteBuffer)
```
    初始化函数
    
    Parameters:
    
    byteBuffer - 初始化用的 ByteBuffer
  - getMaxSize
```
public int getMaxSize()
```
  - setMaxSize
```
public void setMaxSize(int maxSize)
```
  - isThreadSafe
```
public boolean isThreadSafe()
```
    获取是否是线程安全的
    
    Returns:
    
    true: 线程安全, false: 非线程安全
  - setThreadSafe
```
public void setThreadSafe(boolean threadSafe)
```
    设置是否启用线程安全模式
    
    Parameters:
    
    threadSafe - true: 启用线程安全, false: 不启用线程安全
  - lock
```
public void lock()
```
  - unlock
```
public void unlock()
```
  - isFull
```
public boolean isFull()
```
    缓冲通道是否已满
    
    Returns:
    
    true: 通道已满, false: 通道未满
  - isEmpty
```
public boolean isEmpty()
```
    缓冲通道是否空
    
    Returns:
    
    true: 通道空, false: 通道有数据
  - isReleased
```
public boolean isReleased()
```
    是否已经释放
    
    Returns:
    
    true 已释放, false: 未释放
  - release
```
public void release()
```
    立刻释放内存
  - available
```
public int available()
```
    当前数组空闲的大小
    
    Returns:
    
    当前数组空闲的大小. -1: 已释放
  - capacity
```
public int capacity()
```
    返回当前分配的容量
    
    Returns:
    
    当前分配的容量. -1: 已释放
  - size
```
public int size()
```
    当前数据大小
    
    Returns:
    
    数据大小 . -1: 已释放
  - array
```
public byte[] array()
```
    获取缓冲区有效字节数组的一个拷贝修改这个数组将不会影响当前对象返回 0 到 size 的有效数据从堆外复制到堆内
    
    Returns:
    
    缓冲区有效字节数组. null: 已释放
  - clear
```
public void clear()
```
    清空通道
  - shrink
```
public boolean shrink(int shrinkPosition,
                      int shrinkSize)
```
    从某一个偏移量位置开始收缩数据
    
    Parameters:
    
    shrinkPosition - 收缩的偏移量位置
    
    shrinkSize - 收缩的数据大小, 大于0: 向尾部收缩, 小于0: 向头部收缩
    
    Returns:
    
    true: 成功, false: 失败
  - shrink
```
public boolean shrink(int shrinkSize)
```
    收缩通道内的数据
    
    Parameters:
    
    shrinkSize - 收缩的偏移量: 大于0: 从头部向尾部收缩数据, 小于0: 从尾部向头部收缩数据
    
    Returns:
    
    true: 成功, false: 失败
  - slice
```
public ByteBuffer slice(int size)
```
    获取 bytebuffer 的 hashcode
    
    Parameters:
    
    size - slice 的数据大小
    
    Returns:
    
    bytebuffer 的 hashcode
  - getByteBuffer
```
public ByteBuffer getByteBuffer()
```
    获取缓冲区返回 0 到 size 的有效数据为了保证数据一致性, 这里会加锁在调用getByteBuffer()方法后,跨线程的读写操作都会被阻塞. 但在调用getByteBuffer()方法后,同一线程内的所有读写操作是可以操作, 为保证数据一致性,除非特殊需要,否则在编码时应当被严格禁止. 在调用getByteBuffer()方法后,所以必须配合 compact() 方法使用, 已保证对 byteBuffer 的所有读写操作都在 ByteBufferChannel上生效.
    
    Returns:
    
    ByteBuffer 对象
  - compact
```
public boolean compact()
```
    收缩通道将通过 getByteBuffer() 方法获得 ByteBuffer 对象的操作同步到 ByteBufferChannel 如果之前最后一次通过 getByteBuffer() 方法获得过 ByteBuffer,则使用这个 ByteBuffer 来收缩通道将 (position 到 limit) 之间的数据移动到 (0 到 limit - position) 其他情形将不做任何操作所以必须 getByteBuffer() 和 compact() 成对操作
    
    Returns:
    
    是否compact成功,true:成功, false:失败
  - get
```
public byte get(int position)
         throws IndexOutOfBoundsException
```
    获取某个位置的 byte 数据该操作不会导致通道内的数据发生变化
    
    Parameters:
    
    position - 位置
    
    Returns:
    
    byte 数据
    
    Throws:
    
    IndexOutOfBoundsException
  - get
```
public int get(byte[] dst,
               int position,
               int length)
        throws IndexOutOfBoundsException
```
    获取某个位置的 byte 数据数组该操作不会导致通道内的数据发生变化
    
    Parameters:
    
    dst - 目标数组
    
    position - 位置
    
    length - 长度
    
    Returns:
    
    获取数据的长度
    
    Throws:
    
    IndexOutOfBoundsException
  - get
```
public int get(byte[] dst)
```
    获取某个偏移量位置的 byte 数据数组该操作不会导致通道内的数据发生变化
    
    Parameters:
    
    dst - 目标数组
    
    Returns:
    
    获取数据的长度
  - get
```
public int get(ByteBuffer srcByteBuffer)
```
    读取数据到 srcByteBuffer
    
    Parameters:
    
    srcByteBuffer - 接收数据的 ByteBuffer 对象
    
    Returns:
    
    获取数据的长度
  - write
```
public int write(int writePosition,
                 byte[] srcBytes,
                 int offset,
                 int length)
```
    缓冲区某个位置写入数据
    
    Parameters:
    
    writePosition - 缓冲区中的位置
    
    srcBytes - 源字节数组
    
    offset - 字节数组便宜
    
    length - 写入数据长度
    
    Returns:
    
    写入的数据大小
  - writeEnd
```
public int writeEnd(byte[] srcBytes,
                    int offset,
                    int length)
```
    缓冲区头部写入
    
    Parameters:
    
    srcBytes - 源字节数组
    
    offset - 字节数组便宜
    
    length - 写入数据长度
    
    Returns:
    
    写入的数据大小
  - writeHead
```
public int writeHead(byte[] srcBytes,
                     int offset,
                     int length)
```
    缓冲区尾部写入
    
    Parameters:
    
    srcBytes - 源字节数组
    
    offset - 字节数组便宜
    
    length - 写入数据长度
    
    Returns:
    
    读出的数据大小
  - write
```
public int write(int writePosition,
                 ByteBuffer src)
```
    缓冲区某个位置写入数据
    
    Parameters:
    
    writePosition - 缓冲区中的位置
    
    src - 需要写入的缓冲区 ByteBuffer 对象
    
    Returns:
    
    写入的数据大小
  - writeEnd
```
public int writeEnd(ByteBuffer src)
```
    缓冲区头部写入
    
    Parameters:
    
    src - 需要写入的缓冲区 ByteBuffer 对象
    
    Returns:
    
    写入的数据大小
  - writeHead
```
public int writeHead(ByteBuffer src)
```
    缓冲区尾部写入
    
    Parameters:
    
    src - 需要写入的缓冲区 ByteBuffer 对象
    
    Returns:
    
    读出的数据大小
  - read
```
public int read(int readPosition,
                ByteBuffer dst)
```
    从缓冲区某个位置开始读取数据
    
    Parameters:
    
    readPosition - 缓冲区中的位置
    
    dst - 需要读入数据的缓冲区ByteBuffer 对象
    
    Returns:
    
    读出的数据大小
  - readHead
```
public int readHead(ByteBuffer dst)
```
    从缓冲区头部读取数据
    
    Parameters:
    
    dst - 需要读入数据的缓冲区ByteBuffer 对象
    
    Returns:
    
    读出的数据大小
  - readEnd
```
public int readEnd(ByteBuffer dst)
```
    从缓冲区尾部读取数据
    
    Parameters:
    
    dst - 需要读入数据的缓冲区ByteBuffer 对象
    
    Returns:
    
    读出的数据大小
  - 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: 等待数据超时
  - reallocate
```
public boolean reallocate(int newSize)
                   throws LargerThanMaxSizeException
```
    重新分配内存空间的大小
    
    Parameters:
    
    newSize - 重新分配的空间大小
    
    Returns:
    
    true:成功, false:失败
    
    Throws:
    
    LargerThanMaxSizeException - 通道容量不足的一场
  - indexOf
```
public int indexOf(byte[] mark)
```
    查找特定 byte 标识的位置 byte 标识数组第一个字节的索引位置
    
    Parameters:
    
    mark - byte 标识数组
    
    Returns:
    
    第一个字节的索引位置
  - startWith
```
public boolean startWith(byte[] mark)
```
  - readLine
```
public String readLine()
```
    读取一行
    
    Returns:
    
    字符串
  - readWithSplit
```
public ByteBuffer readWithSplit(byte[] splitByte)
```
    读取一段,使用 byte数组分割返回的 byte数组中不包含分割 byte 数组的内容
    
    Parameters:
    
    splitByte - 分割字节数组
    
    Returns:
    
    字节数组
  - saveToFile
```
public void saveToFile(String filePath,
                       long length)
                throws IOException
```
    保存到文件
    
    Parameters:
    
    filePath - 文件路径
    
    length - 需要保存的长度
    
    Throws:
    
    IOException - Io 异常
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - content
```
public String content()
```
    获取内容
    
    Returns:
    
    内容字符串

Class ByteBufferChannel

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ByteBufferChannel

ByteBufferChannel

ByteBufferChannel

ByteBufferChannel

Method Detail

newBuffer

init

getMaxSize

setMaxSize

isThreadSafe

setThreadSafe

lock

unlock

isFull

isEmpty

isReleased

release

available

capacity

size

array

clear

shrink

shrink

slice

getByteBuffer

compact

get

get

get

get

write

writeEnd

writeHead

write

writeEnd

writeHead

read

readHead

readEnd

waitData

waitData

reallocate

indexOf

startWith

readLine

readWithSplit

saveToFile

toString

content