Package io.vertx.core.eventbus
Interface MessageConsumer<T>
-
- All Superinterfaces:
ReadStream<Message<T>>,StreamBase
public interface MessageConsumer<T> extends ReadStream<Message<T>>
An event bus consumer object representing a stream of message to anEventBusaddress that can be read from.The
EventBus.consumer(String)orEventBus.localConsumer(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)method is invoked.The consumer is unregistered from the event bus using the
unregister()method or by calling thehandler(io.vertx.core.Handler)with a null value..- Author:
- Nick Scavelli
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Stringaddress()ReadStream<T>bodyStream()Future<Void>completion()MessageConsumer<T>endHandler(Handler<Void> endHandler)Set an end handler.MessageConsumer<T>exceptionHandler(Handler<Throwable> handler)Set an exception handler on the read stream.MessageConsumer<T>fetch(long amount)Fetch the specifiedamountof elements.MessageConsumer<T>handler(Handler<Message<T>> handler)Set a data handler.booleanisRegistered()MessageConsumer<T>pause()Pause theReadStream, it sets the buffer infetchmode and clears the actual demand.MessageConsumer<T>resume()Resume reading, and sets the buffer inflowingmode.Future<Void>unregister()Unregisters the handler which created this registration-
Methods inherited from interface io.vertx.core.streams.ReadStream
blockingStream, collect, pipe, pipeTo
-
-
-
-
Method Detail
-
exceptionHandler
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
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
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
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
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
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
ReadStream<T> bodyStream()
- Returns:
- a read stream for the body of the message stream.
-
isRegistered
boolean isRegistered()
- Returns:
- true if the current consumer is registered
-
address
String address()
- Returns:
- The address the handler was registered with.
-
completion
Future<Void> completion()
- Returns:
- a future notified when the message consumer is registered
-
-