Top Fields Constructors Methods
io.vertx.core.eventbus

public Class MessageConsumerOptions

extends Object
Class Inheritance
Annotations
@DataObject
@JsonGen
publicConverter:false
Imports
io.vertx.codegen.annotations.DataObject, io.vertx.codegen.json.annotations.JsonGen, io.vertx.core.impl.Arguments, io.vertx.core.json.JsonObject

Field Summary

Modifier and TypeField and Description
private String
address

public static final boolean
DEFAULT_LOCAL_ONLY

public static final int
DEFAULT_MAX_BUFFERED_MESSAGES

private boolean
localOnly

private int
maxBufferedMessages

Constructor Summary

AccessConstructor and Description
public
MessageConsumerOptions()

public
MessageConsumerOptions(MessageConsumerOptions options)

public
MessageConsumerOptions(JsonObject json)
References Deprecated JsonObject is deprecated or references (maybe indirectly) at least one deprecated element.

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the address the event-bus will register the consumer at
getAddress()

public int

Returns:

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

public boolean

Returns:

whether the consumer is local only
isLocalOnly()

public MessageConsumerOptions

Returns:

this options
setAddress(String
the consumer address
address)

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

public MessageConsumerOptions

Returns:

this options
setLocalOnly(boolean
whether the consumer is local only
localOnly)

Set whether the consumer is local only.

public MessageConsumerOptions

Returns:

this options
setMaxBufferedMessages(int
the maximum number of messages that can be buffered
maxBufferedMessages)

Set the number of messages this registration will buffer when this stream is paused.

public JsonObject
toJson()
References Deprecated JsonObject is deprecated or references (maybe indirectly) at least one deprecated element.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

addressback to summary
private String address
DEFAULT_LOCAL_ONLYback to summary
public static final boolean DEFAULT_LOCAL_ONLY
DEFAULT_MAX_BUFFERED_MESSAGESback to summary
public static final int DEFAULT_MAX_BUFFERED_MESSAGES
localOnlyback to summary
private boolean localOnly
maxBufferedMessagesback to summary
private int maxBufferedMessages

Constructor Detail

MessageConsumerOptionsback to summary
public MessageConsumerOptions()
MessageConsumerOptionsback to summary
public MessageConsumerOptions(MessageConsumerOptions options)
MessageConsumerOptionsback to summary
public MessageConsumerOptions(JsonObject json)

References Deprecated

JsonObject is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Method Detail

getAddressback to summary
public String getAddress()
Returns:String

the address the event-bus will register the consumer at

getMaxBufferedMessagesback to summary
public int getMaxBufferedMessages()
Returns:int

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

isLocalOnlyback to summary
public boolean isLocalOnly()
Returns:boolean

whether the consumer is local only

setAddressback to summary
public MessageConsumerOptions setAddress(String address)

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

Parameters
address:String

the consumer address

Returns:MessageConsumerOptions

this options

setLocalOnlyback to summary
public MessageConsumerOptions setLocalOnly(boolean localOnly)

Set whether the consumer is local only.

Parameters
localOnly:boolean

whether the consumer is local only

Returns:MessageConsumerOptions

this options

setMaxBufferedMessagesback to summary
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:int

the maximum number of messages that can be buffered

Returns:MessageConsumerOptions

this options

toJsonback to summary
public JsonObject toJson()

References Deprecated

JsonObject is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.