de.ipcon.db.api.websockets

Class WebSocketService

java.lang.Object

de.ipcon.db.api.websockets.WebSocketService

All Implemented Interfaces:

DBManEventListenerI

public class WebSocketService
extends java.lang.Object
implements DBManEventListenerI

DBMan Listener that hands events to registered event listeners, which may then use the socket of this service to push the event in some other form to the client.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEQUE_CAPACITY
static int	DEQUE_EVENT_TIMEOUT
static long	IDLE_TIMEOUT
static int	KEEPALIVE_PING_INTERVAL

Fields inherited from interface de.ipcon.db.event.DBManEventListenerI

$0

Constructor Summary

Constructors

Constructor and Description
WebSocketService(org.eclipse.jetty.websocket.api.Session session)
WebSocketService(org.eclipse.jetty.websocket.api.Session session, DBManEventProviderI eventProvider)
WebSocketService(org.eclipse.jetty.websocket.api.Session session, DBManEventProviderI eventProvider, FormatterConfiguration globalFormatterConfig)

Method Summary

Modifier and Type	Method and Description
void	addEventListener(java.lang.Class<?> c, java.util.function.BiConsumer<WebSocketService,DBManBOChangeEvent> callable)
void	close()
void	processDBManEvent(DBManEvent event) Invoked when a subscribed DBManEvent occurs.
void	sendEventAsJSON(DBManBOChangeEvent event, java.lang.Class<? extends BOI> classFilter)
void	sendEventAsJSON(DBManBOChangeEvent event, java.lang.Class<? extends BOI> classFilter, FormatterConfiguration config) converts the given event (i.e. an update of values) into a JSON string and send that over the websocket.
void	sendPing()
void	sendString(java.lang.String text)
void	setEventFormatterConfig(FormatterConfiguration config)

Methods inherited from class java.lang.Object

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

Field Detail

KEEPALIVE_PING_INTERVAL

public static final int KEEPALIVE_PING_INTERVAL

See Also:

Constant Field Values

IDLE_TIMEOUT

public static final long IDLE_TIMEOUT

See Also:

Constant Field Values

DEQUE_CAPACITY

public static final int DEQUE_CAPACITY

See Also:

Constant Field Values

DEQUE_EVENT_TIMEOUT

public static final int DEQUE_EVENT_TIMEOUT

See Also:

Constant Field Values

Constructor Detail

WebSocketService

public WebSocketService(org.eclipse.jetty.websocket.api.Session session)

WebSocketService

public WebSocketService(org.eclipse.jetty.websocket.api.Session session,
                        DBManEventProviderI eventProvider)

WebSocketService

public WebSocketService(org.eclipse.jetty.websocket.api.Session session,
                        DBManEventProviderI eventProvider,
                        FormatterConfiguration globalFormatterConfig)

Method Detail

setEventFormatterConfig

public void setEventFormatterConfig(FormatterConfiguration config)

sendPing

public void sendPing()

sendString

public void sendString(java.lang.String text)

sendEventAsJSON

public void sendEventAsJSON(DBManBOChangeEvent event,
                            java.lang.Class<? extends BOI> classFilter)

sendEventAsJSON

public void sendEventAsJSON(DBManBOChangeEvent event,
                            java.lang.Class<? extends BOI> classFilter,
                            FormatterConfiguration config)

converts the given event (i.e. an update of values) into a JSON string and send that over the websocket.

Parameters:

event -

processDBManEvent

public void processDBManEvent(DBManEvent event)

Description copied from interface: DBManEventListenerI

Invoked when a subscribed DBManEvent occurs. See DBManBOChangeEvent for events triggered after modification on BOs.

Specified by:

processDBManEvent in interface DBManEventListenerI

addEventListener

public void addEventListener(java.lang.Class<?> c,
                             java.util.function.BiConsumer<WebSocketService,DBManBOChangeEvent> callable)

close

public void close()