Package burp.api.montoya.websocket.extension

Interface ExtensionWebSocket

public interface ExtensionWebSocket
A WebSocket created via the Extension API.

  • Method Details

    • sendTextMessage

      void sendTextMessage(String message)
      This method allows an extension to send a text message via the WebSocket.
      Parameters:
      message - The message to be sent.

    • sendBinaryMessage

      void sendBinaryMessage(ByteArray message)
      This method allows an extension to send a binary message via the WebSocket.
      Parameters:
      message - The message to be sent.

    • close

      void close()
      This method will close the WebSocket.

    • registerMessageHandler

      Registration registerMessageHandler(ExtensionWebSocketMessageHandler handler)
      Register an interface that is notified when messages arrive from the server.
      Parameters:
      handler - An object created by the extension that implements ExtensionWebSocketMessageHandler interface.
      Returns:
      The Registration for the handler.