WebSocketFrameImpl (Vertx Javadocs 4.0.3.GA API)

java.lang.Object
- io.vertx.core.http.impl.ws.WebSocketFrameImpl

All Implemented Interfaces:

io.netty.util.ReferenceCounted, WebSocketFrameInternal, WebSocketFrame
```
public class WebSocketFrameImpl
extends Object
implements WebSocketFrameInternal, io.netty.util.ReferenceCounted
```
The default WebSocketFrameInternal implementation.

Version:

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

Author:

The Netty Project, Trustin Lee

Constructor Summary

Constructors
Constructor and Description
`WebSocketFrameImpl()` Creates a new empty text frame.
`WebSocketFrameImpl(String textData)` Creates a new text frame from with the specified string.
`WebSocketFrameImpl(String textData, boolean isFinalFrame)` Creates a new text frame from with the specified string.
`WebSocketFrameImpl(WebSocketFrameType frameType)` Creates a new empty text frame.
`WebSocketFrameImpl(WebSocketFrameType type, io.netty.buffer.ByteBuf binaryData)` Creates a new frame with the specified frame type and the specified data.
`WebSocketFrameImpl(WebSocketFrameType type, io.netty.buffer.ByteBuf binaryData, boolean isFinalFrame)` Creates a new frame with the specified frame type and the specified data.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Buffer`	`binaryData()`
`static WebSocketFrame`	`binaryFrame(Buffer data, boolean isFinal)` Create a binary WebSocket frame.
`String`	`closeReason()`
`short`	`closeStatusCode()`
`static WebSocketFrame`	`continuationFrame(Buffer data, boolean isFinal)` Create a continuation frame
`io.netty.buffer.ByteBuf`	`getBinaryData()` Returns the content of this frame as-is, with no UTF-8 decoding.
`boolean`	`isBinary()`
`boolean`	`isClose()`
`boolean`	`isContinuation()`
`boolean`	`isFinal()`
`boolean`	`isPing()`
`boolean`	`isText()`
`int`	`length()`
`static WebSocketFrame`	`pingFrame(Buffer data)` Create a ping WebSocket frame.
`static WebSocketFrame`	`pongFrame(Buffer data)` Create a pong WebSocket frame.
`int`	`refCnt()`
`boolean`	`release()`
`boolean`	`release(int decrement)`
`io.netty.util.ReferenceCounted`	`retain()`
`io.netty.util.ReferenceCounted`	`retain(int increment)`
`void`	`setBinaryData(io.netty.buffer.ByteBuf binaryData)` Sets the type and the content of this frame.
`void`	`setTextData(String textData)` Set the type of the content of this frame and populate it with the given content
`String`	`textData()`
`static WebSocketFrame`	`textFrame(String str, boolean isFinal)` Create a text WebSocket frame.
`String`	`toString()`
`io.netty.util.ReferenceCounted`	`touch()`
`io.netty.util.ReferenceCounted`	`touch(Object hint)`
`WebSocketFrameType`	`type()`

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

- Constructor Detail
  - WebSocketFrameImpl
```
public WebSocketFrameImpl()
```
    Creates a new empty text frame.
  - WebSocketFrameImpl
```
public WebSocketFrameImpl(WebSocketFrameType frameType)
```
    Creates a new empty text frame.
  - WebSocketFrameImpl
```
public WebSocketFrameImpl(String textData)
```
    Creates a new text frame from with the specified string.
  - WebSocketFrameImpl
```
public WebSocketFrameImpl(String textData,
                          boolean isFinalFrame)
```
    Creates a new text frame from with the specified string.
  - WebSocketFrameImpl
```
public WebSocketFrameImpl(WebSocketFrameType type,
                          io.netty.buffer.ByteBuf binaryData)
```
    Creates a new frame with the specified frame type and the specified data.
    
    Parameters:
    
    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.
    
    Throws:
    
    IllegalArgumentException - if If (type & 0x80 == 0) and the data is not encoded in UTF-8
  - WebSocketFrameImpl
```
public WebSocketFrameImpl(WebSocketFrameType type,
                          io.netty.buffer.ByteBuf binaryData,
                          boolean isFinalFrame)
```
    Creates a new frame with the specified frame type and the specified data.
    
    Parameters:
    
    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.
    
    isFinalFrame - If this is the final frame in a sequence
    
    Throws:
    
    IllegalArgumentException - if If (type & 0x80 == 0) and the data is not encoded in UTF-8
- Method Detail
  - binaryFrame
```
public static WebSocketFrame binaryFrame(Buffer data,
                                         boolean isFinal)
```
    Description copied from interface: WebSocketFrame
    
    Create a binary WebSocket frame.
    
    Specified by:
    
    binaryFrame in interface WebSocketFrame
    
    Parameters:
    
    data - the data for the frame
    
    isFinal - true if it's the final frame in the WebSocket message
    
    Returns:
    
    the frame
  - textFrame
```
public static WebSocketFrame textFrame(String str,
                                       boolean isFinal)
```
    Description copied from interface: WebSocketFrame
    
    Create a text WebSocket frame.
    
    Specified by:
    
    textFrame in interface WebSocketFrame
    
    Parameters:
    
    str - the string for the frame
    
    isFinal - true if it's the final frame in the WebSocket message
    
    Returns:
    
    the frame
  - continuationFrame
```
public static WebSocketFrame continuationFrame(Buffer data,
                                               boolean isFinal)
