org.wso2.transport.http.netty.contractimpl.websocket

Class WebSocketInboundFrameHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

org.wso2.transport.http.netty.contractimpl.websocket.WebSocketInboundFrameHandler

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler

public class WebSocketInboundFrameHandler
extends io.netty.channel.ChannelInboundHandlerAdapter

Abstract WebSocket frame handler for WebSocket server and client.

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

io.netty.channel.ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
WebSocketInboundFrameHandler(boolean isServer, boolean secureConnection, String target, String negotiatedSubProtocol, WebSocketConnectorFuture connectorFuture, WebSocketMessageQueueHandler webSocketMessageQueueHandler)

Method Summary

Modifier and Type	Method and Description
void	channelInactive(io.netty.channel.ChannelHandlerContext ctx)
void	channelRead(io.netty.channel.ChannelHandlerContext ctx, Object msg)
void	exceptionCaught(io.netty.channel.ChannelHandlerContext ctx, Throwable cause)
DefaultWebSocketConnection	getWebSocketConnection() Retrieve the WebSocket connection associated with the frame handler.
void	handlerAdded(io.netty.channel.ChannelHandlerContext ctx)
boolean	isCloseFrameReceived() Check whether a close frame is received without the relevant connection to this Frame handler sending a close frame.
void	setCloseInitialized(boolean closeInitialized)
void	setClosePromise(io.netty.channel.ChannelPromise closePromise) Set channel promise for WebSocket connection close.
void	userEventTriggered(io.netty.channel.ChannelHandlerContext ctx, Object evt)

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerRemoved, isSharable

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.channel.ChannelHandler

handlerRemoved

Constructor Detail

WebSocketInboundFrameHandler

public WebSocketInboundFrameHandler(boolean isServer,
                                    boolean secureConnection,
                                    String target,
                                    String negotiatedSubProtocol,
                                    WebSocketConnectorFuture connectorFuture,
                                    WebSocketMessageQueueHandler webSocketMessageQueueHandler)

Method Detail

setClosePromise

public void setClosePromise(io.netty.channel.ChannelPromise closePromise)

Set channel promise for WebSocket connection close.

Parameters:

closePromise - ChannelPromise to indicate the receiving of close frame echo back from the remote endpoint.

getWebSocketConnection

public DefaultWebSocketConnection getWebSocketConnection()

Retrieve the WebSocket connection associated with the frame handler.

Returns:

the WebSocket connection associated with the frame handler.

isCloseFrameReceived

public boolean isCloseFrameReceived()

Check whether a close frame is received without the relevant connection to this Frame handler sending a close frame.

Returns:

true if a close frame is received without the relevant connection to this Frame handler sending a close frame.

setCloseInitialized

public void setCloseInitialized(boolean closeInitialized)

handlerAdded

public void handlerAdded(io.netty.channel.ChannelHandlerContext ctx)

Specified by:

handlerAdded in interface io.netty.channel.ChannelHandler

Overrides:

handlerAdded in class io.netty.channel.ChannelHandlerAdapter

userEventTriggered

public void userEventTriggered(io.netty.channel.ChannelHandlerContext ctx,
                               Object evt)
                        throws WebSocketConnectorException

Specified by:

userEventTriggered in interface io.netty.channel.ChannelInboundHandler

Overrides:

userEventTriggered in class io.netty.channel.ChannelInboundHandlerAdapter

Throws:

WebSocketConnectorException

channelInactive

public void channelInactive(io.netty.channel.ChannelHandlerContext ctx)
                     throws WebSocketConnectorException

Specified by:

channelInactive in interface io.netty.channel.ChannelInboundHandler

Overrides:

channelInactive in class io.netty.channel.ChannelInboundHandlerAdapter

Throws:

WebSocketConnectorException

channelRead

public void channelRead(io.netty.channel.ChannelHandlerContext ctx,
                        Object msg)
                 throws Exception

Specified by:

channelRead in interface io.netty.channel.ChannelInboundHandler

Overrides:

channelRead in class io.netty.channel.ChannelInboundHandlerAdapter

Throws:

Exception

exceptionCaught

public void exceptionCaught(io.netty.channel.ChannelHandlerContext ctx,
                            Throwable cause)
                     throws WebSocketConnectorException

Specified by:

exceptionCaught in interface io.netty.channel.ChannelHandler

Specified by:

exceptionCaught in interface io.netty.channel.ChannelInboundHandler

Overrides:

exceptionCaught in class io.netty.channel.ChannelInboundHandlerAdapter

Throws:

WebSocketConnectorException