WebSocketFrame

java.lang.Object

org.jboss.netty.handler.codec.http.websocketx.WebSocketFrame

Direct Known Subclasses:: BinaryWebSocketFrame, CloseWebSocketFrame, ContinuationWebSocketFrame, PingWebSocketFrame, PongWebSocketFrame, TextWebSocketFrame

public abstract class WebSocketFrame extends Object

Base class for web socket frames

Field Summary

Fields

Modifier and Type

Field

Description

private ChannelBuffer

binaryData

Contents of this frame

private boolean

finalFragment

Flag to indicate if this frame is the final fragment in a message.

private int

rsv

RSV1, RSV2, RSV3 used for extensions
Constructor Summary

Constructors

Constructor

Description

WebSocketFrame()
Method Summary

Modifier and Type

Method

Description

ChannelBuffer

getBinaryData()

Returns binary data

int

getRsv()

Bits used for extensions to the standard.

boolean

isFinalFragment()

Flag to indicate if this frame is the final fragment in a message.

void

setBinaryData(ChannelBuffer binaryData)

Sets the binary data for this frame

void

setFinalFragment(boolean finalFragment)

void

setRsv(int rsv)

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- finalFragment
  
  private boolean finalFragment
  
  Flag to indicate if this frame is the final fragment in a message. The first fragment (frame) may also be the final fragment.
- rsv
  
  private int rsv
  
  RSV1, RSV2, RSV3 used for extensions
- binaryData
  
  private ChannelBuffer binaryData
  
  Contents of this frame
Constructor Details
- WebSocketFrame
  
  public WebSocketFrame()
Method Details
- getBinaryData
  
  public ChannelBuffer getBinaryData()
  
  Returns binary data
- setBinaryData
  
  public void setBinaryData(ChannelBuffer binaryData)
  
  Sets the binary data for this frame
- isFinalFragment
  
  public boolean isFinalFragment()
  
  Flag to indicate if this frame is the final fragment in a message. The first fragment (frame) may also be the final fragment.
- setFinalFragment
  
  public void setFinalFragment(boolean finalFragment)
- getRsv
  
  public int getRsv()
  
  Bits used for extensions to the standard.
- setRsv
  
  public void setRsv(int rsv)