org.yamcs.api

Class WebSocketEventProducer

java.lang.Object

org.yamcs.api.AbstractEventProducer

org.yamcs.api.WebSocketEventProducer

All Implemented Interfaces:

EventProducer, WebSocketClientCallback

public class WebSocketEventProducer
extends AbstractEventProducer
implements WebSocketClientCallback

An EventProducer that publishes events over WebSocket

By default, repeated message are detected and reduced, resulting in pseudo events with a message like 'last event repeated X times'. This behaviour can be turned off.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the connection to the server; the producer is unusable after this is called
void	disconnected() When a previously successful connection was disconnected
long	getMissionTime()
void	onMessage(Web.WebSocketServerMessage.WebSocketSubscriptionData data)
void	sendEvent(Yamcs.Event event)
String	toString()

Methods inherited from class org.yamcs.api.AbstractEventProducer

flushEventBuffer, newEvent, sendError, sendInfo, sendWarning, setRepeatedEventReduction, setSeqNo, setSource

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.yamcs.api.ws.WebSocketClientCallback

connected, connectionFailed, onInvalidIdentification

Method Detail

disconnected

public void disconnected()

Description copied from interface: WebSocketClientCallback

When a previously successful connection was disconnected

Specified by:

disconnected in interface WebSocketClientCallback

close

public void close()

Description copied from interface: EventProducer

Closes the connection to the server; the producer is unusable after this is called

Specified by:

close in interface EventProducer

sendEvent

public void sendEvent(Yamcs.Event event)

Specified by:

sendEvent in interface EventProducer

toString

public String toString()

Overrides:

toString in class Object

getMissionTime

public long getMissionTime()

Specified by:

getMissionTime in class AbstractEventProducer

onMessage

public void onMessage(Web.WebSocketServerMessage.WebSocketSubscriptionData data)

Specified by:

onMessage in interface WebSocketClientCallback