io.vertx.core.eventbus.MessageConsumer Maven / Gradle / Ivy
/*
* Copyright (c) 2011-2014 The original author or authors
* ------------------------------------------------------
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* and Apache License v2.0 which accompanies this distribution.
*
* The Eclipse Public License is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* The Apache License v2.0 is available at
* http://www.opensource.org/licenses/apache2.0.php
*
* You may elect to redistribute this code under either of these licenses.
*/
package io.vertx.core.eventbus;
import io.vertx.codegen.annotations.VertxGen;
import io.vertx.core.AsyncResult;
import io.vertx.core.Handler;
import io.vertx.core.streams.ReadStream;
/**
* An event bus consumer object representing a stream of message to an {@link EventBus} address that can
* be read from.
*
* The {@link EventBus#consumer(String)} or {@link EventBus#localConsumer(String)}
* creates a new consumer, the returned consumer is not yet registered against the event bus. Registration
* is effective after the {@link #handler(io.vertx.core.Handler)} method is invoked.
*
* The consumer is unregistered from the event bus using the {@link #unregister()} method or by calling the
* {@link #handler(io.vertx.core.Handler)} with a null value..
*
* @author Nick Scavelli
*/
@VertxGen
public interface MessageConsumer extends ReadStream> {
@Override
MessageConsumer exceptionHandler(Handler handler);
@Override
MessageConsumer handler(Handler> handler);
@Override
MessageConsumer pause();
@Override
MessageConsumer resume();
@Override
MessageConsumer endHandler(Handler endHandler);
/**
* @return a read stream for the body of the message stream.
*/
ReadStream bodyStream();
/**
* @return true if the current consumer is registered
*/
boolean isRegistered();
/**
* @return The address the handler was registered with.
*/
String address();
/**
* Set the number of messages this registration will buffer when this stream is paused. The default
* value is 0. When a new value is set, buffered messages may be discarded to reach
* the new value.
*
* @param maxBufferedMessages the maximum number of messages that can be buffered
* @return this registration
*/
MessageConsumer setMaxBufferedMessages(int maxBufferedMessages);
/**
* @return the maximum number of messages that can be buffered when this stream is paused
*/
int getMaxBufferedMessages();
/**
* Optional method which can be called to indicate when the registration has been propagated across the cluster.
*
* @param completionHandler the completion handler
*/
void completionHandler(Handler> completionHandler);
/**
* Unregisters the handler which created this registration
*/
void unregister();
/**
* Unregisters the handler which created this registration
*
* @param completionHandler the handler called when the unregister is done. For example in a cluster when all nodes of the
* event bus have been unregistered.
*/
void unregister(Handler> completionHandler);
}