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

Class NettyServerWebSocketHandler

  • All Implemented Interfaces:
    io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler
    @Internal
public class NettyServerWebSocketHandler
extends io.micronaut.http.netty.websocket.AbstractNettyWebSocketHandler
    A handler for WebSocketFrame instances.
    Since:
    1.0

    • 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 java.lang.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

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean acceptInboundMessage​(java.lang.Object msg)  
      protected io.micronaut.http.netty.websocket.NettyWebSocketSession createWebSocketSession​(io.netty.channel.ChannelHandlerContext ctx)  
      void handlerRemoved​(io.netty.channel.ChannelHandlerContext ctx)  
      protected org.reactivestreams.Publisher<?> instrumentPublisher​(io.netty.channel.ChannelHandlerContext ctx, java.lang.Object result)  
      protected java.lang.Object invokeExecutable​(io.micronaut.core.bind.BoundExecutable boundExecutable, io.micronaut.inject.MethodExecutionHandle<?,​?> messageHandler)  
      protected void messageHandled​(io.netty.channel.ChannelHandlerContext ctx, io.micronaut.http.netty.websocket.NettyWebSocketSession session, java.lang.Object message)  
      void userEventTriggered​(io.netty.channel.ChannelHandlerContext ctx, java.lang.Object evt)  

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

        callOpenMethod, channelRead0, exceptionCaught, getBodyArgument, getPongArgument, getSession, 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 Detail

      • ID

        public static final java.lang.String ID
        The id of the handler used when adding it to the Netty pipeline.
        See Also:
        Constant Field Values

    • Method Detail

      • userEventTriggered

        public void userEventTriggered​(io.netty.channel.ChannelHandlerContext ctx,
                               java.lang.Object evt)
                        throws java.lang.Exception
        Specified by:
        userEventTriggered in interface io.netty.channel.ChannelInboundHandler
        Overrides:
        userEventTriggered in class io.netty.channel.ChannelInboundHandlerAdapter
        Throws:
        java.lang.Exception

      • acceptInboundMessage

        public boolean acceptInboundMessage​(java.lang.Object msg)
        Overrides:
        acceptInboundMessage in class io.netty.channel.SimpleChannelInboundHandler<java.lang.Object>

      • createWebSocketSession

        protected io.micronaut.http.netty.websocket.NettyWebSocketSession createWebSocketSession​(io.netty.channel.ChannelHandlerContext ctx)
        Specified by:
        createWebSocketSession in class io.micronaut.http.netty.websocket.AbstractNettyWebSocketHandler

      • instrumentPublisher

        protected org.reactivestreams.Publisher<?> instrumentPublisher​(io.netty.channel.ChannelHandlerContext ctx,
                                                               java.lang.Object result)
        Overrides:
        instrumentPublisher in class io.micronaut.http.netty.websocket.AbstractNettyWebSocketHandler

      • invokeExecutable

        protected java.lang.Object invokeExecutable​(io.micronaut.core.bind.BoundExecutable boundExecutable,
                                            io.micronaut.inject.MethodExecutionHandle<?,​?> messageHandler)
        Overrides:
        invokeExecutable in class io.micronaut.http.netty.websocket.AbstractNettyWebSocketHandler

      • messageHandled

        protected void messageHandled​(io.netty.channel.ChannelHandlerContext ctx,
                              io.micronaut.http.netty.websocket.NettyWebSocketSession session,
                              java.lang.Object message)
        Overrides:
        messageHandled in class io.micronaut.http.netty.websocket.AbstractNettyWebSocketHandler

      • handlerRemoved

        public void handlerRemoved​(io.netty.channel.ChannelHandlerContext ctx)
                    throws java.lang.Exception
        Specified by:
        handlerRemoved in interface io.netty.channel.ChannelHandler
        Overrides:
        handlerRemoved in class io.micronaut.http.netty.websocket.AbstractNettyWebSocketHandler
        Throws:
        java.lang.Exception