Package io.vertx.rxjava3.amqp
Class AmqpReceiver
- java.lang.Object
-
- io.vertx.rxjava3.amqp.AmqpReceiver
-
- All Implemented Interfaces:
io.vertx.lang.rx.RxDelegate,ReadStream<AmqpMessage>,StreamBase
public class AmqpReceiver extends Object implements io.vertx.lang.rx.RxDelegate, ReadStream<AmqpMessage>
Interface used to consume AMQP message as a stream of message. Back pressure is implemented using AMQP credits.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<AmqpReceiver>__TYPE_ARG
-
Constructor Summary
Constructors Constructor Description AmqpReceiver(AmqpReceiver delegate)AmqpReceiver(Object delegate)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringaddress()The listened address.Completableclose()Closes the receiver.AmqpConnectionconnection()Gets the connection having created the receiver.AmqpReceiverendHandler(Handler<Void> endHandler)Set an end handler.booleanequals(Object o)AmqpReceiverexceptionHandler(Handler<Throwable> handler)Set an exception handler on the read stream.AmqpReceiverfetch(long amount)Fetch the specifiedamountof elements.AmqpReceivergetDelegate()AmqpReceiverhandler(Handler<AmqpMessage> handler)Set a data handler.inthashCode()static AmqpReceivernewInstance(AmqpReceiver arg)AmqpReceiverpause()Pause theReadStream, it sets the buffer infetchmode and clears the actual demand.Pipe<AmqpMessage>pipe()Pause this stream and return a to transfer the elements of this stream to a destination .CompletablepipeTo(WriteStream<AmqpMessage> dst)Pipe thisReadStreamto theWriteStream.AmqpReceiverresume()Resume reading, and sets the buffer inflowingmode.CompletablerxClose()Closes the receiver.CompletablerxPipeTo(WriteStream<AmqpMessage> dst)Pipe thisReadStreamto theWriteStream.Flowable<AmqpMessage>toFlowable()Observable<AmqpMessage>toObservable()StringtoString()io.vertx.proton.ProtonReceiverunwrap()
-
-
-
Field Detail
-
__TYPE_ARG
public static final io.vertx.lang.rx.TypeArg<AmqpReceiver> __TYPE_ARG
-
-
Constructor Detail
-
AmqpReceiver
public AmqpReceiver(AmqpReceiver delegate)
-
AmqpReceiver
public AmqpReceiver(Object delegate)
-
-
Method Detail
-
getDelegate
public AmqpReceiver getDelegate()
- Specified by:
getDelegatein interfaceReadStream<AmqpMessage>- Specified by:
getDelegatein interfaceio.vertx.lang.rx.RxDelegate- Specified by:
getDelegatein interfaceStreamBase
-
toObservable
public Observable<AmqpMessage> toObservable()
- Specified by:
toObservablein interfaceReadStream<AmqpMessage>
-
toFlowable
public Flowable<AmqpMessage> toFlowable()
- Specified by:
toFlowablein interfaceReadStream<AmqpMessage>
-
pipe
public Pipe<AmqpMessage> 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<AmqpMessage>- Returns:
- a pipe
-
pipeTo
public Completable pipeTo(WriteStream<AmqpMessage> 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<AmqpMessage>- 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<AmqpMessage> 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<AmqpMessage>- Parameters:
dst- the destination write stream- Returns:
- a future notified when the write stream will be ended with the outcome
-
exceptionHandler
public AmqpReceiver exceptionHandler(Handler<Throwable> handler)
Description copied from interface:ReadStreamSet an exception handler on the read stream.- Specified by:
exceptionHandlerin interfaceReadStream<AmqpMessage>- Specified by:
exceptionHandlerin interfaceStreamBase- Parameters:
handler- the exception handler- Returns:
- a reference to this, so the API can be used fluently
-
handler
public AmqpReceiver handler(Handler<AmqpMessage> 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<AmqpMessage>- Returns:
- a reference to this, so the API can be used fluently
-
pause
public AmqpReceiver 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<AmqpMessage>- Returns:
- a reference to this, so the API can be used fluently
-
resume
public AmqpReceiver 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<AmqpMessage>- Returns:
- a reference to this, so the API can be used fluently
-
fetch
public AmqpReceiver 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<AmqpMessage>- Returns:
- a reference to this, so the API can be used fluently
-
endHandler
public AmqpReceiver 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<AmqpMessage>- Returns:
- a reference to this, so the API can be used fluently
-
address
public String address()
The listened address.- Returns:
- the address, not
null
-
close
public Completable close()
Closes the receiver.- Returns:
- a future notified when the receiver has been closed
-
rxClose
public Completable rxClose()
Closes the receiver.- Returns:
- a future notified when the receiver has been closed
-
connection
public AmqpConnection connection()
Gets the connection having created the receiver. Cannot benull- Returns:
- the connection having created the receiver.
-
unwrap
public io.vertx.proton.ProtonReceiver unwrap()
- Returns:
- the underlying ProtonReceiver.
-
newInstance
public static AmqpReceiver newInstance(AmqpReceiver arg)
-
-