Package ratpack.handling.direct

Interface DirectChannelAccess

  • public interface DirectChannelAccess
    Provides direct access to the underlying Netty Channel.

    Use of this type is discouraged. It exists to provide low level integration with Netty for extra protocols to build on, such as the WebSockets support.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      io.netty.channel.Channel getChannel()
      The channel.
      void takeOwnership​(ratpack.func.Action<java.lang.Object> messageReceiver)
      Signals that Ratpack should no longer manage this channel.

    • Method Detail

      • getChannel

        io.netty.channel.Channel getChannel()
        The channel.
        Returns:
        The backing Netty channel for the request.

      • takeOwnership

        void takeOwnership​(ratpack.func.Action<java.lang.Object> messageReceiver)
        Signals that Ratpack should no longer manage this channel.

        All future messages received over the channel will be given to the provided action. It is the caller of this method's responsibility for closing the channel after it is finished.

        Parameters:
        messageReceiver - the responder to channel messages.