io.vertx.proton.streams

Class ProtonPublisherOptions

java.lang.Object

io.vertx.proton.streams.ProtonPublisherOptions

public class ProtonPublisherOptions
extends Object

Options for configuring Publisher attributes.

Constructor Summary

Constructors

Constructor and Description
ProtonPublisherOptions()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getLinkName()
int	getMaxOutstandingCredit()
int	hashCode()
boolean	isDurable()
boolean	isDynamic()
boolean	isGlobal()
boolean	isShared()
ProtonPublisherOptions	setDurable(boolean durable) Sets whether the link to be used for the subscription should have 'source' terminus details indicating it is durable, that is a terminus-expiry-policy of "never" and terminus-durability of 2/unsettled-state, and that the link should detach rather than close when cancel is called on the subscription.
ProtonPublisherOptions	setDynamic(boolean dynamic) Sets whether the link to be used for the subscription should indicate a 'dynamic' source terminus, requesting the server peer names it with a dynamic address.
ProtonPublisherOptions	setGlobal(boolean global) Sets whether the link to be used for a shared subscription should also have 'source' terminus capability indicating it is 'global', that is its subscription can be shared across connections regardless of their container-id values.
ProtonPublisherOptions	setLinkName(String linkName) Sets the link name to be used for the subscription.
ProtonPublisherOptions	setMaxOutstandingCredit(int maxOutstandingCredit) Sets the maximum credit the consumer link will leave outstanding at a time.
ProtonPublisherOptions	setShared(boolean shared) Sets whether the link to be used for the subscription should have 'source' terminus capability indicating it is 'shared'.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProtonPublisherOptions

public ProtonPublisherOptions()

Method Detail

setLinkName

public ProtonPublisherOptions setLinkName(String linkName)

Sets the link name to be used for the subscription.

Parameters:

linkName - the name to use

Returns:

the options

getLinkName

public String getLinkName()

setDurable

public ProtonPublisherOptions setDurable(boolean durable)

Sets whether the link to be used for the subscription should have 'source' terminus details indicating it is durable, that is a terminus-expiry-policy of "never" and terminus-durability of 2/unsettled-state, and that the link should detach rather than close when cancel is called on the subscription.

Parameters:

durable - true if the subscription should be considered durable

Returns:

the options

isDurable

public boolean isDurable()

setShared

public ProtonPublisherOptions setShared(boolean shared)

Sets whether the link to be used for the subscription should have 'source' terminus capability indicating it is 'shared'.

Parameters:

shared - true if the subscription should be considered shared

Returns:

the options

isShared

public boolean isShared()

setGlobal

public ProtonPublisherOptions setGlobal(boolean global)

Sets whether the link to be used for a shared subscription should also have 'source' terminus capability indicating it is 'global', that is its subscription can be shared across connections regardless of their container-id values.

Parameters:

global - true if the subscription should be considered global

Returns:

the options

isGlobal

public boolean isGlobal()

setDynamic

public ProtonPublisherOptions setDynamic(boolean dynamic)

Sets whether the link to be used for the subscription should indicate a 'dynamic' source terminus, requesting the server peer names it with a dynamic address. The remote address can then be inspected using ProtonPublisher.getRemoteAddress() (or inspecting the remote source details directly) when the onSubscribe() handler is fired.

Parameters:

dynamic - true if the link should request a dynamic source address

Returns:

the options

isDynamic

public boolean isDynamic()

setMaxOutstandingCredit

public ProtonPublisherOptions setMaxOutstandingCredit(int maxOutstandingCredit)

Sets the maximum credit the consumer link will leave outstanding at a time. If the total unfilled subscription requests remains below this level, the consumer credit issued will match the unfilled requests. If the requests exceeds this value, the consumer link will cap it and refresh it once the level drops below a threshold or more requests are made. If not set a reasonable default is used.

Parameters:

maxOutstandingCredit - the limit on outstanding consumer credit

Returns:

the options

getMaxOutstandingCredit

public int getMaxOutstandingCredit()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object