Package com.mastfrog.acteur.websocket

Interface OnWebsocketConnect

public interface OnWebsocketConnect
Global interface called when a websocket connection has been successfully handshaken via WebSocketUpgradeActeur. If you need other objects from the current event, simply inject them and do not bind as a singleton.

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    connected(HttpEvent evt, io.netty.channel.Channel channel)
    Called on connection success.

  • Method Details

    • connected

      Object connected(HttpEvent evt, io.netty.channel.Channel channel)
      Called on connection success. May return an object or array of objects to include in the scope for acteurs which receive ongoing web socket events.
      Parameters:
      evt - The event
      channel - The channel, which can be used for future communication with the client initiating the websocket.
      Returns:
      An object or array of objects which should be included in the scope for injection into acteurs that follow the one which initiates the websocket. Return null if you have noting to add into the request scope.