WsFrameHandler (PhantomBot JavaDoc)

All Known Implementing Classes:: WsAlertsPollsHandler, WsPanelHandler, WsPanelRemoteLoginHandler, WsYTHandler

public interface WsFrameHandler

Represents a handler for WebSocket frames

Author:: gmt2001

Method Summary

Modifier and Type

Method

Description

WsAuthenticationHandler

getAuthHandler()

Gets the WsAuthenticationHandler assigned to this endpoint

void

handleFrame(ChannelHandlerContext ctx, WebSocketFrame frame)

Handles the WebSocket frame and sends a response back to the client, if necessary Only gets called if the WsAuthenticationHandler returned true

WsFrameHandler

register()

Registers this WsFrameHandler with the WebSocketFrameHandler

Method Details
- register
  
  WsFrameHandler register()
  
  Registers this WsFrameHandler with the WebSocketFrameHandler
  
  Returns:
- getAuthHandler
  
  WsAuthenticationHandler getAuthHandler()
  
  Gets the WsAuthenticationHandler assigned to this endpoint
  
  Returns:
  
  An WsAuthenticationHandler
- handleFrame
  
  void handleFrame(ChannelHandlerContext ctx, WebSocketFrame frame)
  
  Handles the WebSocket frame and sends a response back to the client, if necessary Only gets called if the WsAuthenticationHandler returned true
  
  Parameters:
  
  ctx - The ChannelHandlerContext of the session
  
  frame - The WebSocketFrame to process