Vert.x 4.5.13 · io.vertx.core.eventbus.impl.MessageConsumerImpl

Modifier and Type	Field and Description
private final String	address Hides io.vertx.core.eventbus.impl.HandlerRegistration.address.
private Handler<AsyncResult<Void>>	completionHandler
private final ContextInternal	context Hides io.vertx.core.eventbus.impl.HandlerRegistration.context.
private long	demand
private Handler<Message<T>>	discardHandler
private Handler<Void>	endHandler
private Handler<Message<T>>	handler
private final boolean	localOnly
private static final Logger	log
private int	maxBufferedMessages
private Queue<Message<T>>	pending
private Promise<Void>	result
private final Vertx	vertx

Access	Constructor and Description
pack-priv	MessageConsumerImpl(Vertx vertx, ContextInternal context, EventBusImpl eventBus, String address, boolean localOnly, int maxBufferedMessages)

Method Summary

Modifier and Type	Method and Description
public String	address() Implements io.vertx.core.eventbus.MessageConsumer.address.
public ReadStream<T>	bodyStream() Implements io.vertx.core.eventbus.MessageConsumer.bodyStream.
private synchronized void	checkNextTick()
public synchronized void	completionHandler(Handler<AsyncResult<Void>> the completion handler handler) Implements io.vertx.core.eventbus.MessageConsumer.completionHandler. Optional method which can be called to indicate when the registration has been propagated across the cluster.
private void	deliver(Handler<Message<T>> theHandler, Message<T> message)
public synchronized void	discardHandler(Handler<Message<T>> handler)
protected void	dispatch(Message<T> msg, ContextInternal context, Handler<Message<T>> handler) Implements abstract io.vertx.core.eventbus.impl.HandlerRegistration.dispatch.
protected boolean	doReceive(Message<T> message) Implements abstract io.vertx.core.eventbus.impl.HandlerRegistration.doReceive.
public synchronized MessageConsumer<T>	endHandler(Handler<Void> endHandler) Implements io.vertx.core.eventbus.MessageConsumer.endHandler.
public synchronized MessageConsumer<T>	exceptionHandler(Handler<Throwable> handler) Implements io.vertx.core.eventbus.MessageConsumer.exceptionHandler.
public synchronized MessageConsumer<T>	fetch(long amount) Implements io.vertx.core.eventbus.MessageConsumer.fetch. Fetch the specified `amount` of elements.
public synchronized Handler<Message<T>>	getHandler()
public synchronized int	getMaxBufferedMessages() Implements io.vertx.core.eventbus.MessageConsumer.getMaxBufferedMessages.
public synchronized MessageConsumer<T>	handler(Handler<Message<T>> h) Implements io.vertx.core.eventbus.MessageConsumer.handler.
public synchronized MessageConsumer<T>	pause() Implements io.vertx.core.eventbus.MessageConsumer.pause. Pause the `ReadStream`, it sets the buffer in `fetch` mode and clears the actual demand.
public MessageConsumer<T>	resume() Implements io.vertx.core.eventbus.MessageConsumer.resume. Resume reading, and sets the buffer in `flowing` mode.
public MessageConsumer<T>	setMaxBufferedMessages(int the maximum number of messages that can be buffered maxBufferedMessages) Implements io.vertx.core.eventbus.MessageConsumer.setMaxBufferedMessages. Set the number of messages this registration will buffer when this stream is paused.
public synchronized Future<Void>	unregister() Overrides io.vertx.core.eventbus.impl.HandlerRegistration.unregister. Implements io.vertx.core.eventbus.MessageConsumer.unregister. Unregisters the handler which created this registration

Inherited from io.vertx.core.eventbus.impl.HandlerRegistration:: close discard dispatch isRegistered receive register unregister

address	back to summary
private final String address Hides io.vertx.core.eventbus.impl.HandlerRegistration.address.

completionHandler	back to summary
private Handler<AsyncResult<Void>> completionHandler

context	back to summary
private final ContextInternal context Hides io.vertx.core.eventbus.impl.HandlerRegistration.context.

demand	back to summary
private long demand

discardHandler	back to summary
private Handler<Message<T>> discardHandler

endHandler	back to summary
private Handler<Void> endHandler

handler	back to summary
private Handler<Message<T>> handler

localOnly	back to summary
private final boolean localOnly

log	back to summary
private static final Logger log

maxBufferedMessages	back to summary
private int maxBufferedMessages

pending	back to summary
private Queue<Message<T>> pending

result	back to summary
private Promise<Void> result

vertx	back to summary
private final Vertx vertx

