org.jboss.netty.buffer
类 HeapChannelBuffer

java.lang.Object
  org.jboss.netty.buffer.AbstractChannelBuffer
      org.jboss.netty.buffer.HeapChannelBuffer

所有已实现的接口：

java.lang.Comparable<ChannelBuffer>, ChannelBuffer

直接已知子类：

BigEndianHeapChannelBuffer, LittleEndianHeapChannelBuffer

public abstract class HeapChannelBuffer
extends AbstractChannelBuffer

一个Java堆缓冲的脚架实现.

构造方法摘要

HeapChannelBuffer(byte[] array)
使用指定的字节数组创建一个新的堆缓冲.

HeapChannelBuffer(int length)
使用新分配的字节数组创建一个新的堆缓冲.

方法摘要

byte[]	array() 返回该缓冲支持的字节数组.
int	arrayOffset() 返回该缓冲内部的字节数组的第一个字节的偏移量
int	capacity() 返回缓冲区包含字节数量.
byte	getByte(int index) 在指定绝对值index处获取一个字节.该方法并不修改缓冲的 readerIndex 和 writerIndex.
void	getBytes(int index, byte[] dst, int dstIndex, int length) 在该缓冲区指定绝对值index开始处传输数据到指定的目标.
void	getBytes(int index, java.nio.ByteBuffer dst) 在该缓冲区指定绝对值index开始处传输数据到指定的目标,直到目标的position到达限制为止.
void	getBytes(int index, ChannelBuffer dst, int dstIndex, int length) 在该缓冲区指定绝对值index开始处传输数据到指定的目标.
int	getBytes(int index, java.nio.channels.GatheringByteChannel out, int length) 在该缓冲区指定绝对值index开始处传输数据到指定的通道.该方法并不修改该缓冲区的 readerIndex 和 writerIndex.
void	getBytes(int index, java.io.OutputStream out, int length) 在该缓冲区指定绝对值index开始处传输数据到指定的数据流.该方法并不修改该缓冲区的 readerIndex 和 writerIndex.
boolean	hasArray() 只有当该缓冲有一个支持的字节数组才返回true,如果该方法返回true,你可以安全的调用 ChannelBuffer.array() 和 ChannelBuffer.arrayOffset().
boolean	isDirect() 判断该缓冲区是否是由NIO direct缓冲支持.
void	setByte(int index, int value) 在指定绝对值index处设置指定的字节. 24高序位会被忽略.
void	setBytes(int index, byte[] src, int srcIndex, int length) 把指定的源数组的数据传输到该缓冲区指定绝对值index的位置 .
void	setBytes(int index, java.nio.ByteBuffer src) 把指定的源缓冲的数据传输到该缓冲区指定绝对值index的位置 ,直到源缓冲的position到达限制为止.
void	setBytes(int index, ChannelBuffer src, int srcIndex, int length) 把指定的源缓冲区的数据传输到该缓冲区指定绝对值index的位置 .
int	setBytes(int index, java.io.InputStream in, int length) 把指定的源输入流的数据传输到该缓冲区指定绝对值index的位置 .
int	setBytes(int index, java.nio.channels.ScatteringByteChannel in, int length) 把指定的源通道的数据传输到该缓冲区指定绝对值index的位置 .
ChannelBuffer	slice(int index, int length) 返回该缓冲子部分的切片.修改其中任何一个缓冲对另一个都会有影响,不过它们维护着各自的索引和标记,且并不修改该缓冲区的 readerIndex和writerIndex.
java.nio.ByteBuffer	toByteBuffer(int index, int length) 转化该缓冲区的子部分到一个NIO缓冲区.返回的缓冲区可能有或没有和该缓冲共享内容,但是它们有各自的索引和标记.

从类 org.jboss.netty.buffer.AbstractChannelBuffer 继承的方法

