CompositeChannelBuffer (The Netty Project API Reference (3.2.6.Final))

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jboss.netty.buffer
Class CompositeChannelBuffer

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

All Implemented Interfaces:: Comparable<ChannelBuffer>, ChannelBuffer

public class CompositeChannelBuffer
extends AbstractChannelBuffer
extends AbstractChannelBuffer

A virtual buffer which shows multiple buffers as a single merged buffer. It is recommended to use ChannelBuffers.wrappedBuffer(ChannelBuffer...) instead of calling the constructor explicitly.

Version:: $Rev: 2206 $, $Date: 2010-03-03 14:35:01 +0900 (Wed, 03 Mar 2010) $
Author:: The Netty Project, Trustin Lee, Frederic Bregier (fredbregier@free.fr)

Constructor Summary
`CompositeChannelBuffer(ByteOrder endianness, List<ChannelBuffer> buffers)`

Method Summary
`byte[]`	`array()` Returns the backing byte array of this buffer.
`int`	`arrayOffset()` Returns the offset of the first byte within the backing byte array of this buffer.
`int`	`capacity()` Returns the number of bytes (octets) this buffer can contain.
`ChannelBuffer`	`copy(int index, int length)` Returns a copy of this buffer's sub-region.
`List<ChannelBuffer>`	`decompose(int index, int length)` Same with `slice(int, int)` except that this method returns a list.
`void`	`discardReadBytes()` Discards the bytes between the 0th index and `readerIndex`.
`ChannelBuffer`	`duplicate()` Returns a buffer which shares the whole region of this buffer.
`ChannelBufferFactory`	`factory()` Returns the factory which creates a `ChannelBuffer` whose type and default `ByteOrder` are same with this buffer.
`byte`	`getByte(int index)` Gets a byte at the specified absolute `index` in this buffer.
`void`	`getBytes(int index, byte[] dst, int dstIndex, int length)` Transfers this buffer's data to the specified destination starting at the specified absolute `index`.
`void`	`getBytes(int index, ByteBuffer dst)` Transfers this buffer's data to the specified destination starting at the specified absolute `index` until the destination's position reaches its limit.
`void`	`getBytes(int index, ChannelBuffer dst, int dstIndex, int length)` Transfers this buffer's data to the specified destination starting at the specified absolute `index`.
`int`	`getBytes(int index, GatheringByteChannel out, int length)` Transfers this buffer's data to the specified channel starting at the specified absolute `index`.
`void`	`getBytes(int index, OutputStream out, int length)` Transfers this buffer's data to the specified stream starting at the specified absolute `index`.
`int`	`getInt(int index)` Gets a 32-bit integer at the specified absolute `index` in this buffer.
`long`	`getLong(int index)` Gets a 64-bit long integer at the specified absolute `index` in this buffer.
`short`	`getShort(int index)` Gets a 16-bit short integer at the specified absolute `index` in this buffer.
`int`	`getUnsignedMedium(int index)` Gets an unsigned 24-bit medium integer at the specified absolute `index` in this buffer.
`boolean`	`hasArray()` Returns `true` if and only if this buffer has a backing byte array.
`boolean`	`isDirect()` Returns `true` if and only if this buffer is backed by an NIO direct buffer.
`ByteOrder`	`order()` Returns the endianness of this buffer.
`void`	`setByte(int index, int value)` Sets the specified byte at the specified absolute `index` in this buffer.
`void`	`setBytes(int index, byte[] src, int srcIndex, int length)` Transfers the specified source array's data to this buffer starting at the specified absolute `index`.
`void`	`setBytes(int index, ByteBuffer src)` Transfers the specified source buffer's data to this buffer starting at the specified absolute `index` until the source buffer's position reaches its limit.
`void`	`setBytes(int index, ChannelBuffer src, int srcIndex, int length)` Transfers the specified source buffer's data to this buffer starting at the specified absolute `index`.
`int`	`setBytes(int index, InputStream in, int length)` Transfers the content of the specified source stream to this buffer starting at the specified absolute `index`.
`int`	`setBytes(int index, ScatteringByteChannel in, int length)` Transfers the content of the specified source channel to this buffer starting at the specified absolute `index`.
`void`	`setInt(int index, int value)` Sets the specified 32-bit integer at the specified absolute `index` in this buffer.
`void`	`setLong(int index, long value)` Sets the specified 64-bit long integer at the specified absolute `index` in this buffer.
`void`	`setMedium(int index, int value)` Sets the specified 24-bit medium integer at the specified absolute `index` in this buffer.
`void`	`setShort(int index, int value)` Sets the specified 16-bit short integer at the specified absolute `index` in this buffer.
`ChannelBuffer`	`slice(int index, int length)` Returns a slice of this buffer's sub-region.
`ByteBuffer`	`toByteBuffer(int index, int length)` Converts this buffer's sub-region into a NIO buffer.
`ByteBuffer[]`	`toByteBuffers(int index, int length)` Converts this buffer's sub-region into an array of NIO buffers.
`String`	`toString()` Returns the string representation of this buffer.

Methods inherited from class org.jboss.netty.buffer.AbstractChannelBuffer
bytesBefore, bytesBefore, bytesBefore, bytesBefore, bytesBefore, bytesBefore, checkReadableBytes, clear, compareTo, copy, 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, 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

Methods inherited from class org.jboss.netty.buffer.AbstractChannelBuffer

bytesBefore, bytesBefore, bytesBefore, bytesBefore, bytesBefore, bytesBefore, checkReadableBytes, clear, compareTo, copy, 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, 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

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

Constructor Detail

CompositeChannelBuffer

public CompositeChannelBuffer(ByteOrder endianness,
                              List<ChannelBuffer> buffers)

Method Detail

decompose

public List<ChannelBuffer> decompose(int index,
                                     int length)

Same with slice(int, int) except that this method returns a list.