org.yamcs.api.EventProducer Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of yamcs-api Show documentation
Used by external clients to communicate with Yamcs
There is a newer version: 5.10.1
package org.yamcs.api;

import org.yamcs.protobuf.Yamcs.Event;

public interface EventProducer {

    public abstract void sendEvent(Event event);

    public abstract void setSource(String source);

    public abstract void setSeqNo(int sn);

    /**
     * @deprecated not according to XTCE levels, use {@link #sendCritical(String, String)}
     * 
     */
    @Deprecated
    public abstract void sendError(String type, String msg);

    
    void sendInfo(String type, String msg);
    
    /**
     * Send a warning event with the given type
     * 
     * @param type
     * @param msg
     */
    void sendWarning(String type, String msg);

    void sendWatch(String type, String msg);

    void sendDistress(String type, String msg);

    void sendCritical(String type, String msg);

    void sendSevere(String type, String msg);

    /**
     * send an info event with the type automatically filled in as the caller class name
     * 
     * @param msg
     *            - event message
     */
    void sendInfo(String msg);

    /**
     * send an warning event with the type automatically filled in as the caller class name
     * 
     * @param msg
     *            - event message
     */
    void sendWarning(String msg);

    /**
     * send an watch event with the type automatically filled in as the caller class name
     * 
     * @param msg
     *            - event message
     */
    void sendWatch(String msg);

    /**
     * send an distress event with the type automatically filled in as the caller class name
     * 
     * @param msg
     *            - event message
     */
    void sendDistress(String msg);

    /**
     * send an critical event with the type automatically filled in as the caller class name
     * 
     * @param msg
     *            - event message
     */
    void sendCritical(String msg);

    /**
     * send an severe event with the type automatically filled in as the caller class name
     * 
     * @param msg
     *            - event message
     */
    void sendSevere(String msg);

    /**
     * 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"
     * 
     * @param repeatedEventReduction
     *            if true - enable the reduction of events.
     * @param repeatedEventTimeoutMillisec
     *            - how long to keep quiet in case of equal events being sent
     */
    public abstract void setRepeatedEventReduction(boolean repeatedEventReduction, long repeatedEventTimeoutMillisec);

    /**
     * Creates a default Event Builder with these fields pre-filled: source,
     * seqNo, receptionTime, generationTime
     */
    public abstract Event.Builder newEvent();

    /**
     * Closes the connection to the server; the producer is unusable after this is called
     */
    public void close();
}