public class MessageConsumer<T> extends Object implements ReadStream<Message<T>>
EventBus
address that can
be read from.
The EventBus.consumer(java.lang.String)
or EventBus.localConsumer(java.lang.String)
creates a new consumer, the returned consumer is not yet registered against the event bus. Registration
is effective after the handler(io.vertx.core.Handler<io.vertx.rxjava.core.eventbus.Message<T>>)
method is invoked.
The consumer is unregistered from the event bus using the unregister()
method or by calling the
handler(io.vertx.core.Handler<io.vertx.rxjava.core.eventbus.Message<T>>)
with a null value..
original
non RX-ified interface using Vert.x codegen.Modifier and Type | Field and Description |
---|---|
static TypeArg<MessageConsumer> |
__TYPE_ARG |
TypeArg<T> |
__typeArg_0 |
Constructor and Description |
---|
MessageConsumer(MessageConsumer delegate) |
MessageConsumer(MessageConsumer delegate,
TypeArg<T> typeArg_0) |
Modifier and Type | Method and Description |
---|---|
String |
address() |
ReadStream<T> |
bodyStream() |
void |
completionHandler(Handler<AsyncResult<Void>> completionHandler)
Optional method which can be called to indicate when the registration has been propagated across the cluster.
|
Observable<Void> |
completionHandlerObservable()
Deprecated.
use
rxCompletionHandler() instead |
MessageConsumer<T> |
endHandler(Handler<Void> endHandler)
Set an end handler.
|
MessageConsumer<T> |
exceptionHandler(Handler<Throwable> handler)
Set an exception handler on the read stream.
|
MessageConsumer |
getDelegate() |
int |
getMaxBufferedMessages() |
MessageConsumer<T> |
handler(Handler<Message<T>> handler)
Set a data handler.
|
boolean |
isRegistered() |
static <T> MessageConsumer<T> |
newInstance(MessageConsumer arg) |
static <T> MessageConsumer<T> |
newInstance(MessageConsumer arg,
TypeArg<T> __typeArg_T) |
MessageConsumer<T> |
pause()
Pause the
ReadSupport . |
MessageConsumer<T> |
resume()
Resume reading.
|
Single<Void> |
rxCompletionHandler()
Optional method which can be called to indicate when the registration has been propagated across the cluster.
|
Single<Void> |
rxUnregister()
Unregisters the handler which created this registration
|
MessageConsumer<T> |
setMaxBufferedMessages(int maxBufferedMessages)
Set the number of messages this registration will buffer when this stream is paused.
|
Observable<Message<T>> |
toObservable() |
void |
unregister()
Unregisters the handler which created this registration
|
void |
unregister(Handler<AsyncResult<Void>> completionHandler)
Unregisters the handler which created this registration
|
Observable<Void> |
unregisterObservable()
Deprecated.
use
rxUnregister() instead |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
newInstance, newInstance
newInstance
public static final TypeArg<MessageConsumer> __TYPE_ARG
public MessageConsumer(MessageConsumer delegate)
public MessageConsumer(MessageConsumer delegate, TypeArg<T> typeArg_0)
public MessageConsumer getDelegate()
getDelegate
in interface ReadStream<Message<T>>
getDelegate
in interface StreamBase
public Observable<Message<T>> toObservable()
toObservable
in interface ReadStream<Message<T>>
public MessageConsumer<T> exceptionHandler(Handler<Throwable> handler)
ReadStream
exceptionHandler
in interface ReadStream<Message<T>>
exceptionHandler
in interface StreamBase
handler
- the exception handlerpublic MessageConsumer<T> handler(Handler<Message<T>> handler)
ReadStream
handler
in interface ReadStream<Message<T>>
public MessageConsumer<T> pause()
ReadStream
ReadSupport
. While it's paused, no data will be sent to the dataHandler
pause
in interface ReadStream<Message<T>>
public MessageConsumer<T> resume()
ReadStream
ReadSupport
has been paused, reading will recommence on it.resume
in interface ReadStream<Message<T>>
public MessageConsumer<T> endHandler(Handler<Void> endHandler)
ReadStream
endHandler
in interface ReadStream<Message<T>>
public ReadStream<T> bodyStream()
public boolean isRegistered()
public String address()
public MessageConsumer<T> setMaxBufferedMessages(int maxBufferedMessages)
0
. When a new value is set, buffered messages may be discarded to reach
the new value.maxBufferedMessages
- the maximum number of messages that can be bufferedpublic int getMaxBufferedMessages()
public void completionHandler(Handler<AsyncResult<Void>> completionHandler)
completionHandler
- the completion handler@Deprecated public Observable<Void> completionHandlerObservable()
rxCompletionHandler()
insteadpublic Single<Void> rxCompletionHandler()
public void unregister()
public void unregister(Handler<AsyncResult<Void>> completionHandler)
completionHandler
- the handler called when the unregister is done. For example in a cluster when all nodes of the event bus have been unregistered.@Deprecated public Observable<Void> unregisterObservable()
rxUnregister()
insteadpublic Single<Void> rxUnregister()
public static <T> MessageConsumer<T> newInstance(MessageConsumer arg)
public static <T> MessageConsumer<T> newInstance(MessageConsumer arg, TypeArg<T> __typeArg_T)
Copyright © 2017. All rights reserved.