services.moleculer.httpclient

Class WebSocketConnection

java.lang.Object

services.moleculer.httpclient.WebSocketConnection

public class WebSocketConnection
extends java.lang.Object

WebSocket message receiver with built-in heartbeat function. Basic usage with auto connection:

 client.ws("ws://server/path", msg -> {
 
     // Message received; "msg" is a JSON structure
     String value = msg.get("key", "defaultValue");
 
 });
 

Advanced usage; WebSocket client with custom parameters:

 WebSocketConnection ws = client.ws("ws://server/path", msg -> {
 
     // Message received; "msg" is a JSON structure
     String value = msg.get("key", "defaultValue");
 
 }, params -> {
 
     // Configure connection
     params.setHeartbeatInterval(60);
     params.setHeader("key", "value");
 
 }, false);
 
 // Create connection
 ws.connect();
 

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.concurrent.atomic.AtomicBoolean	closed
protected java.util.function.Consumer<WebSocketParams>	configurator
protected java.util.concurrent.atomic.AtomicReference<io.datatree.Promise>	connected
protected java.util.concurrent.atomic.AtomicReference<io.datatree.Promise>	disconnected
protected WebSocketHandler	handler
protected HttpClient	httpClient
protected static org.slf4j.Logger	logger
protected WebSocketParams	params
protected java.util.concurrent.atomic.AtomicLong	receivedAt
protected java.util.concurrent.atomic.AtomicReference<java.util.concurrent.ScheduledFuture<?>>	reconnectTimer
protected java.util.concurrent.atomic.AtomicLong	submittedAt
protected java.lang.String	url
protected java.util.concurrent.atomic.AtomicReference<org.asynchttpclient.ws.WebSocket>	webSocket

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WebSocketConnection(HttpClient httpClient, java.lang.String url, WebSocketHandler handler, java.util.function.Consumer<WebSocketParams> configurator)

Method Summary

Modifier and Type	Method and Description
protected void	closeConnection(org.asynchttpclient.ws.WebSocket targetSocket)
io.datatree.Promise	connect()
io.datatree.Promise	disconnect()
protected void	finalize()
protected void	openConnection()
protected void	reconnect()
void	waitForConnection(long timeout, java.util.concurrent.TimeUnit unit) Waiting for "connected" status.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.slf4j.Logger logger

httpClient

protected final HttpClient httpClient

url

protected final java.lang.String url

handler

protected final WebSocketHandler handler

configurator

protected final java.util.function.Consumer<WebSocketParams> configurator

webSocket

protected final java.util.concurrent.atomic.AtomicReference<org.asynchttpclient.ws.WebSocket> webSocket

reconnectTimer

protected final java.util.concurrent.atomic.AtomicReference<java.util.concurrent.ScheduledFuture<?>> reconnectTimer

connected

protected final java.util.concurrent.atomic.AtomicReference<io.datatree.Promise> connected

disconnected

protected final java.util.concurrent.atomic.AtomicReference<io.datatree.Promise> disconnected

closed

protected final java.util.concurrent.atomic.AtomicBoolean closed

submittedAt

protected final java.util.concurrent.atomic.AtomicLong submittedAt

receivedAt

protected final java.util.concurrent.atomic.AtomicLong receivedAt

params

protected WebSocketParams params

Constructor Detail

WebSocketConnection

protected WebSocketConnection(HttpClient httpClient,
                              java.lang.String url,
                              WebSocketHandler handler,
                              java.util.function.Consumer<WebSocketParams> configurator)

Method Detail

connect

public io.datatree.Promise connect()

openConnection

protected void openConnection()

waitForConnection

public void waitForConnection(long timeout,
                              java.util.concurrent.TimeUnit unit)
                       throws java.lang.Exception

Waiting for "connected" status.

Parameters:

timeout - the maximum time to wait

unit - the time unit of the timeout argument

Throws:

java.lang.Exception - any (interruption, execution, user-level, etc.) exception

disconnect

public io.datatree.Promise disconnect()

closeConnection

protected void closeConnection(org.asynchttpclient.ws.WebSocket targetSocket)

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

reconnect

protected void reconnect()