Package org.apache.wicket.protocol.ws.api

Interface IWebSocketRequestHandler

  • All Superinterfaces:
    org.apache.wicket.request.ILoggableRequestHandler, org.apache.wicket.core.request.handler.IPageClassRequestHandler, org.apache.wicket.core.request.handler.IPageRequestHandler, org.apache.wicket.core.request.handler.IPartialPageRequestHandler, org.apache.wicket.request.IRequestHandler
    All Known Implementing Classes:
    WebSocketRequestHandler
    public interface IWebSocketRequestHandler
extends org.apache.wicket.core.request.handler.IPartialPageRequestHandler, org.apache.wicket.request.ILoggableRequestHandler
    An interface for outbound communication with web socket clients
    Since:
    6.0

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void push​(byte[] message, int offset, int length)
      Pushes a binary message to the client.
      void push​(java.lang.CharSequence message)
      Pushes a text message to the client.

      • Methods inherited from interface org.apache.wicket.request.ILoggableRequestHandler

        getLogData

      • Methods inherited from interface org.apache.wicket.core.request.handler.IPageClassRequestHandler

        getPageClass, getPageParameters

      • Methods inherited from interface org.apache.wicket.core.request.handler.IPageRequestHandler

        getPage, getPageId, getRenderCount, isPageInstanceCreated

      • Methods inherited from interface org.apache.wicket.core.request.handler.IPartialPageRequestHandler

        add, add, addChildren, appendJavaScript, focusComponent, getComponents, getHeaderResponse, prependJavaScript

      • Methods inherited from interface org.apache.wicket.request.IRequestHandler

        detach, respond

    • Method Detail

      • push

        void push​(java.lang.CharSequence message)
        Pushes a text message to the client.
        Parameters:
        message - the text message to push to the client if the web socket connection is open

      • push

        void push​(byte[] message,
          int offset,
          int length)
        Pushes a binary message to the client.
        Parameters:
        message - the binary message to push to the client if the web socket connection is open
        offset - the offset to start to read from the message
        length - how many bytes to read from the message