Module io.helidon.webserver.websocket

Package io.helidon.webserver.websocket

Class WsConnection

java.lang.Object

io.helidon.webserver.websocket.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
void	close(boolean interrupt)
WsSession	close(int code, String reason)
static WsConnection	create(ConnectionContext ctx, io.helidon.http.HttpPrologue prologue, io.helidon.http.Headers upgradeHeaders, String wsKey, WsRoute wsRoute)	Create a new connection using a route.
static WsConnection	create(ConnectionContext ctx, io.helidon.http.HttpPrologue prologue, io.helidon.http.Headers upgradeHeaders, String wsKey, WsListener wsListener)	Create a new connection using a listener.
void	handle(Semaphore requestSemaphore)
Duration	idleTime()
WsSession	ping(io.helidon.common.buffers.BufferData bufferData)
WsSession	pong(io.helidon.common.buffers.BufferData bufferData)
WsSession	send(io.helidon.common.buffers.BufferData bufferData, boolean last)
WsSession	send(String text, boolean last)
Optional<String>	subProtocol()
WsSession	terminate()

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,
 io.helidon.http.HttpPrologue prologue,
 io.helidon.http.Headers upgradeHeaders,
 String wsKey,
 WsListener wsListener)

Create a new connection using a listener.

Parameters:

ctx - server connection context

prologue - prologue of this request

upgradeHeaders - headers for

wsKey - ws key

wsListener - a ws listener

Returns:

a new connection

create

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

Create a new connection using a route.

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(Semaphore requestSemaphore)

Specified by:

handle in interface ServerConnection

send

public WsSession send(String text,
 boolean last)

Specified by:

send in interface WsSession

send

public WsSession send(io.helidon.common.buffers.BufferData bufferData,
 boolean last)

Specified by:

send in interface WsSession

ping

public WsSession ping(io.helidon.common.buffers.BufferData bufferData)

Specified by:

ping in interface WsSession

pong

public WsSession pong(io.helidon.common.buffers.BufferData bufferData)

Specified by:

pong in interface WsSession

close

public WsSession close(int code,
 String reason)

Specified by:

close in interface WsSession

terminate

public WsSession terminate()

Specified by:

terminate in interface WsSession

subProtocol

public Optional<String> subProtocol()

Specified by:

subProtocol in interface WsSession

idleTime

public Duration idleTime()

Specified by:

idleTime in interface ServerConnection

close

public void close(boolean interrupt)

Specified by:

close in interface ServerConnection