org.eclipse.jetty.spdy.api

Class BytesDataInfo

java.lang.Object

org.eclipse.jetty.spdy.api.Info

org.eclipse.jetty.spdy.api.DataInfo

org.eclipse.jetty.spdy.api.BytesDataInfo

Direct Known Subclasses:

StringDataInfo

public class BytesDataInfo
extends DataInfo

Specialized DataInfo for byte array content.

Field Summary

Fields inherited from class org.eclipse.jetty.spdy.api.DataInfo

FLAG_CLOSE

Constructor Summary

Constructors

Constructor and Description
BytesDataInfo(byte[] bytes, boolean close)
BytesDataInfo(long timeout, TimeUnit unit, byte[] bytes, boolean close)
BytesDataInfo(long timeout, TimeUnit unit, byte[] bytes, int offset, int length, boolean close)

Method Summary

Methods

Modifier and Type	Method and Description
int	available() Returns the available content bytes that can be read via DataInfo.readInto(ByteBuffer).
int	length()
int	readInto(byte[] bytes, int offset, int length) Copies the content bytes of this DataInfo into the given byte array.
int	readInto(ByteBuffer output) Copies the content bytes of this DataInfo into the given ByteBuffer.

Methods inherited from class org.eclipse.jetty.spdy.api.DataInfo

allocate, asByteBuffer, asBytes, asString, asString, consume, consumed, consumeInto, consumeInto, getFlags, isClose, setClose, toString

Methods inherited from class org.eclipse.jetty.spdy.api.Info

getTimeout, getUnit

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BytesDataInfo

public BytesDataInfo(byte[] bytes,
             boolean close)

BytesDataInfo

public BytesDataInfo(long timeout,
             TimeUnit unit,
             byte[] bytes,
             boolean close)

BytesDataInfo

public BytesDataInfo(long timeout,
             TimeUnit unit,
             byte[] bytes,
             int offset,
             int length,
             boolean close)

Method Detail

length

public int length()

Specified by:

length in class DataInfo

Returns:

the total number of content bytes

See Also:

DataInfo.available()

available

public int available()

Description copied from class: DataInfo

Returns the available content bytes that can be read via DataInfo.readInto(ByteBuffer).

Each invocation to DataInfo.readInto(ByteBuffer) modifies the value returned by this method, until no more content bytes are available.

Specified by:

available in class DataInfo

Returns:

the available content bytes

See Also:

DataInfo.readInto(ByteBuffer)

readInto

public int readInto(ByteBuffer output)

Description copied from class: DataInfo

Copies the content bytes of this DataInfo into the given ByteBuffer.

If the given ByteBuffer cannot contain the whole content of this DataInfo then after the read DataInfo.available() will return a positive value, and further content may be retrieved by invoking again this method with a new output buffer.

Specified by:

readInto in class DataInfo

Parameters:

output - the ByteBuffer to copy the bytes into

Returns:

the number of bytes copied

See Also:

DataInfo.available(), DataInfo.consumeInto(ByteBuffer)

readInto

public int readInto(byte[] bytes,
           int offset,
           int length)

Description copied from class: DataInfo

Copies the content bytes of this DataInfo into the given byte array.

If the given byte array cannot contain the whole content of this DataInfo then after the read DataInfo.available() will return a positive value, and further content may be retrieved by invoking again this method with a new byte array.

Specified by:

readInto in class DataInfo

Parameters:

bytes - the byte array to copy the bytes into

offset - the index of the byte array to start copying

length - the number of bytes to copy

Returns:

the number of bytes copied