org.eclipse.jetty.websocket.common.frames

Class DataFrame

java.lang.Object

org.eclipse.jetty.websocket.common.WebSocketFrame

org.eclipse.jetty.websocket.common.frames.DataFrame

All Implemented Interfaces:

Frame

Direct Known Subclasses:

BinaryFrame, ContinuationFrame, TextFrame

public class DataFrame
extends WebSocketFrame

A Data Frame

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jetty.websocket.api.extensions.Frame

Frame.Type

Field Summary

Fields inherited from class org.eclipse.jetty.websocket.common.WebSocketFrame

data, finRsvOp, mask, masked, payloadLength

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DataFrame(byte opcode)
	DataFrame(Frame basedOn) Construct new DataFrame based on headers of provided frame.
	DataFrame(Frame basedOn, boolean continuation) Construct new DataFrame based on headers of provided frame, overriding for continuations if needed.

Method Summary

Methods

Modifier and Type	Method and Description
void	assertValid()
boolean	isControlFrame()
boolean	isDataFrame()
boolean	isPooledBuffer()
void	setIsContinuation() Set the data frame to continuation mode
void	setPooledBuffer(boolean isPooledBuffer) Sets a flag indicating that the underlying payload is from a ByteBufferPool and can be released when appropriate to do so

Methods inherited from class org.eclipse.jetty.websocket.common.WebSocketFrame

copy, copy, copyHeaders, copyHeaders, equals, getMask, getOpCode, getPayload, getPayloadAsUTF8, getPayloadLength, getType, hashCode, hasPayload, isFin, isLast, isMasked, isRsv1, isRsv2, isRsv3, position, remaining, reset, setFin, setMask, setMasked, setOpCode, setPayload, setRsv1, setRsv2, setRsv3, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DataFrame

protected DataFrame(byte opcode)

DataFrame

public DataFrame(Frame basedOn)

Construct new DataFrame based on headers of provided frame.

Useful for when working in extensions and a new frame needs to be created.

DataFrame

public DataFrame(Frame basedOn,
         boolean continuation)

Construct new DataFrame based on headers of provided frame, overriding for continuations if needed.

Useful for when working in extensions and a new frame needs to be created.

Method Detail

assertValid

public void assertValid()

Specified by:

assertValid in class WebSocketFrame

isControlFrame

public boolean isControlFrame()

Specified by:

isControlFrame in class WebSocketFrame

isDataFrame

public boolean isDataFrame()

Specified by:

isDataFrame in class WebSocketFrame

isPooledBuffer

public boolean isPooledBuffer()

Returns:

true if payload buffer is from a ByteBufferPool and can be released when appropriate to do so

setIsContinuation

public void setIsContinuation()

Set the data frame to continuation mode

setPooledBuffer

public void setPooledBuffer(boolean isPooledBuffer)

Sets a flag indicating that the underlying payload is from a ByteBufferPool and can be released when appropriate to do so