Package burp.api.montoya.proxy.websocket

Interface ProxyWebSocket

public interface ProxyWebSocket

ProxyWebSocket within Burp.

Method Summary

Modifier and Type	Method	Description
void	close()	This method will close the WebSocket.
Registration	registerProxyMessageHandler(ProxyMessageHandler handler)	Register a handler which will perform actions when messages are sent or received by the WebSocket.
void	sendBinaryMessage(ByteArray binaryMessage, Direction direction)	This method allows an extension to send a binary message via the WebSocket to either the client or the server.
void	sendTextMessage(String textMessage, Direction direction)	This method allows an extension to send a text message via the WebSocket to either the client or the server.

Method Details

sendTextMessage

void sendTextMessage(String textMessage,
 Direction direction)

This method allows an extension to send a text message via the WebSocket to either the client or the server.

Parameters:

textMessage - The message to be sent.

direction - The direction of the message.

sendBinaryMessage

void sendBinaryMessage(ByteArray binaryMessage,
 Direction direction)

This method allows an extension to send a binary message via the WebSocket to either the client or the server.

Parameters:

binaryMessage - The message to be sent.

direction - The direction of the message.

close

void close()

This method will close the WebSocket.

registerProxyMessageHandler

Registration registerProxyMessageHandler(ProxyMessageHandler handler)

Register a handler which will perform actions when messages are sent or received by the WebSocket.

Parameters:

handler - An object created by the extension that implements ProxyMessageHandler interface.

Returns:

The Registration for the handler.