io.vertx.core.http

Interface WebSocketFrame

All Known Subinterfaces:

WebSocketFrameInternal

All Known Implementing Classes:

WebSocketFrameImpl

public interface WebSocketFrame

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

Version:

$Rev: 2080 $, $Date: 2010-01-26 18:04:19 +0900 (Tue, 26 Jan 2010) $

Author:

<a href="http://www.jboss.org/netty/">The Netty Project</a>, <a href="http://gleamynode.net/">Trustin Lee</a>, <a href="http://tfox.org">Tim Fox</a>

Field Summary

Fields

Modifier and Type	Field and Description
static WebSocketFrameFactory	factory

Method Summary

Modifier and Type	Method and Description
Buffer	binaryData()
static WebSocketFrame	binaryFrame(Buffer data, boolean isFinal)
static WebSocketFrame	continuationFrame(Buffer data, boolean isFinal)
boolean	isBinary() Returns true if and only if the content of this frame is an arbitrary binary data.
boolean	isContinuation()
boolean	isFinal() Returns true if this is the final frame.
boolean	isText() Returns true if and only if the content of this frame is a string encoded in UTF-8.
String	textData() Converts the content of this frame into a UTF-8 string and returns the converted string.
static WebSocketFrame	textFrame(String str, boolean isFinal)

Field Detail

factory

static final WebSocketFrameFactory factory

Method Detail

binaryFrame

static WebSocketFrame binaryFrame(Buffer data,
                                  boolean isFinal)

textFrame

static WebSocketFrame textFrame(String str,
                                boolean isFinal)

continuationFrame

static WebSocketFrame continuationFrame(Buffer data,
                                        boolean isFinal)

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.

isContinuation

boolean isContinuation()

textData

String textData()

Converts the content of this frame into a UTF-8 string and returns the converted string.

binaryData

Buffer binaryData()

isFinal

boolean isFinal()

Returns true if this is the final frame. This should be true unless a number of coninuation frames are expected to follow this frame.