org.eclipse.jetty.spdy.api

Class DataInfo

java.lang.Object

org.eclipse.jetty.spdy.api.Info

org.eclipse.jetty.spdy.api.DataInfo

Direct Known Subclasses:

ByteBufferDataInfo, BytesDataInfo

public abstract class DataInfo
extends Info

A container for DATA frames metadata and content bytes.

Specialized subclasses (like StringDataInfo) may be used by applications to send specific types of content.

Applications may send multiple instances of DataInfo, usually of the same type, via Stream.data(DataInfo). The last instance must have the close flag set, so that the client knows that no more content is expected.

Receivers of DataInfo via StreamFrameListener.onData(Stream, DataInfo) have two different APIs to read the data content bytes: a read API that does not interact with flow control, and a drain API that interacts with flow control.

Flow control is defined so that when the sender wants to sends a number of bytes larger than the Settings.ID.INITIAL_WINDOW_SIZE value, it will stop sending as soon as it has sent a number of bytes equal to the window size. The receiver has to consume the data bytes that it received in order to tell the sender to send more bytes.

Consuming the data bytes can be done only via consumeInto(ByteBuffer) or by a combination of readInto(ByteBuffer) and consume(int) (possibly at different times).

Field Summary

Fields

Modifier and Type	Field and Description
static byte	FLAG_CLOSE Flag that indicates that this DataInfo is the last frame in the stream.

Constructor Summary

Constructors

Modifier	Constructor and Description
	DataInfo(boolean close) Creates a new DataInfo with the given close flag and no compression flag.
protected	DataInfo(long timeout, TimeUnit unit, boolean close) Creates a new DataInfo with the given close flag and no compression flag.

Method Summary

Methods

Modifier and Type	Method and Description
protected ByteBuffer	allocate(int size)
ByteBuffer	asByteBuffer(boolean consume)
byte[]	asBytes(boolean consume)
String	asString(Charset charset, boolean consume)
String	asString(String charset, boolean consume)
abstract int	available() Returns the available content bytes that can be read via readInto(ByteBuffer).
void	consume(int delta) Consumes the given number of bytes from this DataInfo.
int	consumed()
int	consumeInto(byte[] bytes, int offset, int length) Reads and consumes the content bytes of this DataInfo into the given byte array, starting from index offset for length bytes.
int	consumeInto(ByteBuffer output) Reads and consumes the content bytes of this DataInfo into the given ByteBuffer.
byte	getFlags()
boolean	isClose()
abstract int	length()
abstract int	readInto(byte[] bytes, int offset, int length) Copies the content bytes of this DataInfo into the given byte array.
abstract int	readInto(ByteBuffer output) Copies the content bytes of this DataInfo into the given ByteBuffer.
void	setClose(boolean close)
String	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

Field Detail

FLAG_CLOSE

public static final byte FLAG_CLOSE

Flag that indicates that this DataInfo is the last frame in the stream.

See Also:

isClose(), getFlags(), Constant Field Values

Constructor Detail

DataInfo

public DataInfo(boolean close)

Creates a new DataInfo with the given close flag and no compression flag.

Parameters:

close - the value of the close flag

DataInfo

protected DataInfo(long timeout,
        TimeUnit unit,
        boolean close)

Creates a new DataInfo with the given close flag and no compression flag.

Parameters:

timeout -

unit -

close - the value of the close flag

Method Detail

isClose

public boolean isClose()

Returns:

the value of the close flag

See Also:

setClose(boolean)

setClose

public void setClose(boolean close)

Parameters:

close - the value of the close flag

See Also:

isClose()

getFlags

public byte getFlags()

Returns:

the close and compress flags as integer

See Also:

FLAG_CLOSE

length

public abstract int length()

Returns:

the total number of content bytes

See Also:

available()

available

public abstract int available()

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

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

Returns:

the available content bytes

See Also:

readInto(ByteBuffer)

readInto

public abstract int readInto(ByteBuffer output)

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 available() will return a positive value, and further content may be retrieved by invoking again this method with a new output buffer.

Parameters:

output - the ByteBuffer to copy the bytes into

Returns:

the number of bytes copied

See Also:

available(), consumeInto(ByteBuffer)

readInto

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

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 available() will return a positive value, and further content may be retrieved by invoking again this method with a new byte array.

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

consumeInto

public int consumeInto(ByteBuffer output)

Reads and consumes the content bytes of this DataInfo into the given ByteBuffer.

Parameters:

output - the ByteBuffer to copy the bytes into

Returns:

the number of bytes copied

See Also:

consume(int)

consumeInto

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

Reads and consumes the content bytes of this DataInfo into the given byte array, starting from index offset for length bytes.

Parameters:

bytes - the byte array to copy the bytes into

offset - the offset of the byte array to start copying

length - the number of bytes to copy

Returns:

the number of bytes copied

consume

public void consume(int delta)

Consumes the given number of bytes from this DataInfo.

Parameters:

delta - the number of bytes consumed

consumed

public int consumed()

Returns:

the number of bytes consumed

asString

public String asString(String charset,
              boolean consume)

Parameters:

charset - the charset used to convert the bytes

consume - whether to consume the content

Returns:

a String with the content of this DataInfo

asString

public String asString(Charset charset,
              boolean consume)

Parameters:

charset - the charset used to convert the bytes

consume - whether to consume the content

Returns:

a String with the content of this DataInfo

asBytes

public byte[] asBytes(boolean consume)

Parameters:

consume - whether to consume the content

Returns:

a byte array with the content of this DataInfo

asByteBuffer

public ByteBuffer asByteBuffer(boolean consume)

Parameters:

consume - whether to consume the content

Returns:

a ByteBuffer with the content of this DataInfo

allocate

protected ByteBuffer allocate(int size)

toString

public String toString()

Overrides:

toString in class Object