Package io.vertx.amqp
Interface AmqpReceiver
-
- All Superinterfaces:
ReadStream<AmqpMessage>,StreamBase
public interface AmqpReceiver extends ReadStream<AmqpMessage>
Interface used to consume AMQP message as a stream of message. Back pressure is implemented using AMQP credits.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Stringaddress()The listened address.Future<Void>close()Closes the receiver.AmqpConnectionconnection()Gets the connection having created the receiver.AmqpReceiverendHandler(Handler<Void> endHandler)Set an end handler.AmqpReceiverexceptionHandler(Handler<Throwable> handler)Set an exception handler on the read stream.AmqpReceiverfetch(long amount)Fetch the specifiedamountof elements.AmqpReceiverhandler(Handler<AmqpMessage> handler)Set a data handler.AmqpReceiverpause()Pause theReadStream, it sets the buffer infetchmode and clears the actual demand.AmqpReceiverresume()Resume reading, and sets the buffer inflowingmode.io.vertx.proton.ProtonReceiverunwrap()-
Methods inherited from interface io.vertx.core.streams.ReadStream
blockingStream, collect, pipe, pipeTo
-
-
-
-
Method Detail
-
exceptionHandler
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
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
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
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
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
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
String address()
The listened address.- Returns:
- the address, not
null
-
close
Future<Void> close()
Closes the receiver.- Returns:
- a future notified when the receiver has been closed
-
connection
AmqpConnection connection()
Gets the connection having created the receiver. Cannot benull- Returns:
- the connection having created the receiver.
-
unwrap
io.vertx.proton.ProtonReceiver unwrap()
- Returns:
- the underlying ProtonReceiver.
-
-