```
    Description copied from interface: WebSocketFrame
    
    Create a continuation frame
    
    Specified by:
    
    continuationFrame in interface WebSocketFrame
    
    Parameters:
    
    data - the data for the frame
    
    isFinal - true if it's the final frame in the WebSocket message
    
    Returns:
    
    the frame
  - pingFrame
```
public static WebSocketFrame pingFrame(Buffer data)
```
    Description copied from interface: WebSocketFrame
    
    Create a ping WebSocket frame. Will be a final frame. There is no option for non final ping frames.
    
    Specified by:
    
    pingFrame in interface WebSocketFrame
    
    Parameters:
    
    data - the bytes for the frame, may be at most 125 bytes
    
    Returns:
    
    the frame
  - pongFrame
```
public static WebSocketFrame pongFrame(Buffer data)
```
    Description copied from interface: WebSocketFrame
    
    Create a pong WebSocket frame. Will be a final frame. There is no option for non final pong frames.
    
    Specified by:
    
    pongFrame in interface WebSocketFrame
    
    Parameters:
    
    data - the bytes for the frame, may be at most 125 bytes
    
    Returns:
    
    the frame
  - isText
```
public boolean isText()
```
    Specified by:
    
    isText in interface WebSocketFrame
    
    Returns:
    
    whether the frame is a WebSocketFrameType.TEXT frame
  - isBinary
```
public boolean isBinary()
```
    Specified by:
    
    isBinary in interface WebSocketFrame
    
    Returns:
    
    whether the frame is a WebSocketFrameType.BINARY frame
  - isContinuation
```
public boolean isContinuation()
```
    Specified by:
    
    isContinuation in interface WebSocketFrame
    
    Returns:
    
    whether the frame is a WebSocketFrameType.CONTINUATION frame
  - isClose
```
public boolean isClose()
```
    Specified by:
    
    isClose in interface WebSocketFrame
    
    Returns:
    
    whether the frame is a WebSocketFrameType.CLOSE frame
  - isPing
```
public boolean isPing()
```
    Specified by:
    
    isPing in interface WebSocketFrame
    
    Returns:
    
    whether the frame is a WebSocketFrameType.PING frame
  - getBinaryData
```
public io.netty.buffer.ByteBuf getBinaryData()
```
    Description copied from interface: WebSocketFrameInternal
    
    Returns the content of this frame as-is, with no UTF-8 decoding.
    
    Specified by:
    
    getBinaryData in interface WebSocketFrameInternal
  - textData
```
public String textData()
```
    Specified by:
    
    textData in interface WebSocketFrame
    
    Returns:
    
    the content of this frame as a UTF-8 string and returns the converted string. Only use this for text frames.
  - binaryData
```
public Buffer binaryData()
```
    Specified by:
    
    binaryData in interface WebSocketFrame
    
    Returns:
    
    the data of the frame
  - setBinaryData
```
public void setBinaryData(io.netty.buffer.ByteBuf binaryData)
```
    Description copied from interface: WebSocketFrameInternal
    
    Sets the type and the content of this frame.
    
    Specified by:
    
    setBinaryData in interface WebSocketFrameInternal
    
    Parameters:
    
    binaryData - the content of the frame. If (type & 0x80 == 0), it must be encoded in UTF-8.
  - setTextData
```
public void setTextData(String textData)
```
    Description copied from interface: WebSocketFrameInternal
    
    Set the type of the content of this frame and populate it with the given content
    
    Specified by:
    
    setTextData in interface WebSocketFrameInternal
    
    Parameters:
    
    textData - the content of the frame. Must be valid UTF-8
  - length
```
public int length()
```
    Specified by:
    
    length in interface WebSocketFrameInternal
    
    Returns:
    
    the frame binary data length
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - refCnt
```
public int refCnt()
```
    Specified by:
    
    refCnt in interface io.netty.util.ReferenceCounted
  - retain
```
public io.netty.util.ReferenceCounted retain()
```
    Specified by:
    
    retain in interface io.netty.util.ReferenceCounted
  - retain
```
public io.netty.util.ReferenceCounted retain(int increment)
```
    Specified by:
    
    retain in interface io.netty.util.ReferenceCounted
  - release
```
public boolean release()
```
    Specified by:
    
    release in interface io.netty.util.ReferenceCounted
  - release
```
public boolean release(int decrement)
```
    Specified by:
    
    release in interface io.netty.util.ReferenceCounted
  - touch
```
public io.netty.util.ReferenceCounted touch()
```
    Specified by:
    
    touch in interface io.netty.util.ReferenceCounted
  - touch
```
public io.netty.util.ReferenceCounted touch(Object hint)
```
    Specified by:
    
    touch in interface io.netty.util.ReferenceCounted
  - isFinal
```
public boolean isFinal()
```
    Specified by:
    
    isFinal in interface WebSocketFrame
    
    Returns:
    
    true if this is the final frame.
  - closeStatusCode
```
public short closeStatusCode()
```
    Specified by:
    
    closeStatusCode in interface WebSocketFrame
    
    Returns:
    
    status code of close frame. Only use this for close frames
  - closeReason
```
public String closeReason()
```
    Specified by:
    
    closeReason in interface WebSocketFrame
    
    Returns:
    
    string explaining close reason. Only use this for close frames
  - type
```
public WebSocketFrameType type()
```
    Specified by:
    
    type in interface WebSocketFrame
    
    Returns:
    
    the frame type

Class WebSocketFrameImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WebSocketFrameImpl

WebSocketFrameImpl

WebSocketFrameImpl

WebSocketFrameImpl

WebSocketFrameImpl

WebSocketFrameImpl

Method Detail

binaryFrame

textFrame

continuationFrame

pingFrame

pongFrame

isText

isBinary

isContinuation

isClose

isPing

getBinaryData

textData

binaryData

setBinaryData

setTextData

length

toString

refCnt

retain

retain

release

release

touch

touch

isFinal

closeStatusCode

closeReason

type