Package io.gravitee.gateway.api.ws
Interface WebSocket
-
public interface WebSocketRepresents a server-side WebSocket request.- Author:
- David BRASSELY (david.brassely at graviteesource.com), GraviteeSource Team
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description WebSocketclose()WebSocketcloseHandler(Handler<Void> closeHandler)WebSocketframeHandler(Handler<WebSocketFrame> frameHandler)WebSocketreject(int statusCode)WS connection has been rejected by upstream.CompletableFuture<WebSocket>upgrade()Upgrade the HTTP request to a WS connectionbooleanupgraded()WebSocketwrite(WebSocketFrame frame)
-
-
-
Method Detail
-
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)
-
upgraded
boolean upgraded()
-
-