/*
 * 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.eventbus;

import java.util.Map;
import rx.Observable;
import rx.Single;
import io.vertx.core.AsyncResult;
import io.vertx.core.Handler;

An event bus consumer object representing a stream of message to an EventBus address that can be read from.

The EventBus.consumer or EventBus.localConsumer creates a new consumer, the returned consumer is not yet registered against the event bus. Registration is effective after the handler method is invoked.

The consumer is unregistered from the event bus using the unregister method or by calling the handler with a null value..

NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen.
/** * An event bus consumer object representing a stream of message to an {@link io.vertx.rxjava.core.eventbus.EventBus} address that can * be read from. * <p> * The {@link io.vertx.rxjava.core.eventbus.EventBus#consumer} or {@link io.vertx.rxjava.core.eventbus.EventBus#localConsumer} * creates a new consumer, the returned consumer is not yet registered against the event bus. Registration * is effective after the {@link io.vertx.rxjava.core.eventbus.MessageConsumer#handler} method is invoked.<p> * * The consumer is unregistered from the event bus using the {@link io.vertx.rxjava.core.eventbus.MessageConsumer#unregister} method or by calling the * {@link io.vertx.rxjava.core.eventbus.MessageConsumer#handler} with a null value.. * * <p/> * NOTE: This class has been automatically generated from the {@link io.vertx.core.eventbus.MessageConsumer original} non RX-ified interface using Vert.x codegen. */
@io.vertx.lang.rx.RxGen(io.vertx.core.eventbus.MessageConsumer.class) public class MessageConsumer<T> implements io.vertx.rxjava.core.streams.ReadStream<io.vertx.rxjava.core.eventbus.Message<T>> { @Override public String toString() { return delegate.toString(); } @Override public boolean equals(Object o) { if (this == o) return true; if (o == null || getClass() != o.getClass()) return false; MessageConsumer that = (MessageConsumer) o; return delegate.equals(that.delegate); } @Override public int hashCode() { return delegate.hashCode(); } public static final io.vertx.lang.rx.TypeArg<MessageConsumer> __TYPE_ARG = new io.vertx.lang.rx.TypeArg<>( obj -> new MessageConsumer((io.vertx.core.eventbus.MessageConsumer) obj), MessageConsumer::getDelegate ); private final io.vertx.core.eventbus.MessageConsumer<T> delegate; public final io.vertx.lang.rx.TypeArg<T> __typeArg_0; public MessageConsumer(io.vertx.core.eventbus.MessageConsumer delegate) { this.delegate = delegate; this.__typeArg_0 = io.vertx.lang.rx.TypeArg.unknown(); } public MessageConsumer(io.vertx.core.eventbus.MessageConsumer delegate, io.vertx.lang.rx.TypeArg<T> typeArg_0) { this.delegate = delegate; this.__typeArg_0 = typeArg_0; } public io.vertx.core.eventbus.MessageConsumer getDelegate() { return delegate; } private rx.Observable<io.vertx.rxjava.core.eventbus.Message<T>> observable; public synchronized rx.Observable<io.vertx.rxjava.core.eventbus.Message<T>> toObservable() { if (observable == null) { java.util.function.Function<io.vertx.core.eventbus.Message<T>, io.vertx.rxjava.core.eventbus.Message<T>> conv = io.vertx.rxjava.core.eventbus.Message::newInstance; observable = io.vertx.rx.java.RxHelper.toObservable(delegate, conv); } return observable; }
Pause this stream and return a to transfer the elements of this stream to a destination .

The stream will be resumed when the pipe will be wired to a WriteStream.
Returns:a pipe
/** * Pause this stream and return a to transfer the elements of this stream to a destination . * <p/> * The stream will be resumed when the pipe will be wired to a <code>WriteStream</code>. * @return a pipe */
public io.vertx.rxjava.core.streams.Pipe<io.vertx.rxjava.core.eventbus.Message<T>> pipe() { io.vertx.rxjava.core.streams.Pipe<io.vertx.rxjava.core.eventbus.Message<T>> ret = io.vertx.rxjava.core.streams.Pipe.newInstance(delegate.pipe(), (io.vertx.lang.rx.TypeArg)io.vertx.rxjava.core.eventbus.Message.__TYPE_ARG); return ret; }
Like ReadStream.pipeTo but with no completion handler.
Params:
  • dst –
/** * Like {@link io.vertx.rxjava.core.streams.ReadStream#pipeTo} but with no completion handler. * @param dst */
public void pipeTo(io.vertx.rxjava.core.streams.WriteStream<io.vertx.rxjava.core.eventbus.Message<T>> dst) { delegate.pipeTo(dst.getDelegate()); }
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.

Params:
  • dst – the destination write stream
  • handler –
/** * Pipe this <code>ReadStream</code> to the <code>WriteStream</code>. * <p> * Elements emitted by this stream will be written to the write stream until this stream ends or fails. * <p> * Once this stream has ended or failed, the write stream will be ended and the <code>handler</code> will be * called with the result. * @param dst the destination write stream * @param handler */
public void pipeTo(io.vertx.rxjava.core.streams.WriteStream<io.vertx.rxjava.core.eventbus.Message<T>> dst, Handler<AsyncResult<Void>> 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.

Params:
  • dst – the destination write stream
Returns:
Deprecated:use rxPipeTo instead
/** * Pipe this <code>ReadStream</code> to the <code>WriteStream</code>. * <p> * Elements emitted by this stream will be written to the write stream until this stream ends or fails. * <p> * Once this stream has ended or failed, the write stream will be ended and the <code>handler</code> will be * called with the result. * @param dst the destination write stream * @return * @deprecated use {@link #rxPipeTo} instead */
@Deprecated() public Observable<Void> pipeToObservable(io.vertx.rxjava.core.streams.WriteStream<io.vertx.rxjava.core.eventbus.Message<T>> dst) { io.vertx.rx.java.ObservableFuture<Void> handler = io.vertx.rx.java.RxHelper.observableFuture(); pipeTo(dst, handler.toHandler()); return 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.

Params:
  • dst – the destination write stream
Returns:
/** * Pipe this <code>ReadStream</code> to the <code>WriteStream</code>. * <p> * Elements emitted by this stream will be written to the write stream until this stream ends or fails. * <p> * Once this stream has ended or failed, the write stream will be ended and the <code>handler</code> will be * called with the result. * @param dst the destination write stream * @return */
public Single<Void> rxPipeTo(io.vertx.rxjava.core.streams.WriteStream<io.vertx.rxjava.core.eventbus.Message<T>> dst) { return Single.create(new io.vertx.rx.java.SingleOnSubscribeAdapter<>(fut -> { pipeTo(dst, fut); })); } public io.vertx.rxjava.core.eventbus.MessageConsumer<T> exceptionHandler(Handler<Throwable> handler) { delegate.exceptionHandler(handler); return this; } public io.vertx.rxjava.core.eventbus.MessageConsumer<T> handler(Handler<io.vertx.rxjava.core.eventbus.Message<T>> handler) { delegate.handler(new Handler<io.vertx.core.eventbus.Message<T>>() { public void handle(io.vertx.core.eventbus.Message<T> event) { handler.handle(io.vertx.rxjava.core.eventbus.Message.newInstance(event, __typeArg_0)); } }); return this; } public io.vertx.rxjava.core.eventbus.MessageConsumer<T> pause() { delegate.pause(); return this; } public io.vertx.rxjava.core.eventbus.MessageConsumer<T> resume() { delegate.resume(); return this; } public io.vertx.rxjava.core.eventbus.MessageConsumer<T> fetch(long amount) { delegate.fetch(amount); return this; } public io.vertx.rxjava.core.eventbus.MessageConsumer<T> endHandler(Handler<Void> endHandler) { delegate.endHandler(endHandler); return this; }
Returns:a read stream for the body of the message stream.
/** * @return a read stream for the body of the message stream. */
public io.vertx.rxjava.core.streams.ReadStream<T> bodyStream() { io.vertx.rxjava.core.streams.ReadStream<T> ret = io.vertx.rxjava.core.streams.ReadStream.newInstance(delegate.bodyStream(), __typeArg_0); return ret; }
Returns:true if the current consumer is registered
/** * @return true if the current consumer is registered */
public boolean isRegistered() { boolean ret = delegate.isRegistered(); return ret; }
Returns:The address the handler was registered with.
/** * @return The address the handler was registered with. */
public String address() { String ret = delegate.address(); return ret; }
Set the number of messages this registration will buffer when this stream is paused. The default value is 1000.

When a new value is set, buffered messages may be discarded to reach the new value. The most recent messages will be kept.

Params:
  • maxBufferedMessages – the maximum number of messages that can be buffered
Returns:this registration
/** * Set the number of messages this registration will buffer when this stream is paused. The default * value is <code>1000</code>. * <p> * When a new value is set, buffered messages may be discarded to reach the new value. The most recent * messages will be kept. * @param maxBufferedMessages the maximum number of messages that can be buffered * @return this registration */
public io.vertx.rxjava.core.eventbus.MessageConsumer<T> setMaxBufferedMessages(int maxBufferedMessages) { io.vertx.rxjava.core.eventbus.MessageConsumer<T> ret = io.vertx.rxjava.core.eventbus.MessageConsumer.newInstance(delegate.setMaxBufferedMessages(maxBufferedMessages), __typeArg_0); return ret; }
Returns:the maximum number of messages that can be buffered when this stream is paused
/** * @return the maximum number of messages that can be buffered when this stream is paused */
public int getMaxBufferedMessages() { int ret = delegate.getMaxBufferedMessages(); return ret; }
Optional method which can be called to indicate when the registration has been propagated across the cluster.
Params:
  • completionHandler – the completion handler
/** * Optional method which can be called to indicate when the registration has been propagated across the cluster. * @param completionHandler the completion handler */
public void completionHandler(Handler<AsyncResult<Void>> completionHandler) { delegate.completionHandler(completionHandler); }
Optional method which can be called to indicate when the registration has been propagated across the cluster.
Returns:
Deprecated:use rxCompletionHandler instead
/** * Optional method which can be called to indicate when the registration has been propagated across the cluster. * @return * @deprecated use {@link #rxCompletionHandler} instead */
@Deprecated() public Observable<Void> completionHandlerObservable() { io.vertx.rx.java.ObservableFuture<Void> completionHandler = io.vertx.rx.java.RxHelper.observableFuture(); completionHandler(completionHandler.toHandler()); return completionHandler; }
Optional method which can be called to indicate when the registration has been propagated across the cluster.
Returns:
/** * Optional method which can be called to indicate when the registration has been propagated across the cluster. * @return */
public Single<Void> rxCompletionHandler() { return Single.create(new io.vertx.rx.java.SingleOnSubscribeAdapter<>(fut -> { completionHandler(fut); })); }
Unregisters the handler which created this registration
/** * Unregisters the handler which created this registration */
public void unregister() { delegate.unregister(); }
Unregisters the handler which created this registration
Params:
  • completionHandler – the handler called when the unregister is done. For example in a cluster when all nodes of the event bus have been unregistered.
/** * Unregisters the handler which created this registration * @param completionHandler the handler called when the unregister is done. For example in a cluster when all nodes of the event bus have been unregistered. */
public void unregister(Handler<AsyncResult<Void>> completionHandler) { delegate.unregister(completionHandler); }
Unregisters the handler which created this registration
Returns:
Deprecated:use rxUnregister instead
/** * Unregisters the handler which created this registration * @return * @deprecated use {@link #rxUnregister} instead */
@Deprecated() public Observable<Void> unregisterObservable() { io.vertx.rx.java.ObservableFuture<Void> completionHandler = io.vertx.rx.java.RxHelper.observableFuture(); unregister(completionHandler.toHandler()); return completionHandler; }
Unregisters the handler which created this registration
Returns:
/** * Unregisters the handler which created this registration * @return */
public Single<Void> rxUnregister() { return Single.create(new io.vertx.rx.java.SingleOnSubscribeAdapter<>(fut -> { unregister(fut); })); } public static <T>MessageConsumer<T> newInstance(io.vertx.core.eventbus.MessageConsumer arg) { return arg != null ? new MessageConsumer<T>(arg) : null; } public static <T>MessageConsumer<T> newInstance(io.vertx.core.eventbus.MessageConsumer arg, io.vertx.lang.rx.TypeArg<T> __typeArg_T) { return arg != null ? new MessageConsumer<T>(arg, __typeArg_T) : null; } }