io.vertx.core.eventbus.MessageProducer.java Source code

Introduction

Here is the source code for io.vertx.core.eventbus.MessageProducer.java

Source

/*
 * Copyright (c) 2011-2019 Contributors to the Eclipse Foundation
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
 * which is available at https://www.apache.org/licenses/LICENSE-2.0.
 *
 * SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
 */

package io.vertx.core.eventbus;

import io.vertx.codegen.annotations.Fluent;
import io.vertx.codegen.annotations.VertxGen;
import io.vertx.core.AsyncResult;
import io.vertx.core.Future;
import io.vertx.core.Handler;
import io.vertx.core.streams.WriteStream;

/**
 * Represents a stream of message that can be written to.
 * <p>
 *
 * @author <a href="mailto:julien@julienviet.com">Julien Viet</a>
 */
@VertxGen
public interface MessageProducer<T> extends WriteStream<T> {

    int DEFAULT_WRITE_QUEUE_MAX_SIZE = 1000;

    @Override
    MessageProducer<T> exceptionHandler(Handler<Throwable> handler);

    @Override
    MessageProducer<T> setWriteQueueMaxSize(int maxSize);

    @Override
    MessageProducer<T> drainHandler(Handler<Void> handler);

    /**
     * Update the delivery options of this producer.
     *
     * @param options the new options
     * @return this producer object
     */
    @Fluent
    MessageProducer<T> deliveryOptions(DeliveryOptions options);

    /**
     * @return The address to which the producer produces messages.
     */
    String address();

    /**
     * Closes the producer, calls {@link #close()}
     *
     * @return a future completed with the result
     */
    @Override
    Future<Void> end();

    /**
     * Closes the producer, calls {@link #close(Handler)}
     */
    @Override
    void end(Handler<AsyncResult<Void>> handler);

    /**
     * Closes the producer, this method should be called when the message producer is not used anymore.
     *
     * @return a future completed with the result
     */
    Future<Void> close();

    /**
     * Same as {@link #close()} but with an {@code handler} called when the operation completes
     */
    void close(Handler<AsyncResult<Void>> handler);
}