Package com.linecorp.armeria.server.websocket

Interface WebSocketProtocolHandler

@UnstableApi
public interface WebSocketProtocolHandler

A WebSocket protocol handler for WebSocketService.

Method Summary

Modifier and Type	Method	Description
WebSocket	decode(ServiceRequestContext ctx, HttpRequest req)	Decodes the specified HttpRequest to a WebSocket.
HttpResponse	encode(ServiceRequestContext ctx, WebSocket out)	Encodes the specified WebSocket to an HttpResponse.
WebSocketUpgradeResult	upgrade(ServiceRequestContext ctx, HttpRequest req)	Upgrades the given HttpRequest to a WebSocket.

Method Details

upgrade

WebSocketUpgradeResult upgrade(ServiceRequestContext ctx,
 HttpRequest req)
                        throws Exception

Upgrades the given HttpRequest to a WebSocket.

If the upgrade succeeds, WebSocketUpgradeResult.ofSuccess() is returned. If the upgrade fails, WebSocketUpgradeResult.ofFailure(HttpResponse) is returned.

Throws:

Exception

decode

WebSocket decode(ServiceRequestContext ctx,
 HttpRequest req)

Decodes the specified HttpRequest to a WebSocket.

encode

HttpResponse encode(ServiceRequestContext ctx,
 WebSocket out)

Encodes the specified WebSocket to an HttpResponse.