bytesBefore, bytesBefore, bytesBefore, bytesBefore, bytesBefore, bytesBefore, clear, compareTo, copy, discardReadBytes, ensureWritableBytes, equals, getBytes, getBytes, getBytes, getChar, getDouble, getFloat, getMedium, getUnsignedByte, getUnsignedInt, getUnsignedShort, hashCode, indexOf, indexOf, markReaderIndex, markWriterIndex, readable, readableBytes, readByte, readBytes, readBytes, readBytes, readBytes, readBytes, readBytes, readBytes, readBytes, readBytes, readBytes, readChar, readDouble, readerIndex, readerIndex, readFloat, readInt, readLong, readMedium, readShort, readSlice, readSlice, readUnsignedByte, readUnsignedInt, readUnsignedMedium, readUnsignedShort, resetReaderIndex, resetWriterIndex, setBytes, setBytes, setBytes, setChar, setDouble, setFloat, setIndex, setZero, skipBytes, skipBytes, slice, toByteBuffer, toByteBuffers, toByteBuffers, toString, toString, toString, toString, toString, toString, toString, writable, writableBytes, writeByte, writeBytes, writeBytes, writeBytes, writeBytes, writeBytes, writeBytes, writeBytes, writeBytes, writeChar, writeDouble, writeFloat, writeInt, writeLong, writeMedium, writerIndex, writerIndex, writeShort, writeZero

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

getClass, notify, notifyAll, wait, wait, wait

从接口 org.jboss.netty.buffer.ChannelBuffer 继承的方法

copy, duplicate, factory, getInt, getLong, getShort, getUnsignedMedium, order, setInt, setLong, setMedium, setShort

构造方法详细信息

HeapChannelBuffer

public HeapChannelBuffer(int length)

使用新分配的字节数组创建一个新的堆缓冲.

参数：

length - 新字节数组的长度

HeapChannelBuffer

public HeapChannelBuffer(byte[] array)

使用指定的字节数组创建一个新的堆缓冲.

参数：

array - 被封装的字节数组

方法详细信息

isDirect

public boolean isDirect()

从接口 ChannelBuffer 复制的描述

判断该缓冲区是否是由NIO direct缓冲支持.

capacity

public int capacity()

从接口 ChannelBuffer 复制的描述

返回缓冲区包含字节数量.

hasArray

public boolean hasArray()

从接口 ChannelBuffer 复制的描述

只有当该缓冲有一个支持的字节数组才返回true,如果该方法返回true,你可以安全的调用 ChannelBuffer.array() 和 ChannelBuffer.arrayOffset().

array

public byte[] array()

从接口 ChannelBuffer 复制的描述

返回该缓冲支持的字节数组.

arrayOffset

public int arrayOffset()

从接口 ChannelBuffer 复制的描述

返回该缓冲内部的字节数组的第一个字节的偏移量

getByte

public byte getByte(int index)

从接口 ChannelBuffer 复制的描述

在指定绝对值index处获取一个字节.该方法并不修改缓冲的 readerIndex 和 writerIndex.

getBytes

public void getBytes(int index,
                     ChannelBuffer dst,
                     int dstIndex,
                     int length)

从接口 ChannelBuffer 复制的描述

在该缓冲区指定绝对值index开始处传输数据到指定的目标. 该方法并不修改源缓冲区和目标缓冲区的 readerIndex 和 writerIndex

dstIndex - 目标缓冲区的开始索引

length - 传输字节数量

getBytes

public void getBytes(int index,
                     byte[] dst,
                     int dstIndex,
                     int length)

从接口 ChannelBuffer 复制的描述

在该缓冲区指定绝对值index开始处传输数据到指定的目标. 该方法并不修改该缓冲区的 readerIndex 和 writerIndex.

dstIndex - 目标缓冲区的开始索引

length - 传输的字节数量

getBytes

public void getBytes(int index,
                     java.nio.ByteBuffer dst)

从接口 ChannelBuffer 复制的描述

在该缓冲区指定绝对值index开始处传输数据到指定的目标,直到目标的position到达限制为止. 该方法并不修改该缓冲区的 readerIndex 和 writerIndex,但会增加目标的 position.

getBytes

