• Home
• io.smallrye.reactive
• smallrye-reactive-messaging-api
• 3.15.0
• source code
• Emitter.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

io.smallrye.reactive.messaging.annotations.Emitter Maven / Gradle / Ivy

package io.smallrye.reactive.messaging.annotations;

/**
 * @deprecated Use {@link org.eclipse.microprofile.reactive.messaging.Emitter} instead.
 */
@Deprecated
public interface Emitter {

    /**
     * Sends a payload or a message to the stream.
     *
     * @param msg the thing to send, must not be {@code null}
     * @return the current emitter
     * @throws IllegalStateException if the stream does not have any pending requests, or if the stream has been
     *         cancelled or terminated.
     */
    Emitter send(T msg);

    /**
     * Completes the stream.
     * This method sends the completion signal, no messages can be sent once this method is called.
     */
    void complete();

    /**
     * Propagates an error in the stream.
     * This methods sends an error signal, no messages can be sent once this method is called.
     *
     * @param e the exception, must not be {@code null}
     */
    void error(Exception e);

    /**
     * @return {@code true} if the emitter has been terminated or the subscription cancelled.
     */
    boolean isCancelled();

    /**
     * @return {@code true} if the subscriber accepts messages, {@code false} otherwise.
     *         Using {@link #send(Object)} on an emitter not expecting message would throw an {@link IllegalStateException}.
     */
    boolean isRequested();

}