io.vertx.rxjava.core.streams.ReadStream Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2014 Red Hat, Inc.
 *
 * Red Hat licenses this file to you under the Apache License, version 2.0
 * (the "License"); you may not use this file except in compliance with the
 * License.  You may obtain a copy of the License at:
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
 * License for the specific language governing permissions and limitations
 * under the License.
 */

package io.vertx.rxjava.core.streams;

import rx.Observable;
import rx.Single;
import io.vertx.rx.java.RxHelper;
import io.vertx.rx.java.WriteStreamSubscriber;
import io.vertx.rx.java.SingleOnSubscribeAdapter;
import java.util.Map;
import java.util.Set;
import java.util.List;
import java.util.Iterator;
import java.util.function.Function;
import java.util.stream.Collectors;
import io.vertx.core.Handler;
import io.vertx.core.AsyncResult;
import io.vertx.core.json.JsonObject;
import io.vertx.core.json.JsonArray;
import io.vertx.lang.rx.RxGen;
import io.vertx.lang.rx.TypeArg;
import io.vertx.lang.rx.MappingIterator;

/**
 * Represents a stream of items that can be read from.
 * 
 * Any class that implements this interface can be used by a {@link io.vertx.rxjava.core.streams.Pipe} to pipe data from it
 * to a {@link io.vertx.rxjava.core.streams.WriteStream}.
 * 

 * 
Streaming mode
 * The stream is either in flowing or fetch mode.
 * 
 *   Initially the stream is in flowing mode.
 *   When the stream is in flowing mode, elements are delivered to the handler.
 *   When the stream is in fetch mode, only the number of requested elements will be delivered to the handler.
 * 
 * The mode can be changed with the {@link io.vertx.rxjava.core.streams.ReadStream#pause}, {@link io.vertx.rxjava.core.streams.ReadStream#resume} and {@link io.vertx.rxjava.core.streams.ReadStream#fetch} methods:
 * 
 *   Calling {@link io.vertx.rxjava.core.streams.ReadStream#resume} sets the flowing mode
 *   Calling {@link io.vertx.rxjava.core.streams.ReadStream#pause} sets the fetch mode and resets the demand to 0
 *   Calling {@link io.vertx.rxjava.core.streams.ReadStream#fetch} requests a specific amount of elements and adds it to the actual demand
 * 
 *
 * 
 * NOTE: This class has been automatically generated from the {@link io.vertx.core.streams.ReadStream original} non RX-ified interface using Vert.x codegen.
 */

@RxGen(io.vertx.core.streams.ReadStream.class)
public interface ReadStream extends io.vertx.rxjava.core.streams.StreamBase {

  io.vertx.core.streams.ReadStream getDelegate();

  /**
   * Set an exception handler on the read stream.
   * @param handler the exception handler
   * @return a reference to this, so the API can be used fluently
   */
  public io.vertx.rxjava.core.streams.ReadStream exceptionHandler(io.vertx.core.Handler handler);

  /**
   * Set a data handler. As data is read, the handler will be called with the data.
   * @param handler 
   * @return a reference to this, so the API can be used fluently
   */
  public io.vertx.rxjava.core.streams.ReadStream handler(io.vertx.core.Handler handler);

  /**
   * Pause the ReadStream, it sets the buffer in fetch mode and clears the actual demand.
   * 

   * While it's paused, no data will be sent to the data handler.
   * @return a reference to this, so the API can be used fluently
   */
  public io.vertx.rxjava.core.streams.ReadStream pause();

  /**
   * Resume reading, and sets the buffer in flowing mode.
   * 

   * If the ReadStream has been paused, reading will recommence on it.
   * @return a reference to this, so the API can be used fluently
   */
  public io.vertx.rxjava.core.streams.ReadStream resume();

  /**
   * Fetch the specified amount of elements. If the ReadStream has been paused, reading will
   * recommence with the specified amount of items, otherwise the specified amount will
   * be added to the current stream demand.
   * @param amount 
   * @return a reference to this, so the API can be used fluently
   */
  public io.vertx.rxjava.core.streams.ReadStream fetch(long amount);

  /**
   * Set an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.
   * @param endHandler 
   * @return a reference to this, so the API can be used fluently
   */
  public io.vertx.rxjava.core.streams.ReadStream endHandler(io.vertx.core.Handler endHandler);

  /**
   * Pause this stream and return a {@link io.vertx.rxjava.core.streams.Pipe} to transfer the elements of this stream to a destination {@link io.vertx.rxjava.core.streams.WriteStream}.
   * 

   * The stream will be resumed when the pipe will be wired to a WriteStream.
   * @return a pipe
   */
  public io.vertx.rxjava.core.streams.Pipe pipe();

  /**
   * Pipe this ReadStream to the WriteStream.
   * 

   * Elements emitted by this stream will be written to the write stream until this stream ends or fails.
   * 

   * Once this stream has ended or failed, the write stream will be ended and the handler will be
   * called with the result.
   * @param dst the destination write stream
   * @param handler 
   */
  public void pipeTo(io.vertx.rxjava.core.streams.WriteStream dst, io.vertx.core.Handler> handler);

  /**
   * Pipe this ReadStream to the WriteStream.
   * 

   * Elements emitted by this stream will be written to the write stream until this stream ends or fails.
   * 

   * Once this stream has ended or failed, the write stream will be ended and the handler will be
   * called with the result.
   * @param dst the destination write stream
   */
  public void pipeTo(io.vertx.rxjava.core.streams.WriteStream dst);