MessageConsumerImpl	back to summary
pack-priv MessageConsumerImpl(Vertx vertx, ContextInternal context, EventBusImpl eventBus, String address, boolean localOnly, int maxBufferedMessages)

Method Detail

address	back to summary
public String address() Implements io.vertx.core.eventbus.MessageConsumer.address. Returns:String Doc from io.vertx.core.eventbus.MessageConsumer.address. The address the handler was registered with. Annotations @Override

address

back to summary

public String address()

Implements io.vertx.core.eventbus.MessageConsumer.address.

Returns:String

Doc from io.vertx.core.eventbus.MessageConsumer.address.

The address the handler was registered with.

Annotations

@Override

bodyStream	back to summary
public ReadStream<T> bodyStream() Implements io.vertx.core.eventbus.MessageConsumer.bodyStream. Returns:ReadStream<T> Doc from io.vertx.core.eventbus.MessageConsumer.bodyStream. a read stream for the body of the message stream. Annotations @Override

bodyStream

back to summary

public ReadStream<T> bodyStream()

Implements io.vertx.core.eventbus.MessageConsumer.bodyStream.

Returns:ReadStream<T>

Doc from io.vertx.core.eventbus.MessageConsumer.bodyStream.

a read stream for the body of the message stream.

Annotations

@Override

checkNextTick	back to summary
private synchronized void checkNextTick()

completionHandler	back to summary
public synchronized void completionHandler(Handler<AsyncResult<Void>> handler) Implements io.vertx.core.eventbus.MessageConsumer.completionHandler. Doc from io.vertx.core.eventbus.MessageConsumer.completionHandler. Optional method which can be called to indicate when the registration has been propagated across the cluster. Parameters handler:Handler<AsyncResult<Void>> the completion handler Annotations @Override

completionHandler

back to summary

public synchronized void completionHandler(Handler<AsyncResult<Void>> handler)

Implements io.vertx.core.eventbus.MessageConsumer.completionHandler.

Doc from io.vertx.core.eventbus.MessageConsumer.completionHandler.

Optional method which can be called to indicate when the registration has been propagated across the cluster.

Parameters

handler:Handler<AsyncResult<Void>>: the completion handler

Annotations

@Override

deliver	back to summary
private void deliver(Handler<Message<T>> theHandler, Message<T> message)

discardHandler	back to summary
public synchronized void discardHandler(Handler<Message<T>> handler)

dispatch	back to summary
protected void dispatch(Message<T> msg, ContextInternal context, Handler<Message<T>> handler) Implements abstract io.vertx.core.eventbus.impl.HandlerRegistration.dispatch. Annotations @Override

dispatch

back to summary

protected void dispatch(Message<T> msg, ContextInternal context, Handler<Message<T>> handler)

Implements abstract io.vertx.core.eventbus.impl.HandlerRegistration.dispatch.

Annotations

@Override

doReceive	back to summary
protected boolean doReceive(Message<T> message) Implements abstract io.vertx.core.eventbus.impl.HandlerRegistration.doReceive.

endHandler	back to summary
public synchronized MessageConsumer<T> endHandler(Handler<Void> endHandler) Implements io.vertx.core.eventbus.MessageConsumer.endHandler. Annotations @Override

endHandler

back to summary

public synchronized MessageConsumer<T> endHandler(Handler<Void> endHandler)

Implements io.vertx.core.eventbus.MessageConsumer.endHandler.

Annotations

@Override

exceptionHandler	back to summary
public synchronized MessageConsumer<T> exceptionHandler(Handler<Throwable> handler) Implements io.vertx.core.eventbus.MessageConsumer.exceptionHandler. Annotations @Override

exceptionHandler

back to summary

public synchronized MessageConsumer<T> exceptionHandler(Handler<Throwable> handler)

Implements io.vertx.core.eventbus.MessageConsumer.exceptionHandler.

Annotations

@Override

fetch back to summary

fetch	back to summary
public synchronized MessageConsumer<T> fetch(long amount) Implements io.vertx.core.eventbus.MessageConsumer.fetch. Doc from io.vertx.core.streams.ReadStream.fetch. Fetch the specified `amount` of elements. If the `ReadStream` has been paused, reading will recommence with the specified `amount` of items, otherwise the specified `amount` will be added to the current stream demand. Returns:MessageConsumer<T> a reference to this, so the API can be used fluently Annotations @Override

public synchronized MessageConsumer<T> fetch(long amount)

Implements io.vertx.core.eventbus.MessageConsumer.fetch.

Doc from io.vertx.core.streams.ReadStream.fetch.

Fetch the specified amount of elements. If the ReadStream has been paused, reading will recommence with the specified amount of items, otherwise the specified amount will be added to the current stream demand.

Returns:MessageConsumer<T>

