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 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 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 io.micronaut.http.netty.websocket.NettyWebSocketSession
    createWebSocketSession(io.netty.channel.ChannelHandlerContext ctx)
     
    io.micronaut.core.type.Argument<?>
    getBodyArgument()
     
    io.micronaut.core.type.Argument<?>
    getPongArgument()
     
    io.micronaut.http.netty.websocket.NettyWebSocketSession
    getSession()
     
    void
    handlerRemoved(io.netty.channel.ChannelHandlerContext ctx)
     
    protected org.reactivestreams.Publisher<?>
    instrumentPublisher(io.netty.channel.ChannelHandlerContext ctx, Object result)
     
    protected Object
    invokeExecutable(io.micronaut.core.bind.BoundExecutable boundExecutable, io.micronaut.inject.MethodExecutionHandle<?,?> messageHandler)
     
    protected void
    messageHandled(io.netty.channel.ChannelHandlerContext ctx, Object message)
     
    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

  • Method Details

    • getSession

      public io.micronaut.http.netty.websocket.NettyWebSocketSession getSession()
      Specified by:
      getSession in class io.micronaut.http.netty.websocket.AbstractNettyWebSocketHandler

    • getBodyArgument

      public io.micronaut.core.type.Argument<?> getBodyArgument()
      Specified by:
      getBodyArgument in class io.micronaut.http.netty.websocket.AbstractNettyWebSocketHandler

    • getPongArgument

      public io.micronaut.core.type.Argument<?> getPongArgument()
      Specified by:
      getPongArgument in class io.micronaut.http.netty.websocket.AbstractNettyWebSocketHandler

    • 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 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, Object result)
      Overrides:
      instrumentPublisher in class io.micronaut.http.netty.websocket.AbstractNettyWebSocketHandler

    • invokeExecutable

      protected 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, Object message)
      Overrides:
      messageHandled in class io.micronaut.http.netty.websocket.AbstractNettyWebSocketHandler

    • handlerRemoved

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