bayou.websocket

Class WebSocketResponse.Accept

java.lang.Object

bayou.websocket.WebSocketResponse

bayou.websocket.WebSocketResponse.Accept

All Implemented Interfaces:

Async<WebSocketResponse>, AutoAsync<WebSocketResponse>

Enclosing class:

WebSocketResponse

public static class WebSocketResponse.Accept
extends WebSocketResponse
implements AutoAsync<WebSocketResponse>

To accept the handshake.

The Accept response contains a channelHandler that will operate on the WebSocket channel created after handshake.

Note that this class is a subtype of Async<WebSocketResponse>.

See Also:

WebSocketResponse.accept(bayou.util.function.FunctionX)

Nested Class Summary

Nested classes/interfaces inherited from class bayou.websocket.WebSocketResponse

WebSocketResponse.Accept, WebSocketResponse.Reject

Constructor Summary

Constructors

Constructor and Description
Accept(String subprotocol, FunctionX<WebSocketChannel,Async<?>> channelHandler) Create an Accept response.

Method Summary

Instance Methods
FunctionX<WebSocketChannel,Async<?>>	getChannelHandler() The channelHandler.
String	getSubprotocol() The subprotocol selected.

Methods inherited from class bayou.websocket.WebSocketResponse

accept, reject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface bayou.async.AutoAsync

cancel, isCompleted, onCompletion, pollResult, timeout

Methods inherited from interface bayou.async.Async

catch__, catch_, covary, finally_, finally_, map, map, peek, peek, sync, then, then, transform

Constructor Detail

Accept

public Accept(String subprotocol,
              FunctionX<WebSocketChannel,Async<?>> channelHandler)

Create an Accept response.

Method Detail

getChannelHandler

public FunctionX<WebSocketChannel,Async<?>> getChannelHandler()

The channelHandler.

After a WebSocket handshake is accepted, the server creates a WebSocketChannel and feed it to this channelHandler.

The channelHandler is invoked in a Fiber created for the channel. The Fiber completes when the Async<?> returned by the channelHandler completes.

getSubprotocol

public String getSubprotocol()

The subprotocol selected.

If non-null, it must be one of the subprotocols presented in the handshake request.