Package io.gravitee.gateway.api.ws

Interface WebSocket

public interface WebSocket

Represents a server-side WebSocket request.

Author:

David BRASSELY (david.brassely at graviteesource.com), GraviteeSource Team

Method Summary

Modifier and Type	Method	Description
WebSocket	close()
WebSocket	closeHandler(Handler<Void> closeHandler)
WebSocket	frameHandler(Handler<WebSocketFrame> frameHandler)
WebSocket	reject(int statusCode)	WS connection has been rejected by upstream.
CompletableFuture<WebSocket>	upgrade()	Upgrade the HTTP request to a WS connection
boolean	upgraded()
WebSocket	write(WebSocketFrame frame)

Method Details

upgrade

CompletableFuture<WebSocket> upgrade()

Upgrade the HTTP request to a WS connection

Returns:

reject

WebSocket reject(int statusCode)

WS connection has been rejected by upstream.

Parameters:

statusCode -

Returns:

write

WebSocket write(WebSocketFrame frame)

close

WebSocket close()

frameHandler

WebSocket frameHandler(Handler<WebSocketFrame> frameHandler)

closeHandler

WebSocket closeHandler(Handler<Void> closeHandler)

upgraded

boolean upgraded()