Package burp.api.montoya.websocket

Interface WebSocket

public interface WebSocket
WebSocket within Burp.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
    This method will close the WebSocket.
    Registration
    registerMessageHandler(MessageHandler handler)
    Register a handler which will perform an action when a message is sent to or received from the application.
    void
    sendBinaryMessage(ByteArray message)
    This method allows an extension to send a binary message via the WebSocket.
    void
    sendTextMessage(String message)
    This method allows an extension to send a text message via the WebSocket.

  • 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(MessageHandler handler)
      Register a handler which will perform an action when a message is sent to or received from the application.
      Parameters:
      handler - An object created by the extension that implements MessageHandler interface.
      Returns:
      The Registration for the handler.