org.yamcs.api

Interface EventProducer

All Known Implementing Classes:

AbstractEventProducer, ConsoleEventProducer, MockupEventProducer, RestEventProducer

public interface EventProducer

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE_ALGO_COMPILE
static String	TYPE_ALGO_RUN

Method Summary

Modifier and Type	Method and Description
void	close() Closes the connection to the server; the producer is unusable after this is called
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) Deprecated. not according to XTCE levels, use sendCritical(String, String)
void	sendEvent(Yamcs.Event event)
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) Enable/disable repeated event reduction.
void	setSeqNo(int sn)
void	setSource(String source)

Field Detail

TYPE_ALGO_COMPILE

static final String TYPE_ALGO_COMPILE

See Also:

Constant Field Values

TYPE_ALGO_RUN

static final String TYPE_ALGO_RUN

See Also:

Constant Field Values

Method Detail

sendEvent

void sendEvent(Yamcs.Event event)

setSource

void setSource(String source)

setSeqNo

void setSeqNo(int sn)

sendError

@Deprecated
void sendError(String type,
                           String msg)

Deprecated. not according to XTCE levels, use sendCritical(String, String)

sendWarning

void sendWarning(String type,
                 String msg)

sendInfo

void sendInfo(String type,
              String msg)

sendWatch

void sendWatch(String type,
               String msg)

sendDistress

void sendDistress(String type,
                  String msg)

sendCritical

void sendCritical(String type,
                  String msg)

sendSevere

void sendSevere(String type,
                String msg)

setRepeatedEventReduction

void setRepeatedEventReduction(boolean repeatedEventReduction,
                               long repeatedEventTimeoutMillisec)

Enable/disable repeated event reduction. If enabled, the events that are equal are not sent until the timeout expires, case in which an event containing the number of events skipped will be sent. Two events are considered equal if their source, type, severity and message are equal. The sequence count and timestamp do not need to be equal. The event sent in case the timeout is expired is a copy of the last event except that the message is replaced with "Repeated x times: original message"

Parameters:

repeatedEventReduction - if true - enable the reduction of events.

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

newEvent

Yamcs.Event.Builder newEvent()

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

close

void close()

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