    /**
   * Pipe this ReadStream to the WriteStream.
   * 

   * Elements emitted by this stream will be written to the write stream until this stream ends or fails.
   * 

   * Once this stream has ended or failed, the write stream will be ended and the handler will be
   * called with the result.
   * @param dst the destination write stream
   * @return 
   */
  public rx.Single rxPipeTo(io.vertx.rxjava.core.streams.WriteStream dst);

  rx.Observable toObservable();

  public static  ReadStream newInstance(io.vertx.core.streams.ReadStream arg) {
    return arg != null ? new ReadStreamImpl(arg) : null;
  }

  public static  ReadStream newInstance(io.vertx.core.streams.ReadStream arg, TypeArg __typeArg_T) {
    return arg != null ? new ReadStreamImpl(arg, __typeArg_T) : null;
  }

}

class ReadStreamImpl implements ReadStream {
  private final io.vertx.core.streams.ReadStream delegate;
  public final TypeArg __typeArg_0;
  
  public ReadStreamImpl(io.vertx.core.streams.ReadStream delegate) {
    this.delegate = delegate;
    this.__typeArg_0 = TypeArg.unknown();  }

  public ReadStreamImpl(Object delegate, TypeArg typeArg_0) {
    this.delegate = (io.vertx.core.streams.ReadStream)delegate;
    this.__typeArg_0 = typeArg_0;
  }

  public io.vertx.core.streams.ReadStream getDelegate() {
    return delegate;
  }

  private Observable observable;

  public synchronized Observable toObservable() {
    if (observable == null) {
      Function conv = (Function) __typeArg_0.wrap;
      observable = RxHelper.toObservable(delegate, conv);
    }
    return observable;
  }


  /**
   * Set an exception handler on the read stream.
   * @param handler the exception handler
   * @return a reference to this, so the API can be used fluently
   */
  public io.vertx.rxjava.core.streams.ReadStream exceptionHandler(io.vertx.core.Handler handler) { 
    delegate.exceptionHandler(handler);
    return this;
  }

  /**
   * Set a data handler. As data is read, the handler will be called with the data.
   * @param handler 
   * @return a reference to this, so the API can be used fluently
   */
  public io.vertx.rxjava.core.streams.ReadStream handler(io.vertx.core.Handler handler) { 
    delegate.handler(new Handler() {
      public void handle(T event) {
        handler.handle((T)__typeArg_0.wrap(event));
      }
    });
    return this;
  }

  /**
   * Pause the ReadStream, it sets the buffer in fetch mode and clears the actual demand.
   * 

   * While it's paused, no data will be sent to the data handler.
   * @return a reference to this, so the API can be used fluently
   */
  public io.vertx.rxjava.core.streams.ReadStream pause() { 
    delegate.pause();
    return this;
  }

  /**
   * Resume reading, and sets the buffer in flowing mode.
   * 

   * If the ReadStream has been paused, reading will recommence on it.
   * @return a reference to this, so the API can be used fluently
   */
  public io.vertx.rxjava.core.streams.ReadStream resume() { 
    delegate.resume();
    return this;
  }

  /**
   * Fetch the specified amount of elements. If the ReadStream has been paused, reading will
   * recommence with the specified amount of items, otherwise the specified amount will
   * be added to the current stream demand.
   * @param amount 
   * @return a reference to this, so the API can be used fluently
   */
  public io.vertx.rxjava.core.streams.ReadStream fetch(long amount) { 
    delegate.fetch(amount);
    return this;
  }

  /**
   * Set an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.
   * @param endHandler 
   * @return a reference to this, so the API can be used fluently
   */
  public io.vertx.rxjava.core.streams.ReadStream endHandler(io.vertx.core.Handler endHandler) { 
    delegate.endHandler(endHandler);
    return this;
  }

  /**
   * Pause this stream and return a {@link io.vertx.rxjava.core.streams.Pipe} to transfer the elements of this stream to a destination {@link io.vertx.rxjava.core.streams.WriteStream}.
   * 

   * The stream will be resumed when the pipe will be wired to a WriteStream.
   * @return a pipe
   */
  public io.vertx.rxjava.core.streams.Pipe pipe() { 
    io.vertx.rxjava.core.streams.Pipe ret = io.vertx.rxjava.core.streams.Pipe.newInstance((io.vertx.core.streams.Pipe)delegate.pipe(), __typeArg_0);
    return ret;
  }

  /**
   * Pipe this ReadStream to the WriteStream.
   * 

   * Elements emitted by this stream will be written to the write stream until this stream ends or fails.
   * 

   * Once this stream has ended or failed, the write stream will be ended and the handler will be
   * called with the result.
   * @param dst the destination write stream
   * @param handler 
   */
  public void pipeTo(io.vertx.rxjava.core.streams.WriteStream dst, io.vertx.core.Handler> handler) { 
    delegate.pipeTo(dst.getDelegate(), handler);
  }

  /**
   * Pipe this ReadStream to the WriteStream.
   * 

   * Elements emitted by this stream will be written to the write stream until this stream ends or fails.
   * 

   * Once this stream has ended or failed, the write stream will be ended and the handler will be
   * called with the result.
   * @param dst the destination write stream
   */
  public void pipeTo(io.vertx.rxjava.core.streams.WriteStream dst) {
    pipeTo(dst, ar -> { });
  }

    /**
   * Pipe this ReadStream to the WriteStream.
   * 

   * Elements emitted by this stream will be written to the write stream until this stream ends or fails.
   * 
   * Once this stream has ended or failed, the write stream will be ended and the handler will be
   * called with the result.
   * @param dst the destination write stream
   * @return 
   */
  public rx.Single rxPipeTo(io.vertx.rxjava.core.streams.WriteStream dst) { 
    return Single.create(new SingleOnSubscribeAdapter<>(fut -> {
      pipeTo(dst, fut);
    }));
  }

}