Class WsPanelHandler

Method Details

• register

  public WsFrameHandler register()

  Description copied from interface: WsFrameHandler

  Registers this WsFrameHandler with the WebSocketFrameHandler

  Specified by:

  register in interface WsFrameHandler

  Returns:

• getAuthHandler

  public WsAuthenticationHandler getAuthHandler()

  Description copied from interface: WsFrameHandler

  Gets the WsAuthenticationHandler assigned to this endpoint

  Specified by:

  getAuthHandler in interface WsFrameHandler

  Returns:

  An WsAuthenticationHandler

• handleFrame

  public void handleFrame(ChannelHandlerContext ctx, WebSocketFrame frame)

  Description copied from interface: WsFrameHandler

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

  Specified by:

  handleFrame in interface WsFrameHandler

  Parameters:

  ctx - The ChannelHandlerContext of the session

  frame - The WebSocketFrame to process

• handleDBQuery

  public void handleDBQuery(ChannelHandlerContext ctx, WebSocketFrame frame, JSONObject jso)

• handleDBKeysQuery

  public void handleDBKeysQuery(ChannelHandlerContext ctx, WebSocketFrame frame, JSONObject jso)

• handleDBKeysListQuery

  public void handleDBKeysListQuery(ChannelHandlerContext ctx, WebSocketFrame frame, JSONObject jso)

• handleDBKeysByOrderQuery

  public void handleDBKeysByOrderQuery(ChannelHandlerContext ctx, WebSocketFrame frame, JSONObject jso)

• handleDBValuesByOrderQuery

  public void handleDBValuesByOrderQuery(ChannelHandlerContext ctx, WebSocketFrame frame, JSONObject jso)

• handleDBKeysSearchQuery

  public void handleDBKeysSearchQuery(ChannelHandlerContext ctx, WebSocketFrame frame, JSONObject jso)

• sendJSONToAll

  public void sendJSONToAll(String jsonString)

• doAudioHooksUpdate

  public void doAudioHooksUpdate()

• panelNotification

  public void panelNotification(String type, String message)

• panelNotification

  public void panelNotification(String type, String message, String title)

• panelNotification

  public void panelNotification(String type, String message, String title, Integer timeout)

• panelNotification

  public void panelNotification(String type, String message, String title, Integer timeout, Integer extendedTimeout)

• panelNotification

  public void panelNotification(String type, String message, String title, Integer timeout, Integer extendedTimeout, Boolean progressBar)

• panelNotification

  public void panelNotification(ChannelHandlerContext ctx, String type, String message, String title, Integer timeout, Integer extendedTimeout, Boolean progressBar)

  Sends a toastr notification to the panel The notification is sent to all currently authenticated users on the panel if the parameter ctx is null

  Parameters:

  ctx - The ChannelHandlerContext

  type - The type of notification to show. Valid values: success, error, warning, info. Invalid values are treated as info

  message - The message content of the notification

  title - The title of the notification. null or empty string for no title

  timeout - The timeout before the notification automatically closes. null for default; 0 to not close until the X is clicked

  extendedTimeout - The timeout before the notification automatically closes, if the user hover over it with their mouse. This should be longer than timeout because the timer is shared. null for default; 0 to not close until the X is clicked

  progressBar - true to show a progress bar indicating the time remaining in timeout until the notification closes automatically; false to explicitly disable the progress bar on this notification; null for default

• sendAck

  public void sendAck(String uniqueID)

  Sends an ack response to a WS query

  Parameters:

  uniqueID - The ID the callback is registered under, sent by the requester

• sendObject

  public void sendObject(String uniqueID, Map<String,Object> obj)

  Sends an object response to a WS query

  Parameters:

  uniqueID - The ID the callback is registered under, sent by the requester

  obj - A map of key/value pairs to send

• sendArray

  public void sendArray(String uniqueID, List<Object> obj)

  Sends an array response to a WS query

  Parameters:

  uniqueID - The ID the callback is registered under, sent by the requester

  obj - A list of values to send

• hashCode

  public int hashCode()

  Overrides:

  hashCode in class Object

• equals

  public boolean equals(Object obj)

  Overrides:

  equals in class Object