io.vertx.rxjava.core.streams.WriteStream Maven / Gradle / Ivy
/*
* 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 data that can be written to.
*
* Any class that implements this interface can be used by a {@link io.vertx.rxjava.core.streams.Pipe} to pipe data from a ReadStream
* to it.
*
*
* NOTE: This class has been automatically generated from the {@link io.vertx.core.streams.WriteStream original} non RX-ified interface using Vert.x codegen.
*/
@RxGen(io.vertx.core.streams.WriteStream.class)
public interface WriteStream extends io.vertx.rxjava.core.streams.StreamBase {
io.vertx.core.streams.WriteStream getDelegate();
/**
* Set an exception handler on the write stream.
* @param handler the exception handler
* @return a reference to this, so the API can be used fluently
*/
public io.vertx.rxjava.core.streams.WriteStream exceptionHandler(Handler handler);
/**
* Write some data to the stream. The data is put on an internal write queue, and the write actually happens
* asynchronously. To avoid running out of memory by putting too much on the write queue,
* check the {@link io.vertx.rxjava.core.streams.WriteStream#writeQueueFull} method before writing. This is done automatically if using a {@link io.vertx.rxjava.core.streams.Pump}.
* @param data the data to write
* @return a reference to this, so the API can be used fluently
*/
public io.vertx.rxjava.core.streams.WriteStream write(T data);
/**
* Same as but with an handler called when the operation completes
* @param data
* @param handler
* @return
*/
public io.vertx.rxjava.core.streams.WriteStream write(T data, Handler> handler);
/**
* Ends the stream.
*
* Once the stream has ended, it cannot be used any more.
*/
public void end();
/**
* Same as {@link io.vertx.rxjava.core.streams.WriteStream#end} but with an handler called when the operation completes
* @param handler
*/
public void end(Handler> handler);
/**
* Same as {@link io.vertx.rxjava.core.streams.WriteStream#end} but writes some data to the stream before ending.
* @param data the data to write
*/
public void end(T data);
/**
* Same as but with an handler called when the operation completes
* @param data
* @param handler
*/
public void end(T data, Handler> handler);
/**
* Set the maximum size of the write queue to maxSize. You will still be able to write to the stream even
* if there is more than maxSize items in the write queue. This is used as an indicator by classes such as
* Pump to provide flow control.
*
* The value is defined by the implementation of the stream, e.g in bytes for a
* {@link io.vertx.rxjava.core.net.NetSocket}, the number of {@link io.vertx.rxjava.core.eventbus.Message} for a
* {@link io.vertx.rxjava.core.eventbus.MessageProducer}, etc...
* @param maxSize the max size of the write stream
* @return a reference to this, so the API can be used fluently
*/
public io.vertx.rxjava.core.streams.WriteStream setWriteQueueMaxSize(int maxSize);
/**
* This will return true if there are more bytes in the write queue than the value set using {@link io.vertx.rxjava.core.streams.WriteStream#setWriteQueueMaxSize}
* @return true if write queue is full
*/
public boolean writeQueueFull();
/**
* Set a drain handler on the stream. If the write queue is full, then the handler will be called when the write
* queue is ready to accept buffers again. See {@link io.vertx.rxjava.core.streams.Pump} for an example of this being used.
*
* The stream implementation defines when the drain handler, for example it could be when the queue size has been
* reduced to maxSize / 2.
* @param handler the handler
* @return a reference to this, so the API can be used fluently
*/
public io.vertx.rxjava.core.streams.WriteStream drainHandler(Handler handler);
public static WriteStream newInstance(io.vertx.core.streams.WriteStream arg) {
return arg != null ? new WriteStreamImpl(arg) : null;
}
public static WriteStream newInstance(io.vertx.core.streams.WriteStream arg, TypeArg __typeArg_T) {
return arg != null ? new WriteStreamImpl(arg, __typeArg_T) : null;
}
}
class WriteStreamImpl implements WriteStream {
private final io.vertx.core.streams.WriteStream delegate;
public final TypeArg __typeArg_0;
public WriteStreamImpl(io.vertx.core.streams.WriteStream delegate) {
this.delegate = delegate;
this.__typeArg_0 = TypeArg.unknown(); }
public WriteStreamImpl(Object delegate, TypeArg typeArg_0) {
this.delegate = (io.vertx.core.streams.WriteStream)delegate;
this.__typeArg_0 = typeArg_0;
}
public io.vertx.core.streams.WriteStream getDelegate() {
return delegate;
}
private WriteStreamSubscriber subscriber;
public synchronized WriteStreamSubscriber toSubscriber() {
if (subscriber == null) {
Function conv = (Function) __typeArg_0.unwrap;
subscriber = RxHelper.toSubscriber(getDelegate(), conv);
}
return subscriber;
}
/**
* Set an exception handler on the write stream.
* @param handler the exception handler
* @return a reference to this, so the API can be used fluently
*/
public io.vertx.rxjava.core.streams.WriteStream exceptionHandler(Handler handler) {
delegate.exceptionHandler(handler);
return this;
}
/**
* Write some data to the stream. The data is put on an internal write queue, and the write actually happens
* asynchronously. To avoid running out of memory by putting too much on the write queue,
* check the {@link io.vertx.rxjava.core.streams.WriteStream#writeQueueFull} method before writing. This is done automatically if using a {@link io.vertx.rxjava.core.streams.Pump}.
* @param data the data to write
* @return a reference to this, so the API can be used fluently
*/
public io.vertx.rxjava.core.streams.WriteStream write(T data) {
delegate.write(__typeArg_0.unwrap(data));
return this;
}
/**
* Same as but with an handler called when the operation completes
* @param data
* @param handler
* @return
*/
public io.vertx.rxjava.core.streams.WriteStream write(T data, Handler> handler) {
delegate.write(__typeArg_0.unwrap(data), handler);
return this;
}
/**
* Same as but with an handler called when the operation completes
* @param data
* @return
* @deprecated use {@link #rxWrite} instead
*/
@Deprecated()
public Observable writeObservable(T data) {
io.vertx.rx.java.ObservableFuture handler = io.vertx.rx.java.RxHelper.observableFuture();
write(data, handler.toHandler());
return handler;
}
/**
* Same as but with an handler called when the operation completes
* @param data
* @return
*/
public Single rxWrite(T data) {
return Single.create(new io.vertx.rx.java.SingleOnSubscribeAdapter<>(fut -> {
write(data, fut);
}));
}
/**
* Ends the stream.
*
* Once the stream has ended, it cannot be used any more.
*/
public void end() {
delegate.end();
}
/**
* Same as {@link io.vertx.rxjava.core.streams.WriteStream#end} but with an handler called when the operation completes
* @param handler
*/
public void end(Handler> handler) {
delegate.end(handler);
}
/**
* Same as {@link io.vertx.rxjava.core.streams.WriteStream#end} but with an handler called when the operation completes
* @return
* @deprecated use {@link #rxEnd} instead
*/
@Deprecated()
public Observable endObservable() {
io.vertx.rx.java.ObservableFuture handler = io.vertx.rx.java.RxHelper.observableFuture();
end(handler.toHandler());
return handler;
}
/**
* Same as {@link io.vertx.rxjava.core.streams.WriteStream#end} but with an handler called when the operation completes
* @return
*/
public Single rxEnd() {
return Single.create(new io.vertx.rx.java.SingleOnSubscribeAdapter<>(fut -> {
end(fut);
}));
}
/**
* Same as {@link io.vertx.rxjava.core.streams.WriteStream#end} but writes some data to the stream before ending.
* @param data the data to write
*/
public void end(T data) {
delegate.end(__typeArg_0.unwrap(data));
}
/**
* Same as but with an handler called when the operation completes
* @param data
* @param handler
*/
public void end(T data, Handler> handler) {
delegate.end(__typeArg_0.unwrap(data), handler);
}
/**
* Same as but with an handler called when the operation completes
* @param data
* @return
* @deprecated use {@link #rxEnd} instead
*/
@Deprecated()
public Observable endObservable(T data) {
io.vertx.rx.java.ObservableFuture handler = io.vertx.rx.java.RxHelper.observableFuture();
end(data, handler.toHandler());
return handler;
}
/**
* Same as but with an handler called when the operation completes
* @param data
* @return
*/
public Single rxEnd(T data) {
return Single.create(new io.vertx.rx.java.SingleOnSubscribeAdapter<>(fut -> {
end(data, fut);
}));
}
/**
* Set the maximum size of the write queue to maxSize. You will still be able to write to the stream even
* if there is more than maxSize items in the write queue. This is used as an indicator by classes such as
* Pump to provide flow control.
*
* The value is defined by the implementation of the stream, e.g in bytes for a
* {@link io.vertx.rxjava.core.net.NetSocket}, the number of {@link io.vertx.rxjava.core.eventbus.Message} for a
* {@link io.vertx.rxjava.core.eventbus.MessageProducer}, etc...
* @param maxSize the max size of the write stream
* @return a reference to this, so the API can be used fluently
*/
public io.vertx.rxjava.core.streams.WriteStream setWriteQueueMaxSize(int maxSize) {
delegate.setWriteQueueMaxSize(maxSize);
return this;
}
/**
* This will return true if there are more bytes in the write queue than the value set using {@link io.vertx.rxjava.core.streams.WriteStream#setWriteQueueMaxSize}
* @return true if write queue is full
*/
public boolean writeQueueFull() {
boolean ret = delegate.writeQueueFull();
return ret;
}
/**
* Set a drain handler on the stream. If the write queue is full, then the handler will be called when the write
* queue is ready to accept buffers again. See {@link io.vertx.rxjava.core.streams.Pump} for an example of this being used.
*
* The stream implementation defines when the drain handler, for example it could be when the queue size has been
* reduced to maxSize / 2.
* @param handler the handler
* @return a reference to this, so the API can be used fluently
*/
public io.vertx.rxjava.core.streams.WriteStream drainHandler(Handler handler) {
delegate.drainHandler(handler);
return this;
}
}