a reference to this, so the API can be used fluently

Annotations

@Override

getHandler	back to summary
public synchronized Handler<Message<T>> getHandler()

getMaxBufferedMessages	back to summary
public synchronized int getMaxBufferedMessages() Implements io.vertx.core.eventbus.MessageConsumer.getMaxBufferedMessages. Returns:int Doc from io.vertx.core.eventbus.MessageConsumer.getMaxBufferedMessages. the maximum number of messages that can be buffered when this stream is paused Annotations @Override

getMaxBufferedMessages

back to summary

public synchronized int getMaxBufferedMessages()

Implements io.vertx.core.eventbus.MessageConsumer.getMaxBufferedMessages.

Returns:int

Doc from io.vertx.core.eventbus.MessageConsumer.getMaxBufferedMessages.

the maximum number of messages that can be buffered when this stream is paused

Annotations

@Override

handler	back to summary
public synchronized MessageConsumer<T> handler(Handler<Message<T>> h) Implements io.vertx.core.eventbus.MessageConsumer.handler. Annotations @Override

handler

back to summary

public synchronized MessageConsumer<T> handler(Handler<Message<T>> h)

Implements io.vertx.core.eventbus.MessageConsumer.handler.

Annotations

@Override

pause back to summary

pause	back to summary
public synchronized MessageConsumer<T> pause() Implements io.vertx.core.eventbus.MessageConsumer.pause. Doc from io.vertx.core.streams.ReadStream.pause. Pause the `ReadStream`, it sets the buffer in `fetch` mode and clears the actual demand. While it's paused, no data will be sent to the data `handler`. Returns:MessageConsumer<T> a reference to this, so the API can be used fluently Annotations @Override

public synchronized MessageConsumer<T> pause()

Implements io.vertx.core.eventbus.MessageConsumer.pause.

Doc from io.vertx.core.streams.ReadStream.pause.

Pause the ReadStream, it sets the buffer in fetch mode and clears the actual demand.

While it's paused, no data will be sent to the data handler.

Returns:MessageConsumer<T>

a reference to this, so the API can be used fluently

Annotations

@Override

resume back to summary

resume	back to summary
public MessageConsumer<T> resume() Implements io.vertx.core.eventbus.MessageConsumer.resume. Doc from io.vertx.core.streams.ReadStream.resume. Resume reading, and sets the buffer in `flowing` mode. If the `ReadStream` has been paused, reading will recommence on it. Returns:MessageConsumer<T> a reference to this, so the API can be used fluently Annotations @Override

public MessageConsumer<T> resume()

Implements io.vertx.core.eventbus.MessageConsumer.resume.

Doc from io.vertx.core.streams.ReadStream.resume.

Resume reading, and sets the buffer in flowing mode.

If the ReadStream has been paused, reading will recommence on it.

Returns:MessageConsumer<T>

a reference to this, so the API can be used fluently

Annotations

@Override

setMaxBufferedMessages back to summary

setMaxBufferedMessages	back to summary
public MessageConsumer<T> setMaxBufferedMessages(int maxBufferedMessages) Implements io.vertx.core.eventbus.MessageConsumer.setMaxBufferedMessages. Doc from io.vertx.core.eventbus.MessageConsumer.setMaxBufferedMessages. Set the number of messages this registration will buffer when this stream is paused. The default value is `1000`. 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:int the maximum number of messages that can be buffered Returns:MessageConsumer<T> this registration Annotations @Override

public MessageConsumer<T> setMaxBufferedMessages(int maxBufferedMessages)

Implements io.vertx.core.eventbus.MessageConsumer.setMaxBufferedMessages.

Doc from io.vertx.core.eventbus.MessageConsumer.setMaxBufferedMessages.

Set the number of messages this registration will buffer when this stream is paused. The default value is 1000.

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:int: the maximum number of messages that can be buffered

Returns:MessageConsumer<T>

this registration

Annotations

@Override

unregister	back to summary
public synchronized Future<Void> unregister() Overrides io.vertx.core.eventbus.impl.HandlerRegistration.unregister. Implements io.vertx.core.eventbus.MessageConsumer.unregister. Doc from io.vertx.core.eventbus.MessageConsumer.unregister. Unregisters the handler which created this registration Annotations @Override

unregister

back to summary

public synchronized Future<Void> unregister()

Overrides io.vertx.core.eventbus.impl.HandlerRegistration.unregister.

Implements io.vertx.core.eventbus.MessageConsumer.unregister.

Doc from io.vertx.core.eventbus.MessageConsumer.unregister.

Unregisters the handler which created this registration

Annotations

@Override

public Class MessageConsumerImpl<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail