io.vertx.ext.reactivestreams.ReactiveWriteStream Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of vertx-reactive-streams Show documentation

There is a newer version: 5.0.0.CR3

Show newest version

/*
 * Copyright 2014 Red Hat, Inc.
 *
 *  All rights reserved. This program and the accompanying materials
 *  are made available under the terms of the Eclipse Public License v1.0
 *  and Apache License v2.0 which accompanies this distribution.
 *
 *  The Eclipse Public License is available at
 *  http://www.eclipse.org/legal/epl-v10.html
 *
 *  The Apache License v2.0 is available at
 *  http://www.opensource.org/licenses/apache2.0.php
 *
 *  You may elect to redistribute this code under either of these licenses.
 */

package io.vertx.ext.reactivestreams;

import io.vertx.core.Handler;
import io.vertx.core.Vertx;
import io.vertx.core.streams.WriteStream;
import io.vertx.ext.reactivestreams.impl.ReactiveWriteStreamImpl;
import org.reactivestreams.Publisher;

/**
 * A Vert.x write stream that also implements reactive streams publisher interface.
 *
 *
 * @author Tim Fox
 */
public interface ReactiveWriteStream extends WriteStream, Publisher {

  /**
   * Default write queue max size
   */
  static final int DEFAULT_WRITE_QUEUE_MAX_SIZE = 32;

  /**
   * Create a reactive write stream
   *
   * @param vertx  the Vert.x instance
   * @return the stream
   */
  static  ReactiveWriteStream writeStream(Vertx vertx) {
    return new ReactiveWriteStreamImpl<>(vertx);
  }

  @Override
  ReactiveWriteStream exceptionHandler(Handler handler);

  @Override
  ReactiveWriteStream write(T data);

  @Override
  ReactiveWriteStream setWriteQueueMaxSize(int maxSize);

  @Override
  ReactiveWriteStream drainHandler(Handler handler);

  /**
   * Calls {@link #close()}.
   */
  @Override
  void end();

  /**
   * Close the stream
   *
   * @return a reference to this for a fluent API
   */
  ReactiveWriteStream close();

}