com.taobao.api.internal.toplink.embedded.websocket.frame

Class Frame

java.lang.Object

com.taobao.api.internal.toplink.embedded.websocket.frame.Frame

Direct Known Subclasses:

FrameDraft06, FrameDraft76, FrameRfc6455

public abstract class Frame
extends Object

The Class Frame.

Author:

Takahiro Hashimoto

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	contents The contents.
protected FrameHeader	header The header.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Frame() Instantiates a new frame.
protected	Frame(FrameHeader header, byte[] contents) Instantiates a new frame.

Method Summary

Modifier and Type	Method and Description
ByteBuffer	getContents() Gets the raw contents.
long	getContentsLength() Gets the contents length.
FrameHeader	getHeader() Gets the header.
void	readContents(byte[] buf) Gets the raw contents.
void	readContents(byte[] buf, int offset, int length) Gets the raw contents.
protected void	setContents(byte[] contents) Sets the contents.
protected void	setHeader(FrameHeader header) Sets the header.
abstract ByteBuffer	toByteBuffer() convert frame to byte buffer.

Methods inherited from class java.lang.Object

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

Field Detail

header

protected FrameHeader header

The header.

contents

protected byte[] contents

The contents.

Constructor Detail

Frame

protected Frame()

Instantiates a new frame.

Frame

protected Frame(FrameHeader header,
                byte[] contents)

Instantiates a new frame.

Parameters:

header - the header

contents - the contents

Method Detail

getContentsLength

public long getContentsLength()

Gets the contents length.

Returns:

the contents length

getHeader

public FrameHeader getHeader()

Gets the header.

Returns:

the header

toByteBuffer

public abstract ByteBuffer toByteBuffer()

convert frame to byte buffer.

Returns:

the byte buffer

getContents

public ByteBuffer getContents()

Gets the raw contents.

Returns:

the raw contents

readContents

public void readContents(byte[] buf)

Gets the raw contents.

readContents

public void readContents(byte[] buf,
                         int offset,
                         int length)

Gets the raw contents.

setHeader

protected void setHeader(FrameHeader header)

Sets the header.

Parameters:

header - the new header

setContents

protected void setContents(byte[] contents)

Sets the contents.

Parameters:

contents - the new contents