org.jboss.netty.handler.codec.http.websocket
接口 WebSocketFrame

所有已知实现类:
DefaultWebSocketFrame

public interface WebSocketFrame

A Web Socket frame that represents either text or binary data.


字段摘要
static WebSocketFrame CLOSING_HANDSHAKE
          Closing handshake message (0xFF, 0x00)
 
方法摘要
 ChannelBuffer getBinaryData()
          Returns the content of this frame as-is, with no UTF-8 decoding.
 java.lang.String getTextData()
          Converts the content of this frame into a UTF-8 string and returns the converted string.
 int getType()
          Returns the type of this frame.
 boolean isBinary()
          Returns true if and only if the content of this frame is an arbitrary binary data.
 boolean isText()
          Returns true if and only if the content of this frame is a string encoded in UTF-8.
 void setData(int type, ChannelBuffer binaryData)
          Sets the type and the content of this frame.
 java.lang.String toString()
          Returns the string representation of this frame.
 

字段详细信息

CLOSING_HANDSHAKE

static final WebSocketFrame CLOSING_HANDSHAKE
Closing handshake message (0xFF, 0x00)

方法详细信息

getType

int getType()
Returns the type of this frame. 0x00-0x7F means a text frame encoded in UTF-8, and 0x80-0xFF means a binary frame. Currently, 0 is the only allowed type according to the specification.


isText

boolean isText()
Returns true if and only if the content of this frame is a string encoded in UTF-8.


isBinary

boolean isBinary()
Returns true if and only if the content of this frame is an arbitrary binary data.


getBinaryData

ChannelBuffer getBinaryData()
Returns the content of this frame as-is, with no UTF-8 decoding.


getTextData

java.lang.String getTextData()
Converts the content of this frame into a UTF-8 string and returns the converted string.


setData

void setData(int type,
             ChannelBuffer binaryData)
Sets the type and the content of this frame.

参数:
type - the type of the frame. 0 is the only allowed type currently.
binaryData - the content of the frame. If (type & 0x80 == 0), it must be encoded in UTF-8.
抛出:
java.lang.IllegalArgumentException - if If (type & 0x80 == 0) and the data is not encoded in UTF-8

toString

java.lang.String toString()
Returns the string representation of this frame. Please note that this method is not identical to getTextData().

覆盖:
java.lang.Object 中的 toString