io.scalecube.gateway.websocket

Class WebsocketSession

java.lang.Object

io.scalecube.gateway.websocket.WebsocketSession

public final class WebsocketSession
extends Object

Constructor Summary

Constructors

Constructor and Description
WebsocketSession(GatewayMessageCodec messageCodec, reactor.netty.http.server.HttpServerRequest httpRequest, reactor.netty.http.websocket.WebsocketInbound inbound, reactor.netty.http.websocket.WebsocketOutbound outbound) Create a new websocket session with given handshake, inbound and outbound channels.

Method Summary

Modifier and Type	Method and Description
reactor.core.publisher.Mono<Void>	close() Close the websocket session with normal status.
boolean	containsSid(Long streamId)
String	contentType()
boolean	dispose(Long streamId) Disposing stored subscription by given stream id.
String	id()
reactor.core.publisher.Mono<Void>	onClose(reactor.core.Disposable disposable) Lambda setter for reacting on channel close occurence.
reactor.core.publisher.Flux<io.netty.buffer.ByteBuf>	receive() Method for receiving request messages coming a form of websocket frames.
boolean	register(Long streamId, reactor.core.Disposable disposable) Saves (if not already saved) by stream id a subscrption of service call coming in form of Disposable reference.
reactor.core.publisher.Mono<Void>	send(GatewayMessage response) Method to send normal response.
reactor.core.publisher.Mono<Void>	send(Throwable err, Long sid) Method to send error response.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

WebsocketSession

public WebsocketSession(GatewayMessageCodec messageCodec,
                        reactor.netty.http.server.HttpServerRequest httpRequest,
                        reactor.netty.http.websocket.WebsocketInbound inbound,
                        reactor.netty.http.websocket.WebsocketOutbound outbound)

Create a new websocket session with given handshake, inbound and outbound channels.

Parameters:

messageCodec - - msg codec

httpRequest - - Init session HTTP request

inbound - - Websocket inbound

outbound - - Websocket outbound

Method Detail

id

public String id()

contentType

public String contentType()

receive

public reactor.core.publisher.Flux<io.netty.buffer.ByteBuf> receive()

Method for receiving request messages coming a form of websocket frames.

Returns:

flux websocket ByteBuf

send

public reactor.core.publisher.Mono<Void> send(GatewayMessage response)

Method to send normal response.

Parameters:

response - response

Returns:

mono void

send

public reactor.core.publisher.Mono<Void> send(Throwable err,
                                              Long sid)

Method to send error response.

Parameters:

err - error

sid - stream id; optional

Returns:

mono void

close

public reactor.core.publisher.Mono<Void> close()

Close the websocket session with normal status. Defined Status Codes: 1000 indicates a normal closure, meaning that the purpose for which the connection was established has been fulfilled.

Returns:

mono void

onClose

public reactor.core.publisher.Mono<Void> onClose(reactor.core.Disposable disposable)

Lambda setter for reacting on channel close occurence.

Parameters:

disposable - function to run when disposable would take place

dispose

public boolean dispose(Long streamId)

Disposing stored subscription by given stream id.

Parameters:

streamId - stream id

Returns:

true of subscription was disposed

containsSid

public boolean containsSid(Long streamId)

register

public boolean register(Long streamId,
                        reactor.core.Disposable disposable)

Saves (if not already saved) by stream id a subscrption of service call coming in form of Disposable reference.

Parameters:

streamId - stream id

disposable - service subscrption

Returns:

true if disposable subscrption was stored

toString

public String toString()

Overrides:

toString in class Object