public void getBytes(int index,
                     java.io.OutputStream out,
                     int length)
              throws java.io.IOException

从接口 ChannelBuffer 复制的描述

在该缓冲区指定绝对值index开始处传输数据到指定的数据流.该方法并不修改该缓冲区的 readerIndex 和 writerIndex.

length - 传输字节的数量

抛出：

java.io.IOException - 指定的数据流在I/O期间抛出的异常

getBytes

public int getBytes(int index,
                    java.nio.channels.GatheringByteChannel out,
                    int length)
             throws java.io.IOException

从接口 ChannelBuffer 复制的描述

在该缓冲区指定绝对值index开始处传输数据到指定的通道.该方法并不修改该缓冲区的 readerIndex 和 writerIndex.

length - 传输字节的最大数

返回：

传输的实际字节数

抛出：

java.io.IOException - 指定的通道在I/O期间抛出的异常

setByte

public void setByte(int index,
                    int value)

从接口 ChannelBuffer 复制的描述

在指定绝对值index处设置指定的字节. 24高序位会被忽略. 该方法并不修改该缓冲区的 readerIndex 和 writerIndex.

setBytes

public void setBytes(int index,
                     ChannelBuffer src,
                     int srcIndex,
                     int length)

从接口 ChannelBuffer 复制的描述

把指定的源缓冲区的数据传输到该缓冲区指定绝对值index的位置 . 该方法并不修改该缓冲区和源缓冲区的 readerIndex 和 writerIndex.

srcIndex - 源缓冲区的开始索引

length - 传输的字节数

setBytes

public void setBytes(int index,
                     byte[] src,
                     int srcIndex,
                     int length)

从接口 ChannelBuffer 复制的描述

把指定的源数组的数据传输到该缓冲区指定绝对值index的位置 . 该方法并不修改该缓冲区和源缓冲区的 readerIndex 和 writerIndex.

setBytes

public void setBytes(int index,
                     java.nio.ByteBuffer src)

从接口 ChannelBuffer 复制的描述

把指定的源缓冲的数据传输到该缓冲区指定绝对值index的位置 ,直到源缓冲的position到达限制为止. 该方法并不修改该缓冲区和源缓冲区的 readerIndex 和 writerIndex.

setBytes

public int setBytes(int index,
                    java.io.InputStream in,
                    int length)
             throws java.io.IOException

从接口 ChannelBuffer 复制的描述

把指定的源输入流的数据传输到该缓冲区指定绝对值index的位置 . 该方法并不修改该缓冲区和源缓冲区的 readerIndex 和 writerIndex.

length - 传输的字节数

返回：

返回从输入流读取的实际字节数.如果指定的输入流被关闭则返回 -1.

抛出：

java.io.IOException - 输入流在IO期间抛出的异常

setBytes

public int setBytes(int index,
                    java.nio.channels.ScatteringByteChannel in,
                    int length)
             throws java.io.IOException

从接口 ChannelBuffer 复制的描述

把指定的源通道的数据传输到该缓冲区指定绝对值index的位置 . 该方法并不修改该缓冲区和源缓冲区的 readerIndex 和 writerIndex.

length - 最大的传输字节数

返回：

返回从通道读取的实际字节数.如果指定的通道被关闭则返回 -1.

抛出：

java.io.IOException - 通道在IO期间抛出的异常

slice

public ChannelBuffer slice(int index,
                           int length)

从接口 ChannelBuffer 复制的描述

返回该缓冲子部分的切片.修改其中任何一个缓冲对另一个都会有影响,不过它们维护着各自的索引和标记,且并不修改该缓冲区的 readerIndex和writerIndex.

toByteBuffer

public java.nio.ByteBuffer toByteBuffer(int index,
                                        int length)

从接口 ChannelBuffer 复制的描述

转化该缓冲区的子部分到一个NIO缓冲区.返回的缓冲区可能有或没有和该缓冲共享内容,但是它们有各自的索引和标记. 且并不修改该缓冲区的 readerIndex和 writerIndex.