org.vertx.java.core.http

Interface WebSocketFrame

public interface WebSocketFrame

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	WebSocketFrame.FrameType List of all frame types.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isBinary() Returns true if and only if the content of this frame is an arbitrary binary data.
boolean	isFinalFrame() 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.
java.lang.String	textData() Converts the content of this frame into a UTF-8 string and returns the converted string.
java.lang.String	toString() Returns the string representation of this frame.
WebSocketFrame.FrameType	type()

Method Detail

type

WebSocketFrame.FrameType type()

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.

textData

java.lang.String textData()

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

toString

java.lang.String toString()

Returns the string representation of this frame. Please note that this method is not identical to textData().

Overrides:

toString in class java.lang.Object

isFinalFrame

boolean isFinalFrame()

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