org.opendaylight.yangtools.websocket.client

Class WebSocketClientHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.SimpleChannelInboundHandler<Object>

org.opendaylight.yangtools.websocket.client.WebSocketClientHandler

All Implemented Interfaces:

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

public class WebSocketClientHandler
extends io.netty.channel.SimpleChannelInboundHandler<Object>

WebSocketClientHandler is implementation of SimpleChannelInboundHandler which handle TextWebSocketFrame, PongWebSocketFrame and CloseWebSocketFrame messages.

Nested Class Summary

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

io.netty.channel.ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
WebSocketClientHandler(io.netty.handler.codec.http.websocketx.WebSocketClientHandshaker handshaker, ClientMessageCallback listener) Create new Web Socket Client Handler.

Method Summary

Methods

Modifier and Type	Method and Description
void	channelActive(io.netty.channel.ChannelHandlerContext ctx)
void	channelInactive(io.netty.channel.ChannelHandlerContext ctx)
void	channelRead0(io.netty.channel.ChannelHandlerContext ctx, Object msg)
void	exceptionCaught(io.netty.channel.ChannelHandlerContext ctx, Throwable cause)
void	handlerAdded(io.netty.channel.ChannelHandlerContext ctx)
io.netty.channel.ChannelFuture	handshakeFuture() Notifies by Future when handshake process succeeds or fails.

Methods inherited from class io.netty.channel.SimpleChannelInboundHandler

acceptInboundMessage, channelRead

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

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

WebSocketClientHandler

public WebSocketClientHandler(io.netty.handler.codec.http.websocketx.WebSocketClientHandshaker handshaker,
                      ClientMessageCallback listener)

Create new Web Socket Client Handler.

Parameters:

handshaker - manages handshake process

listener -

Method Detail

handshakeFuture

public io.netty.channel.ChannelFuture handshakeFuture()

Notifies by Future when handshake process succeeds or fails.

Returns:

information about the completation of the handshake

handlerAdded

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

Specified by:

handlerAdded in interface io.netty.channel.ChannelHandler

Overrides:

handlerAdded in class io.netty.channel.ChannelHandlerAdapter

Throws:

Exception

channelActive

public void channelActive(io.netty.channel.ChannelHandlerContext ctx)
                   throws Exception

Specified by:

channelActive in interface io.netty.channel.ChannelInboundHandler

Overrides:

channelActive in class io.netty.channel.ChannelInboundHandlerAdapter

Throws:

Exception

channelInactive

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

Specified by:

channelInactive in interface io.netty.channel.ChannelInboundHandler

Overrides:

channelInactive in class io.netty.channel.ChannelInboundHandlerAdapter

Throws:

Exception

channelRead0

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

Specified by:

channelRead0 in class io.netty.channel.SimpleChannelInboundHandler<Object>

Throws:

Exception

exceptionCaught

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

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:

Exception