Module io.inverno.mod.http.base

Package io.inverno.mod.http.base.internal.ws

Class GenericWebSocketFrame.GenericFactory

java.lang.Object

io.inverno.mod.http.base.internal.ws.GenericWebSocketFrame.GenericFactory

All Implemented Interfaces:

WebSocketFrame.Factory

Enclosing class:

GenericWebSocketFrame

public static class GenericWebSocketFrame.GenericFactory
extends Object
implements WebSocketFrame.Factory

Generic WebSocketFrame.Factory implementation.

Since:

1.5

Author:

Jeremy Kuhn

Constructor Summary

Constructors

Constructor	Description
GenericFactory(int maxFrameSize)	Creates a generic WebSocker frame factory.

Method Summary

Modifier and Type	Method	Description
WebSocketFrame	binary(io.netty.buffer.ByteBuf data, boolean finalFragment)	Creates a binary frame with the specified payload data.
WebSocketFrame	continuation(io.netty.buffer.ByteBuf data, boolean finalFragment)	Creates a continuation frame with the specified payload data.
WebSocketFrame	ping(io.netty.buffer.ByteBuf data)	Creates a ping frame with the specified payload data.
WebSocketFrame	pong(io.netty.buffer.ByteBuf data)	Creates a pong frame with the specified payload data.
WebSocketFrame	text(io.netty.buffer.ByteBuf data, boolean finalFragment)	Creates a text frame with the specified payload data.
io.netty.handler.codec.http.websocketx.WebSocketFrame	toUnderlyingWebSocketFrame(WebSocketFrame webSocketFrame)	Converts the specified webSocketFrame to an underlying WebSocket frame.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.inverno.mod.http.base.ws.WebSocketFrame.Factory

binary, text, text, text

Constructor Details

GenericFactory

public GenericFactory(int maxFrameSize)

Creates a generic WebSocker frame factory.

Parameters:

maxFrameSize - the maximum size of a frame

Method Details

binary

public WebSocketFrame binary(io.netty.buffer.ByteBuf data,
 boolean finalFragment)
                      throws WebSocketException

Description copied from interface: WebSocketFrame.Factory

Creates a binary frame with the specified payload data.

Specified by:

binary in interface WebSocketFrame.Factory

Parameters:

data - payload data

finalFragment - true to create a final frame, false otherwise

Returns:

a new WebSocket frame

Throws:

WebSocketException - if there was an error creating the frame

text

public WebSocketFrame text(io.netty.buffer.ByteBuf data,
 boolean finalFragment)
                    throws WebSocketException

Description copied from interface: WebSocketFrame.Factory

Creates a text frame with the specified payload data.

Specified by:

text in interface WebSocketFrame.Factory

Parameters:

data - payload data

finalFragment - true to create a final frame, false otherwise

Returns:

a new WebSocket frame

Throws:

WebSocketException - if there was an error creating the frame

continuation

public WebSocketFrame continuation(io.netty.buffer.ByteBuf data,
 boolean finalFragment)
                            throws WebSocketException

Description copied from interface: WebSocketFrame.Factory

Creates a continuation frame with the specified payload data.

Specified by:

continuation in interface WebSocketFrame.Factory

Parameters:

data - payload data

finalFragment - true to create a final frame, false otherwise

Returns:

a new WebSocket frame

Throws:

WebSocketException - if there was an error creating the frame

ping

public WebSocketFrame ping(io.netty.buffer.ByteBuf data)
                    throws WebSocketException

Description copied from interface: WebSocketFrame.Factory

Creates a ping frame with the specified payload data.

Note that a ping frame must have a payload length of 125 bytes or less as defined by RFC 6455 Section 5.5.

Specified by:

ping in interface WebSocketFrame.Factory

Parameters:

data - payload data

Returns:

a new WebSocket frame

Throws:

WebSocketException - if there was an error creating the frame

pong

public WebSocketFrame pong(io.netty.buffer.ByteBuf data)
                    throws WebSocketException

Description copied from interface: WebSocketFrame.Factory

Creates a pong frame with the specified payload data.

Note that a pong frame must have a payload length of 125 bytes or less as defined by RFC 6455 Section 5.5.

Specified by:

pong in interface WebSocketFrame.Factory

Parameters:

data - payload data

Returns:

a new WebSocket frame

Throws:

WebSocketException - if there was an error creating the frame

toUnderlyingWebSocketFrame

public io.netty.handler.codec.http.websocketx.WebSocketFrame toUnderlyingWebSocketFrame(WebSocketFrame webSocketFrame)
                                                                                 throws WebSocketException

Converts the specified webSocketFrame to an underlying WebSocket frame.

Parameters:

webSocketFrame - a WebSocket frame.

Returns:

an underlying Netty frame

Throws:

WebSocketException - if there was an error creating the frame