Module io.helidon.webclient.websocket

Package io.helidon.webclient.websocket

Class ClientWsConnection

java.lang.Object

io.helidon.webclient.websocket.ClientWsConnection

All Implemented Interfaces:

io.helidon.websocket.WsSession, Runnable

public class ClientWsConnection
extends Object
implements io.helidon.websocket.WsSession, Runnable

Client WebSocket connection. This connection handles a single WebSocket interaction, using WsListener to handle connection events.

Method Summary

Modifier and Type	Method	Description
io.helidon.websocket.WsSession	close(int code, String reason)	Closes WebSocket session.
static ClientWsConnection	create(io.helidon.webclient.api.ClientConnection clientConnection, io.helidon.websocket.WsListener listener)	Create a new connection without a sub-protocol.
static ClientWsConnection	create(io.helidon.webclient.api.ClientConnection clientConnection, io.helidon.websocket.WsListener listener, String subProtocol)	Create a new connection.
io.helidon.websocket.WsSession	ping(BufferData bufferData)
io.helidon.websocket.WsSession	pong(BufferData bufferData)
void	run()
io.helidon.websocket.WsSession	send(BufferData bufferData, boolean last)
io.helidon.websocket.WsSession	send(String text, boolean last)
io.helidon.common.socket.SocketContext	socketContext()
Optional<String>	subProtocol()
io.helidon.websocket.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 ClientWsConnection create(io.helidon.webclient.api.ClientConnection clientConnection,
 io.helidon.websocket.WsListener listener,
 String subProtocol)

Create a new connection. The connection needs to run on ana executor service (it implements Runnable) so it does not block the current thread.

Parameters:

clientConnection - connection to use for this WS connection

listener - WebSocket listener to handle events on this connection

subProtocol - chosen sub-protocol of this connection (negotiated during upgrade from HTTP/1)

Returns:

a new WebSocket connection

create

public static ClientWsConnection create(io.helidon.webclient.api.ClientConnection clientConnection,
 io.helidon.websocket.WsListener listener)

Create a new connection without a sub-protocol.

Parameters:

clientConnection - connection to work on

listener - WebSocket listener to handle events on this connection

Returns:

a new WebSocket connection

run

public void run()

Specified by:

run in interface Runnable

send

public io.helidon.websocket.WsSession send(String text,
 boolean last)

Specified by:

send in interface io.helidon.websocket.WsSession

send

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

Specified by:

send in interface io.helidon.websocket.WsSession

ping

public io.helidon.websocket.WsSession ping(BufferData bufferData)

Specified by:

ping in interface io.helidon.websocket.WsSession

pong

public io.helidon.websocket.WsSession pong(BufferData bufferData)

Specified by:

pong in interface io.helidon.websocket.WsSession

close

public io.helidon.websocket.WsSession close(int code,
 String reason)

Closes WebSocket session. If code is negative, then a CLOSE frame with no code or reason is sent. This can be used to test CLOSE frames with no payload, as required by the spec.

Specified by:

close in interface io.helidon.websocket.WsSession

Parameters:

code - close code, may be one of WsCloseCodes

reason - reason description

Returns:

the session

terminate

public io.helidon.websocket.WsSession terminate()

Specified by:

terminate in interface io.helidon.websocket.WsSession

subProtocol

public Optional<String> subProtocol()

Specified by:

subProtocol in interface io.helidon.websocket.WsSession

socketContext

public io.helidon.common.socket.SocketContext socketContext()

Specified by:

socketContext in interface io.helidon.websocket.WsSession