public interface MessageConsumer<T> extends ReadStream<Message<T>>
EventBus
address that can
be read from.
The EventBus.consumer(String)
or EventBus.localConsumer(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)
method is invoked.
The consumer is unregistered from the event bus using the unregister()
method or by calling the
handler(io.vertx.core.Handler)
with a null value..
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.
|
MessageConsumer<T> |
endHandler(Handler<Void> endHandler)
Set an end handler.
|
MessageConsumer<T> |
exceptionHandler(Handler<Throwable> handler)
Set an exception handler on the read stream.
|
int |
getMaxBufferedMessages() |
MessageConsumer<T> |
handler(Handler<Message<T>> handler)
Set a data handler.
|
boolean |
isRegistered() |
MessageConsumer<T> |
pause()
Pause the
ReadSupport . |
MessageConsumer<T> |
resume()
Resume reading.
|
MessageConsumer<T> |
setMaxBufferedMessages(int maxBufferedMessages)
Set the number of messages this registration will buffer when this stream is paused.
|
void |
unregister()
Unregisters the handler which created this registration
|
void |
unregister(Handler<AsyncResult<Void>> completionHandler)
Unregisters the handler which created this registration
|
MessageConsumer<T> exceptionHandler(Handler<Throwable> handler)
ReadStream
exceptionHandler
in interface ReadStream<Message<T>>
exceptionHandler
in interface StreamBase
handler
- the exception handlerMessageConsumer<T> handler(Handler<Message<T>> handler)
ReadStream
handler
in interface ReadStream<Message<T>>
MessageConsumer<T> pause()
ReadStream
ReadSupport
. While it's paused, no data will be sent to the dataHandler
pause
in interface ReadStream<Message<T>>
MessageConsumer<T> resume()
ReadStream
ReadSupport
has been paused, reading will recommence on it.resume
in interface ReadStream<Message<T>>
MessageConsumer<T> endHandler(Handler<Void> endHandler)
ReadStream
endHandler
in interface ReadStream<Message<T>>
ReadStream<T> bodyStream()
boolean isRegistered()
String address()
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 bufferedint getMaxBufferedMessages()
void completionHandler(Handler<AsyncResult<Void>> completionHandler)
completionHandler
- the completion handlervoid unregister()
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.Copyright © 2015. All Rights Reserved.