org.yamcs.api

Class AbstractEventProducer

java.lang.Object

org.yamcs.api.AbstractEventProducer

All Implemented Interfaces:

EventProducer

Direct Known Subclasses:

ConsoleEventProducer, MockupEventProducer, RestEventProducer

public abstract class AbstractEventProducer
extends Object
implements EventProducer

Default implementation of an EventProducer that provides shortcut methods for sending message of different severity types.

Constructor Summary

Constructors

Constructor and Description
AbstractEventProducer()

Method Summary

Modifier and Type	Method and Description
protected void	flushEventBuffer(boolean startNewSequence)
abstract long	getMissionTime()
Yamcs.Event.Builder	newEvent() Creates a default Event Builder with these fields pre-filled: source, seqNo, receptionTime, generationTime
void	sendCritical(String type, String msg)
void	sendDistress(String type, String msg)
void	sendError(String type, String msg)
void	sendInfo(String type, String msg)
void	sendSevere(String type, String msg)
void	sendWarning(String type, String msg)
void	sendWatch(String type, String msg)
void	setRepeatedEventReduction(boolean repeatedEventReduction, long repeatedEventTimeoutMillisec) By default event repetitions are checked for possible reduction.
void	setSeqNo(int sn)
void	setSource(String source)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.yamcs.api.EventProducer

close, sendEvent

Constructor Detail

AbstractEventProducer

public AbstractEventProducer()

Method Detail

setSource

public void setSource(String source)

Specified by:

setSource in interface EventProducer

setSeqNo

public void setSeqNo(int sn)

Specified by:

setSeqNo in interface EventProducer

sendError

public void sendError(String type,
                      String msg)

Specified by:

sendError in interface EventProducer

sendWarning

public void sendWarning(String type,
                        String msg)

Specified by:

sendWarning in interface EventProducer

sendInfo

public void sendInfo(String type,
                     String msg)

Specified by:

sendInfo in interface EventProducer

sendWatch

public void sendWatch(String type,
                      String msg)

Specified by:

sendWatch in interface EventProducer

sendDistress

public void sendDistress(String type,
                         String msg)

Specified by:

sendDistress in interface EventProducer

sendCritical

public void sendCritical(String type,
                         String msg)

Specified by:

sendCritical in interface EventProducer

sendSevere

public void sendSevere(String type,
                       String msg)

Specified by:

sendSevere in interface EventProducer

setRepeatedEventReduction

public void setRepeatedEventReduction(boolean repeatedEventReduction,
                                      long repeatedEventTimeoutMillisec)

By default event repetitions are checked for possible reduction. Disable if 'realtime' events are required.

Specified by:

setRepeatedEventReduction in interface EventProducer

Parameters:

repeatedEventReduction - if true - enable the reduction of events.

repeatedEventTimeoutMillisec - - how long to keep quiet in case of equal events being sent

flushEventBuffer

protected void flushEventBuffer(boolean startNewSequence)

newEvent

public Yamcs.Event.Builder newEvent()

Description copied from interface: EventProducer

Creates a default Event Builder with these fields pre-filled: source, seqNo, receptionTime, generationTime

Specified by:

newEvent in interface EventProducer

getMissionTime

public abstract long getMissionTime()