io.netty.handler.codec.http.websocketx

Class ContinuationWebSocketFrame

java.lang.Object

io.netty.buffer.DefaultByteBufHolder

io.netty.handler.codec.http.websocketx.WebSocketFrame

io.netty.handler.codec.http.websocketx.ContinuationWebSocketFrame

All Implemented Interfaces:

io.netty.buffer.ByteBufHolder, io.netty.util.ReferenceCounted

public class ContinuationWebSocketFrame
extends WebSocketFrame

Web Socket continuation frame containing continuation text or binary data. This is used for fragmented messages where the contents of a messages is contained more than 1 frame.

Constructor Summary

Constructors

Constructor and Description
ContinuationWebSocketFrame() Creates a new empty continuation frame.
ContinuationWebSocketFrame(boolean finalFragment, int rsv, io.netty.buffer.ByteBuf binaryData) Creates a new continuation frame with the specified binary data
ContinuationWebSocketFrame(boolean finalFragment, int rsv, io.netty.buffer.ByteBuf binaryData, String aggregatedText) Creates a new continuation frame with the specified binary data
ContinuationWebSocketFrame(boolean finalFragment, int rsv, String text) Creates a new continuation frame with the specified text data
ContinuationWebSocketFrame(io.netty.buffer.ByteBuf binaryData) Creates a new continuation frame with the specified binary data.

Method Summary

Methods

Modifier and Type	Method and Description
String	aggregatedText() Aggregated text returned by decoder on the final continuation frame of a fragmented text message
ContinuationWebSocketFrame	copy()
ContinuationWebSocketFrame	duplicate()
ContinuationWebSocketFrame	retain()
ContinuationWebSocketFrame	retain(int increment)
String	text() Returns the text data in this frame

Methods inherited from class io.netty.handler.codec.http.websocketx.WebSocketFrame

isFinalFragment, rsv, toString

Methods inherited from class io.netty.buffer.DefaultByteBufHolder

content, refCnt, release, release

Methods inherited from class java.lang.Object

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

Constructor Detail

ContinuationWebSocketFrame

public ContinuationWebSocketFrame()

Creates a new empty continuation frame.

ContinuationWebSocketFrame

public ContinuationWebSocketFrame(io.netty.buffer.ByteBuf binaryData)

Creates a new continuation frame with the specified binary data. The final fragment flag is set to true.

Parameters:

binaryData - the content of the frame.

ContinuationWebSocketFrame

public ContinuationWebSocketFrame(boolean finalFragment,
                          int rsv,
                          io.netty.buffer.ByteBuf binaryData)

Creates a new continuation frame with the specified binary data

Parameters:

finalFragment - flag indicating if this frame is the final fragment

rsv - reserved bits used for protocol extensions

binaryData - the content of the frame.

ContinuationWebSocketFrame

public ContinuationWebSocketFrame(boolean finalFragment,
                          int rsv,
                          io.netty.buffer.ByteBuf binaryData,
                          String aggregatedText)

Creates a new continuation frame with the specified binary data

Parameters:

finalFragment - flag indicating if this frame is the final fragment

rsv - reserved bits used for protocol extensions

binaryData - the content of the frame.

aggregatedText - Aggregated text set by decoder on the final continuation frame of a fragmented text message

ContinuationWebSocketFrame

public ContinuationWebSocketFrame(boolean finalFragment,
                          int rsv,
                          String text)

Creates a new continuation frame with the specified text data

Parameters:

finalFragment - flag indicating if this frame is the final fragment

rsv - reserved bits used for protocol extensions

text - text content of the frame.

Method Detail

text

public String text()

Returns the text data in this frame

aggregatedText

public String aggregatedText()

Aggregated text returned by decoder on the final continuation frame of a fragmented text message

copy

public ContinuationWebSocketFrame copy()

Specified by:

copy in interface io.netty.buffer.ByteBufHolder

Specified by:

copy in class WebSocketFrame

duplicate

public ContinuationWebSocketFrame duplicate()

Specified by:

duplicate in interface io.netty.buffer.ByteBufHolder

Specified by:

duplicate in class WebSocketFrame

retain

public ContinuationWebSocketFrame retain()

Specified by:

retain in interface io.netty.buffer.ByteBufHolder

Specified by:

retain in interface io.netty.util.ReferenceCounted

Overrides:

retain in class WebSocketFrame

retain

public ContinuationWebSocketFrame retain(int increment)

Specified by:

retain in interface io.netty.buffer.ByteBufHolder

Specified by:

retain in interface io.netty.util.ReferenceCounted

Overrides:

retain in class WebSocketFrame