Package io.micronaut.http.server.netty.websocket

Class NettyServerWebSocketHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.SimpleChannelInboundHandler<Object>

io.micronaut.http.netty.websocket.AbstractNettyWebSocketHandler

io.micronaut.http.server.netty.websocket.NettyServerWebSocketHandler

All Implemented Interfaces:

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

@Internal
public class NettyServerWebSocketHandler
extends AbstractNettyWebSocketHandler

A handler for WebSocketFrame instances.

Since:

1.0

Author:

graemerocher

Nested Class Summary

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

io.netty.channel.ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ID	The id of the handler used when adding it to the Netty pipeline.

Fields inherited from class io.micronaut.http.netty.websocket.AbstractNettyWebSocketHandler

conversionService, LOG, mediaTypeCodecRegistry, messageHandler, originatingRequest, pongHandler, subProtocol, uriVariables, webSocketBean, webSocketBinder, webSocketSessionRepository, webSocketVersion

Method Summary

Modifier and Type	Method	Description
boolean	acceptInboundMessage(Object msg)
protected NettyWebSocketSession	createWebSocketSession(io.netty.channel.ChannelHandlerContext ctx)	Subclasses should implement to create the actual NettyWebSocketSession.
Argument<?>	getBodyArgument()
Argument<?>	getPongArgument()
NettyWebSocketSession	getSession()
void	handlerRemoved(io.netty.channel.ChannelHandlerContext ctx)
protected Publisher<?>	instrumentPublisher(io.netty.channel.ChannelHandlerContext ctx, Object result)	Subclasses can override to customize publishers returned from message handlers.
protected Object	invokeExecutable(BoundExecutable boundExecutable, MethodExecutionHandle<?,?> messageHandler)	Invokes the given executable.
protected void	messageHandled(io.netty.channel.ChannelHandlerContext ctx, Object message)	Method called once a message has been handled by the handler.
void	userEventTriggered(io.netty.channel.ChannelHandlerContext ctx, Object evt)

Methods inherited from class io.micronaut.http.netty.websocket.AbstractNettyWebSocketHandler

callOpenMethod, channelRead0, exceptionCaught, forwardErrorToUser, handleCloseReason, handleWebSocketFrame, writeCloseFrameAndTerminate

Methods inherited from class io.netty.channel.SimpleChannelInboundHandler

channelRead

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, 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

handlerAdded

Field Details

ID

public static final String ID

The id of the handler used when adding it to the Netty pipeline.

See Also:

• Constant Field Values

Method Details

getSession

public NettyWebSocketSession getSession()

Specified by:

getSession in class AbstractNettyWebSocketHandler

Returns:

The session

getBodyArgument

public Argument<?> getBodyArgument()

Specified by:

getBodyArgument in class AbstractNettyWebSocketHandler

Returns:

The body argument for the message handler

getPongArgument

public Argument<?> getPongArgument()

Specified by:

getPongArgument in class AbstractNettyWebSocketHandler

Returns:

The pong argument for the pong handler

userEventTriggered

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

Specified by:

userEventTriggered in interface io.netty.channel.ChannelInboundHandler

Overrides:

userEventTriggered in class io.netty.channel.ChannelInboundHandlerAdapter

Throws:

Exception

acceptInboundMessage

public boolean acceptInboundMessage(Object msg)

Overrides:

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

createWebSocketSession

protected NettyWebSocketSession createWebSocketSession(io.netty.channel.ChannelHandlerContext ctx)

Description copied from class: AbstractNettyWebSocketHandler

Subclasses should implement to create the actual NettyWebSocketSession.

Specified by:

createWebSocketSession in class AbstractNettyWebSocketHandler

Parameters:

ctx - The context

Returns:

The session

instrumentPublisher

protected Publisher<?> instrumentPublisher(io.netty.channel.ChannelHandlerContext ctx,
 Object result)

Description copied from class: AbstractNettyWebSocketHandler

Subclasses can override to customize publishers returned from message handlers.

Overrides:

instrumentPublisher in class AbstractNettyWebSocketHandler

Parameters:

ctx - The context

result - The result

Returns:

The flowable

invokeExecutable

protected Object invokeExecutable(BoundExecutable boundExecutable,
 MethodExecutionHandle<?,?> messageHandler)

Description copied from class: AbstractNettyWebSocketHandler

Invokes the given executable.

Overrides:

invokeExecutable in class AbstractNettyWebSocketHandler

Parameters:

boundExecutable - The bound executable

messageHandler - The message handler

Returns:

The result

messageHandled

protected void messageHandled(io.netty.channel.ChannelHandlerContext ctx,
 Object message)

Description copied from class: AbstractNettyWebSocketHandler

Method called once a message has been handled by the handler.

Overrides:

messageHandled in class AbstractNettyWebSocketHandler

Parameters:

ctx - The channel handler context

message - The message that was handled

handlerRemoved

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

Specified by:

handlerRemoved in interface io.netty.channel.ChannelHandler

Overrides:

handlerRemoved in class AbstractNettyWebSocketHandler

Throws:

Exception