Class MessageConsumer<T>
- java.lang.Object
-
- io.vertx.rxjava3.core.eventbus.MessageConsumer<T>
-
- All Implemented Interfaces:
io.vertx.lang.rx.RxDelegate,ReadStream<Message<T>>,StreamBase
public class MessageConsumer<T> extends Object implements io.vertx.lang.rx.RxDelegate, ReadStream<Message<T>>
An event bus consumer object representing a stream of message to anEventBusaddress that can be read from.The
EventBus.consumer(io.vertx.core.eventbus.MessageConsumerOptions)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.rxjava3.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.rxjava3.core.eventbus.Message<T>>)with a null value..NOTE: This class has been automatically generated from the
originalnon RX-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static io.vertx.lang.rx.TypeArg<MessageConsumer>__TYPE_ARGio.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 Stringaddress()ReadStream<T>bodyStream()Completablecompletion()MessageConsumer<T>endHandler(Handler<Void> endHandler)Set an end handler.booleanequals(Object o)MessageConsumer<T>exceptionHandler(Handler<Throwable> handler)Set an exception handler on the read stream.MessageConsumer<T>fetch(long amount)Fetch the specifiedamountof elements.MessageConsumergetDelegate()MessageConsumer<T>handler(Handler<Message<T>> handler)Set a data handler.inthashCode()booleanisRegistered()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 infetchmode 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 .CompletablepipeTo(WriteStream<Message<T>> dst)Pipe thisReadStreamto theWriteStream.MessageConsumer<T>resume()Resume reading, and sets the buffer inflowingmode.CompletablerxCompletion()CompletablerxPipeTo(WriteStream<Message<T>> dst)Pipe thisReadStreamto theWriteStream.CompletablerxUnregister()Unregisters the handler which created this registrationFlowable<Message<T>>toFlowable()Observable<Message<T>>toObservable()StringtoString()Completableunregister()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:
getDelegatein interfaceReadStream<T>- Specified by:
getDelegatein interfaceio.vertx.lang.rx.RxDelegate- Specified by:
getDelegatein interfaceStreamBase
-
toObservable
public Observable<Message<T>> toObservable()
- Specified by:
toObservablein interfaceReadStream<T>
-
toFlowable
public Flowable<Message<T>> toFlowable()
- Specified by:
toFlowablein 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:
pipein interfaceReadStream<T>- Returns:
- a pipe
-
pipeTo
public Completable pipeTo(WriteStream<Message<T>> dst)
Pipe thisReadStreamto theWriteStream.Elements emitted by this stream will be written to the write stream until this stream ends or fails.
- Specified by:
pipeToin 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 thisReadStreamto theWriteStream.Elements emitted by this stream will be written to the write stream until this stream ends or fails.
- Specified by:
rxPipeToin 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:ReadStreamSet an exception handler on the read stream.- Specified by:
exceptionHandlerin interfaceReadStream<T>- Specified by:
exceptionHandlerin 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:ReadStreamSet a data handler. As data is read, the handler will be called with the data.- Specified by:
handlerin interfaceReadStream<T>- Returns:
- a reference to this, so the API can be used fluently
-
pause
public MessageConsumer<T> pause()
Description copied from interface:ReadStreamPause theReadStream, it sets the buffer infetchmode and clears the actual demand.While it's paused, no data will be sent to the data
handler.- Specified by:
pausein interfaceReadStream<T>- Returns:
- a reference to this, so the API can be used fluently
-
resume
public MessageConsumer<T> resume()
Description copied from interface:ReadStreamResume reading, and sets the buffer inflowingmode. If theReadStreamhas been paused, reading will recommence on it.- Specified by:
resumein 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:ReadStreamFetch the specifiedamountof elements. If theReadStreamhas been paused, reading will recommence with the specifiedamountof items, otherwise the specifiedamountwill be added to the current stream demand.- Specified by:
fetchin 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:ReadStreamSet an end handler. Once the stream has ended, and there is no more data to be read, this handler will be called.- Specified by:
endHandlerin 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.
-
completion
public Completable 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 Completable 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)
-
-