io.vertx.core.eventbus

Class MessageConsumerOptions

java.lang.Object

io.vertx.core.eventbus.MessageConsumerOptions

public class MessageConsumerOptions
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_LOCAL_ONLY
static int	DEFAULT_MAX_BUFFERED_MESSAGES

Constructor Summary

Constructors

Constructor and Description
MessageConsumerOptions()
MessageConsumerOptions(JsonObject json)
MessageConsumerOptions(MessageConsumerOptions options)

Method Summary

Modifier and Type	Method and Description
String	getAddress()
int	getMaxBufferedMessages()
boolean	isLocalOnly()
MessageConsumerOptions	setAddress(String address) Set the address the event-bus will register the consumer at.
MessageConsumerOptions	setLocalOnly(boolean localOnly) Set whether the consumer is local only.
MessageConsumerOptions	setMaxBufferedMessages(int maxBufferedMessages) Set the number of messages this registration will buffer when this stream is paused.
JsonObject	toJson()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_MAX_BUFFERED_MESSAGES

public static final int DEFAULT_MAX_BUFFERED_MESSAGES

See Also:

Constant Field Values

DEFAULT_LOCAL_ONLY

public static final boolean DEFAULT_LOCAL_ONLY

See Also:

Constant Field Values

Constructor Detail

MessageConsumerOptions

public MessageConsumerOptions()

MessageConsumerOptions

public MessageConsumerOptions(MessageConsumerOptions options)

MessageConsumerOptions

public MessageConsumerOptions(JsonObject json)

Method Detail

getAddress

public String getAddress()

Returns:

the address the event-bus will register the consumer at

setAddress

public MessageConsumerOptions setAddress(String address)

Set the address the event-bus will register the consumer at.

Parameters:

address - the consumer address

Returns:

this options

isLocalOnly

public boolean isLocalOnly()

Returns:

whether the consumer is local only

setLocalOnly

public MessageConsumerOptions setLocalOnly(boolean localOnly)

Set whether the consumer is local only.

Parameters:

localOnly - whether the consumer is local only

Returns:

this options

getMaxBufferedMessages

public int getMaxBufferedMessages()

Returns:

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

setMaxBufferedMessages

public MessageConsumerOptions setMaxBufferedMessages(int maxBufferedMessages)

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

Returns:

this options

toJson

public JsonObject toJson()