Package burp.api.montoya.proxy
Interface ProxyWebSocket
-
public interface ProxyWebSocketThis interface represents a ProxyWebSocket within Burp.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidclose()This method will close the WebSocket.RegistrationregisterHandler(ProxyWebSocketHandler handler)This method is used to register a handler which will perform actions when messages are sent or received by the WebSocket.voidsendTextMessage(java.lang.String message, Direction direction)This method allows an extension to send a text message via the WebSocket to either the client or the server.
-
-
-
Method Detail
-
sendTextMessage
void sendTextMessage(java.lang.String message, Direction direction)This method allows an extension to send a text message via the WebSocket to either the client or the server.- Parameters:
message- The message to be sent.direction- The direction of the message.
-
close
void close()
This method will close the WebSocket.
-
registerHandler
Registration registerHandler(ProxyWebSocketHandler handler)
This method is used to 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 implementsProxyWebSocketHandlerinterface.- Returns:
- The
Registrationfor the handler.
-
-