io.netty.handler.codec.spdy

Class DefaultSpdyDataFrame

java.lang.Object

io.netty.handler.codec.spdy.DefaultSpdyStreamFrame

io.netty.handler.codec.spdy.DefaultSpdyDataFrame

All Implemented Interfaces:

ByteBufHolder, SpdyDataFrame, SpdyFrame, SpdyStreamFrame, ReferenceCounted

public class DefaultSpdyDataFrame
extends DefaultSpdyStreamFrame
implements SpdyDataFrame

The default SpdyDataFrame implementation.

Constructor Summary

Constructors

Constructor and Description
DefaultSpdyDataFrame(int streamId) Creates a new instance.
DefaultSpdyDataFrame(int streamId, ByteBuf data) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
ByteBuf	content() Returns the data payload of this frame.
SpdyDataFrame	copy() Creates a deep copy of this ByteBufHolder.
SpdyDataFrame	duplicate() Duplicates this ByteBufHolder.
int	refCnt() Returns the reference count of this object.
boolean	release() Decreases the reference count by 1 and deallocates this object if the reference count reaches at 0.
boolean	release(int decrement) Decreases the reference count by the specified decrement and deallocates this object if the reference count reaches at 0.
SpdyDataFrame	replace(ByteBuf content) Returns a new ByteBufHolder which contains the specified content.
SpdyDataFrame	retain() Increases the reference count by 1.
SpdyDataFrame	retain(int increment) Increases the reference count by the specified increment.
SpdyDataFrame	retainedDuplicate() Duplicates this ByteBufHolder.
SpdyDataFrame	setLast(boolean last) Sets if this frame is the last frame to be transmitted on the stream.
SpdyDataFrame	setStreamId(int streamId) Sets the Stream-ID of this frame.
String	toString()
SpdyDataFrame	touch() Records the current access location of this object for debugging purposes.
SpdyDataFrame	touch(Object hint) Records the current access location of this object with an additional arbitrary information for debugging purposes.

Methods inherited from class io.netty.handler.codec.spdy.DefaultSpdyStreamFrame

isLast, streamId

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.handler.codec.spdy.SpdyStreamFrame

isLast, streamId

Constructor Detail

DefaultSpdyDataFrame

public DefaultSpdyDataFrame(int streamId)

Creates a new instance.

Parameters:

streamId - the Stream-ID of this frame

DefaultSpdyDataFrame

public DefaultSpdyDataFrame(int streamId,
                            ByteBuf data)

Creates a new instance.

Parameters:

streamId - the Stream-ID of this frame

data - the payload of the frame. Can not exceed SpdyCodecUtil.SPDY_MAX_LENGTH

Method Detail

setStreamId

public SpdyDataFrame setStreamId(int streamId)

Description copied from interface: SpdyStreamFrame

Sets the Stream-ID of this frame. The Stream-ID must be positive.

Specified by:

setStreamId in interface SpdyDataFrame

Specified by:

setStreamId in interface SpdyStreamFrame

Overrides:

setStreamId in class DefaultSpdyStreamFrame

setLast

public SpdyDataFrame setLast(boolean last)

Description copied from interface: SpdyStreamFrame

Sets if this frame is the last frame to be transmitted on the stream.

Specified by:

setLast in interface SpdyDataFrame

Specified by:

setLast in interface SpdyStreamFrame

Overrides:

setLast in class DefaultSpdyStreamFrame

content

public ByteBuf content()

Description copied from interface: SpdyDataFrame

Returns the data payload of this frame. If there is no data payload Unpooled.EMPTY_BUFFER is returned. The data payload cannot exceed 16777215 bytes.

Specified by:

content in interface ByteBufHolder

Specified by:

content in interface SpdyDataFrame

copy

public SpdyDataFrame copy()

Description copied from interface: ByteBufHolder

Creates a deep copy of this ByteBufHolder.

Specified by:

copy in interface ByteBufHolder

Specified by:

copy in interface SpdyDataFrame

duplicate

public SpdyDataFrame duplicate()

Description copied from interface: ByteBufHolder

Duplicates this ByteBufHolder. Be aware that this will not automatically call ByteBufHolder.retain().

Specified by:

duplicate in interface ByteBufHolder

Specified by:

duplicate in interface SpdyDataFrame

retainedDuplicate

public SpdyDataFrame retainedDuplicate()

Description copied from interface: ByteBufHolder

Duplicates this ByteBufHolder. This method returns a retained duplicate unlike ByteBufHolder.duplicate().

Specified by:

retainedDuplicate in interface ByteBufHolder

Specified by:

retainedDuplicate in interface SpdyDataFrame

See Also:

ByteBuf.retainedDuplicate()

replace

public SpdyDataFrame replace(ByteBuf content)

Description copied from interface: ByteBufHolder

Returns a new ByteBufHolder which contains the specified content.

Specified by:

replace in interface ByteBufHolder

Specified by:

replace in interface SpdyDataFrame

refCnt

public int refCnt()

Description copied from interface: ReferenceCounted

Returns the reference count of this object. If 0, it means this object has been deallocated.

Specified by:

refCnt in interface ReferenceCounted

retain

public SpdyDataFrame retain()

Description copied from interface: ReferenceCounted

Increases the reference count by 1.

Specified by:

retain in interface ByteBufHolder

Specified by:

retain in interface SpdyDataFrame

Specified by:

retain in interface ReferenceCounted

retain

public SpdyDataFrame retain(int increment)

Description copied from interface: ReferenceCounted

Increases the reference count by the specified increment.

Specified by:

retain in interface ByteBufHolder

Specified by:

retain in interface SpdyDataFrame

Specified by:

retain in interface ReferenceCounted

touch

public SpdyDataFrame touch()

Description copied from interface: ReferenceCounted

Records the current access location of this object for debugging purposes. If this object is determined to be leaked, the information recorded by this operation will be provided to you via ResourceLeakDetector. This method is a shortcut to touch(null).

Specified by:

touch in interface ByteBufHolder

Specified by:

touch in interface SpdyDataFrame

Specified by:

touch in interface ReferenceCounted

touch

public SpdyDataFrame touch(Object hint)

Description copied from interface: ReferenceCounted

Records the current access location of this object with an additional arbitrary information for debugging purposes. If this object is determined to be leaked, the information recorded by this operation will be provided to you via ResourceLeakDetector.

Specified by:

touch in interface ByteBufHolder

Specified by:

touch in interface SpdyDataFrame

Specified by:

touch in interface ReferenceCounted

release

public boolean release()

Description copied from interface: ReferenceCounted

Decreases the reference count by 1 and deallocates this object if the reference count reaches at 0.

Specified by:

release in interface ReferenceCounted

Returns:

true if and only if the reference count became 0 and this object has been deallocated

release

public boolean release(int decrement)

Description copied from interface: ReferenceCounted

Decreases the reference count by the specified decrement and deallocates this object if the reference count reaches at 0.

Specified by:

release in interface ReferenceCounted

Returns:

true if and only if the reference count became 0 and this object has been deallocated

toString

public String toString()

Overrides:

toString in class Object