Class MessageConsumer<T>
- java.lang.Object
-
- io.vertx.reactivex.core.eventbus.MessageConsumer<T>
-
- All Implemented Interfaces:
ReadStream<Message<T>>
,StreamBase
public class MessageConsumer<T> extends Object implements ReadStream<Message<T>>
An event bus consumer object representing a stream of message to anEventBus
address that can be read from.The
EventBus.consumer(java.lang.String)
orEventBus.localConsumer(java.lang.String)
creates a new consumer, the returned consumer is not yet registered against the event bus. Registration is effective after thehandler(io.vertx.core.Handler<io.vertx.reactivex.core.eventbus.Message<T>>)
method is invoked.The consumer is unregistered from the event bus using the
unregister()
method or by calling thehandler(io.vertx.core.Handler<io.vertx.reactivex.core.eventbus.Message<T>>)
with a null value..NOTE: This class has been automatically generated from the
original
non RX-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static io.vertx.lang.rx.TypeArg<MessageConsumer>
__TYPE_ARG
io.vertx.lang.rx.TypeArg<T>
__typeArg_0
-
Constructor Summary
Constructors Constructor Description MessageConsumer(MessageConsumer delegate)
MessageConsumer(Object delegate, io.vertx.lang.rx.TypeArg<T> typeArg_0)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
address()
ReadStream<T>
bodyStream()
Future<Void>
completion()
MessageConsumer<T>
endHandler(Handler<Void> endHandler)
Set an end handler.boolean
equals(Object o)
MessageConsumer<T>
exceptionHandler(Handler<Throwable> handler)
Set an exception handler on the read stream.MessageConsumer<T>
fetch(long amount)
Fetch the specifiedamount
of elements.MessageConsumer
getDelegate()
int
getMaxBufferedMessages()
MessageConsumer<T>
handler(Handler<Message<T>> handler)
Set a data handler.int
hashCode()
boolean
isRegistered()
static <T> MessageConsumer<T>
newInstance(MessageConsumer arg)
static <T> MessageConsumer<T>
newInstance(MessageConsumer arg, io.vertx.lang.rx.TypeArg<T> __typeArg_T)
MessageConsumer<T>
pause()
Pause theReadStream
, it sets the buffer infetch
mode and clears the actual demand.Pipe<Message<T>>
pipe()
Pause this stream and return a to transfer the elements of this stream to a destination .Future<Void>
pipeTo(WriteStream<Message<T>> dst)
Pipe thisReadStream
to theWriteStream
.MessageConsumer<T>
resume()
Resume reading, and sets the buffer inflowing
mode.Completable
rxCompletion()
Completable
rxPipeTo(WriteStream<Message<T>> dst)
Pipe thisReadStream
to theWriteStream
.Completable
rxUnregister()
Unregisters the handler which created this registrationMessageConsumer<T>
setMaxBufferedMessages(int maxBufferedMessages)
Set the number of messages this registration will buffer when this stream is paused.Flowable<Message<T>>
toFlowable()
Observable<Message<T>>
toObservable()
String
toString()
Future<Void>
unregister()
Unregisters the handler which created this registration
-
-
-
Field Detail
-
__TYPE_ARG
public static final io.vertx.lang.rx.TypeArg<MessageConsumer> __TYPE_ARG
-
__typeArg_0
public final io.vertx.lang.rx.TypeArg<T> __typeArg_0
-
-
Constructor Detail
-
MessageConsumer
public MessageConsumer(MessageConsumer delegate)
-
-
Method Detail
-
getDelegate
public MessageConsumer getDelegate()
- Specified by:
getDelegate
in interfaceReadStream<T>
- Specified by:
getDelegate
in interfaceStreamBase
-
toObservable
public Observable<Message<T>> toObservable()
- Specified by:
toObservable
in interfaceReadStream<T>
-
toFlowable
public Flowable<Message<T>> toFlowable()
- Specified by:
toFlowable
in interfaceReadStream<T>
-
pipe
public Pipe<Message<T>> pipe()
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 aWriteStream
.- Specified by:
pipe
in interfaceReadStream<T>
- Returns:
- a pipe
-
pipeTo
public Future<Void> pipeTo(WriteStream<Message<T>> dst)
Pipe thisReadStream
to theWriteStream
.Elements emitted by this stream will be written to the write stream until this stream ends or fails.
- Specified by:
pipeTo
in interfaceReadStream<T>
- Parameters:
dst
- the destination write stream- Returns:
- a future notified when the write stream will be ended with the outcome
-
rxPipeTo
public Completable rxPipeTo(WriteStream<Message<T>> dst)
Pipe thisReadStream
to theWriteStream
.Elements emitted by this stream will be written to the write stream until this stream ends or fails.
- Specified by:
rxPipeTo
in interfaceReadStream<T>
- Parameters:
dst
- the destination write stream- Returns:
- a future notified when the write stream will be ended with the outcome
-
exceptionHandler
public MessageConsumer<T> exceptionHandler(Handler<Throwable> handler)
Description copied from interface:ReadStream
Set an exception handler on the read stream.- Specified by:
exceptionHandler
in interfaceReadStream<T>
- Specified by:
exceptionHandler
in interfaceStreamBase
- Parameters:
handler
- the exception handler- Returns:
- a reference to this, so the API can be used fluently
-
handler
public MessageConsumer<T> handler(Handler<Message<T>> handler)
Description copied from interface:ReadStream
Set a data handler. As data is read, the handler will be called with the data.- Specified by:
handler
in interfaceReadStream<T>
- Returns:
- a reference to this, so the API can be used fluently
-
pause
public MessageConsumer<T> pause()
Description copied from interface:ReadStream
Pause theReadStream
, it sets the buffer infetch
mode and clears the actual demand.While it's paused, no data will be sent to the data
handler
.- Specified by:
pause
in interfaceReadStream<T>
- Returns:
- a reference to this, so the API can be used fluently
-
resume
public MessageConsumer<T> resume()
Description copied from interface:ReadStream
Resume reading, and sets the buffer inflowing
mode. If theReadStream
has been paused, reading will recommence on it.- Specified by:
resume
in interfaceReadStream<T>
- Returns:
- a reference to this, so the API can be used fluently
-
fetch
public MessageConsumer<T> fetch(long amount)
Description copied from interface:ReadStream
Fetch the specifiedamount
of elements. If theReadStream
has been paused, reading will recommence with the specifiedamount
of items, otherwise the specifiedamount
will be added to the current stream demand.- Specified by:
fetch
in interfaceReadStream<T>
- Returns:
- a reference to this, so the API can be used fluently
-
endHandler
public MessageConsumer<T> endHandler(Handler<Void> endHandler)
Description copied from interface:ReadStream
Set an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.- Specified by:
endHandler
in interfaceReadStream<T>
- Returns:
- a reference to this, so the API can be used fluently
-
bodyStream
public ReadStream<T> bodyStream()
- Returns:
- a read stream for the body of the message stream.
-
isRegistered
public boolean isRegistered()
- Returns:
- true if the current consumer is registered
-
address
public String address()
- Returns:
- The address the handler was registered with.
-
setMaxBufferedMessages
public MessageConsumer<T> setMaxBufferedMessages(int maxBufferedMessages)
Set the number of messages this registration will buffer when this stream is paused. The default value is1000
.When a new value is set, buffered messages may be discarded to reach the new value. The most recent messages will be kept.
- Parameters:
maxBufferedMessages
- the maximum number of messages that can be buffered- Returns:
- this registration
-
getMaxBufferedMessages
public int getMaxBufferedMessages()
- Returns:
- the maximum number of messages that can be buffered when this stream is paused
-
completion
public Future<Void> completion()
- Returns:
- a future notified when the message consumer is registered
-
rxCompletion
public Completable rxCompletion()
- Returns:
- a future notified when the message consumer is registered
-
unregister
public Future<Void> unregister()
Unregisters the handler which created this registration- Returns:
- a future notified when the unregistation is done
-
rxUnregister
public Completable rxUnregister()
Unregisters the handler which created this registration- Returns:
- a future notified when the unregistation is done
-
newInstance
public static <T> MessageConsumer<T> newInstance(MessageConsumer arg)
-
newInstance
public static <T> MessageConsumer<T> newInstance(MessageConsumer arg, io.vertx.lang.rx.TypeArg<T> __typeArg_T)
-
-