Package com.linecorp.armeria.server.websocket

Interface WebSocketService

All Superinterfaces:

HttpService, Service<HttpRequest,HttpResponse>, Unwrappable

@UnstableApi
public interface WebSocketService
extends HttpService

An HttpService that supports The WebSocket Protocol. This service has a few different default values for ServiceConfig from a normal HttpService because of the nature of WebSocket. See WebSocketServiceBuilder for more information.

Method Summary

Modifier and Type	Method	Description
static WebSocketServiceBuilder	builder(WebSocketServiceHandler handler)	Returns a new WebSocketServiceBuilder with the WebSocketServiceHandler.
static WebSocketService	of(WebSocketServiceHandler handler)	Returns a new WebSocketService with the WebSocketServiceHandler.
default ServiceOptions	options()	Returns the ServiceOptions of this HttpService.
WebSocketProtocolHandler	protocolHandler()	Returns the WebSocketProtocolHandler of this service.
default HttpResponse	serve(ServiceRequestContext ctx, HttpRequest req)	Serves an incoming Request.
WebSocket	serve(ServiceRequestContext ctx, WebSocket in)	Serves the specified WebSocket and returns the WebSocket to send responses.

Methods inherited from interface com.linecorp.armeria.server.HttpService

decorate, decorate, exchangeType

Methods inherited from interface com.linecorp.armeria.server.Service

as, serviceAdded, shouldCachePath, unwrap

Methods inherited from interface com.linecorp.armeria.common.util.Unwrappable

equalsIgnoreWrapper, unwrapAll

Method Details

of

static WebSocketService of(WebSocketServiceHandler handler)

Returns a new WebSocketService with the WebSocketServiceHandler.

builder

static WebSocketServiceBuilder builder(WebSocketServiceHandler handler)

Returns a new WebSocketServiceBuilder with the WebSocketServiceHandler.

serve

default HttpResponse serve(ServiceRequestContext ctx,
 HttpRequest req)
                    throws Exception

Description copied from interface: Service

Serves an incoming Request.

Specified by:

serve in interface HttpService

Specified by:

serve in interface Service<HttpRequest,HttpResponse>

Parameters:

ctx - the context of the received Request

req - the received Request

Returns:

the Response

Throws:

Exception

serve

WebSocket serve(ServiceRequestContext ctx,
 WebSocket in)
         throws Exception

Serves the specified WebSocket and returns the WebSocket to send responses.

Throws:

Exception

protocolHandler

WebSocketProtocolHandler protocolHandler()

Returns the WebSocketProtocolHandler of this service.

options

default ServiceOptions options()

Description copied from interface: HttpService

Returns the ServiceOptions of this HttpService.

Specified by:

options in interface HttpService