Module io.helidon.nima.websocket.webserver

Package io.helidon.nima.websocket.webserver

Class WsConnection

java.lang.Object

io.helidon.nima.websocket.webserver.WsConnection

All Implemented Interfaces:

ServerConnection, WsSession

public class WsConnection
extends Object
implements ServerConnection, WsSession

WebSocket connection, server side session implementation.

Method Summary

Modifier and Type	Method	Description
WsSession	close(int code, String reason)	Close session.
static WsConnection	create(ConnectionContext ctx, HttpPrologue prologue, Headers upgradeHeaders, String wsKey, WsRoute wsRoute)	Create a new connection.
void	handle()	Start handling the connection.
WsSession	ping(BufferData bufferData)	Send ping.
WsSession	pong(BufferData bufferData)	Send pong.
WsSession	send(BufferData bufferData, boolean last)	Send binary fragment.
WsSession	send(String text, boolean last)	Send text fragment.
Optional<String>	subProtocol()	The WebSocket sub-protocol negotiated for this session.
WsSession	terminate()	Terminate session.

Methods inherited from class java.lang.Object

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

Method Details

create

public static WsConnection create(ConnectionContext ctx,
 HttpPrologue prologue,
 Headers upgradeHeaders,
 String wsKey,
 WsRoute wsRoute)

Create a new connection.

Parameters:

ctx - server connection context

prologue - prologue of this request

upgradeHeaders - headers for

wsKey - ws key

wsRoute - route to use

Returns:

a new connection

handle

public void handle()

Description copied from interface: ServerConnection

Start handling the connection. Data is provided through ServerConnectionSelector.connection(io.helidon.nima.webserver.ConnectionContext).

Specified by:

handle in interface ServerConnection

send

public WsSession send(String text,
 boolean last)

Description copied from interface: WsSession

Send text fragment.

Specified by:

send in interface WsSession

Parameters:

text - text to send

last - if last fragment

Returns:

this instance

send

public WsSession send(BufferData bufferData,
 boolean last)

Description copied from interface: WsSession

Send binary fragment.

Specified by:

send in interface WsSession

Parameters:

bufferData - buffer with data

last - if last fragment

Returns:

this instance

ping

public WsSession ping(BufferData bufferData)

Description copied from interface: WsSession

Send ping.

Specified by:

ping in interface WsSession

Parameters:

bufferData - buffer with data

Returns:

this instance

pong

public WsSession pong(BufferData bufferData)

Description copied from interface: WsSession

Send pong.

Specified by:

pong in interface WsSession

Parameters:

bufferData - buffer with data

Returns:

this instance

close

public WsSession close(int code,
 String reason)

Description copied from interface: WsSession

Close session.

Specified by:

close in interface WsSession

Parameters:

code - close code, may be one of WsCloseCodes

reason - reason description

Returns:

this instance

terminate

public WsSession terminate()

Description copied from interface: WsSession

Terminate session. Sends a close and closes the connection.

Specified by:

terminate in interface WsSession

Returns:

this instance

subProtocol

public Optional<String> subProtocol()

Description copied from interface: WsSession

The WebSocket sub-protocol negotiated for this session.

Specified by:

subProtocol in interface WsSession

Returns:

sub-protocol negotiated, if any