io.aeron

Class ChannelUriStringBuilder

java.lang.Object

io.aeron.ChannelUriStringBuilder

public final class ChannelUriStringBuilder
extends Object

Typesafe means of building a channel URI associated with a Publication or Subscription.

See Also:

Aeron.addPublication(String, int), Aeron.addSubscription(String, int), ChannelUri

Field Summary

Fields

Modifier and Type	Field and Description
static String	TAG_PREFIX Can be used when the likes of session-id wants to reference another entity such as a tagged publication.

Constructor Summary

Constructors

Constructor and Description
ChannelUriStringBuilder()

Method Summary

Modifier and Type	Method and Description
String	alias() Get the alias present in the URI.
ChannelUriStringBuilder	alias(ChannelUri channelUri) Set the alias to be value which is in the ChannelUri which may be null.
ChannelUriStringBuilder	alias(String alias) Set the alias for a URI.
String	build() Build a channel URI String for the given parameters.
ChannelUriStringBuilder	clear() Clear out all the values thus setting back to the initial state.
String	congestionControl() Get the congestion control algorithm to be used on a stream.
ChannelUriStringBuilder	congestionControl(ChannelUri channelUri) Set the congestion control to be value which is in the ChannelUri which may be null.
ChannelUriStringBuilder	congestionControl(String congestionControl) Set the congestion control algorithm to be used on a stream.
String	controlEndpoint() Get the control address:port pair for dynamically joining a multi-destination-cast publication.
ChannelUriStringBuilder	controlEndpoint(ChannelUri channelUri) Set the control endpoint value to be what is in the ChannelUri which may be null.
ChannelUriStringBuilder	controlEndpoint(String controlEndpoint) Set the control address:port pair for dynamically joining a multi-destination-cast publication.
String	controlMode() Get the control mode for multi-destination-cast.
ChannelUriStringBuilder	controlMode(ChannelUri channelUri) Set the control mode to be what is in the ChannelUri which may be null.
ChannelUriStringBuilder	controlMode(String controlMode) Set the control mode for multi-destination-cast.
String	endpoint() Get the endpoint address:port pairing for the channel.
ChannelUriStringBuilder	endpoint(ChannelUri channelUri) Set the endpoint value to be what is in the ChannelUri which may be null.
ChannelUriStringBuilder	endpoint(String endpoint) Set the endpoint address:port pairing for the channel.
Boolean	eos() Should an EOS flag be sent on the media or not.
ChannelUriStringBuilder	eos(Boolean eos) Set to indicate if an EOS should be sent on the media or not.
ChannelUriStringBuilder	eos(ChannelUri channelUri) Set the eos value to be what is in the ChannelUri which may be null.
String	flowControl() Get the flow control strategy to be used on a stream.
ChannelUriStringBuilder	flowControl(ChannelUri channelUri) Set the flow control to be value which is in the ChannelUri which may be null.
ChannelUriStringBuilder	flowControl(String flowControl) Set the flow control strategy to be used on a stream.
Boolean	group() Is the receiver likely to be part of a group.
ChannelUriStringBuilder	group(Boolean group) Is the receiver likely to be part of a group.
ChannelUriStringBuilder	group(ChannelUri channelUri) Set the group value to be what is in the ChannelUri which may be null.
Long	groupTag() Get the group tag (gtag) to be sent in SMs (Status Messages).
ChannelUriStringBuilder	groupTag(ChannelUri channelUri) Set the group tag (gtag) to be the value which is in the ChannelUri which may be null.
ChannelUriStringBuilder	groupTag(Long groupTag) Set the group tag (gtag) to be sent in SMs (Status Messages).
ChannelUriStringBuilder	initialPosition(long position, int initialTermId, int termLength) Initialise a channel for restarting a publication at a given position.
Integer	initialTermId() the initial term id at which a publication will start.
ChannelUriStringBuilder	initialTermId(ChannelUri channelUri) Set the initialTermId value to be what is in the ChannelUri which may be null.
ChannelUriStringBuilder	initialTermId(Integer initialTermId) Set the initial term id at which a publication will start.
boolean	isSessionIdTagged() Is the value for sessionId() a tagged.
ChannelUriStringBuilder	isSessionIdTagged(boolean isSessionIdTagged) Toggle the value for sessionId() being tagged or not.
Long	linger() Get the time a network publication will linger in nanoseconds after being drained.
ChannelUriStringBuilder	linger(ChannelUri channelUri) Set the linger value to be what is in the ChannelUri which may be null.
ChannelUriStringBuilder	linger(Long lingerNs) Set the time a network publication will linger in nanoseconds after being drained.
String	media() The media over which the channel transmits.
ChannelUriStringBuilder	media(ChannelUri channelUri) Set the endpoint value to be what is in the ChannelUri.
ChannelUriStringBuilder	media(String media) Set the media for this channel.
ChannelUriStringBuilder	minFlowControl(Integer minGroupSize, String timeout) Set min flow control settings to be used on stream.
Integer	mtu() Get the maximum transmission unit (MTU) including Aeron header for a datagram payload.
ChannelUriStringBuilder	mtu(ChannelUri channelUri) Set the mtu value to be what is in the ChannelUri which may be null.
ChannelUriStringBuilder	mtu(Integer mtu) Set the maximum transmission unit (MTU) including Aeron header for a datagram payload.
String	networkInterface() Get the address of the local interface in the form host:[port]/[subnet mask] for routing traffic.
ChannelUriStringBuilder	networkInterface(ChannelUri channelUri) Set the network interface value to be what is in the ChannelUri which may be null.
ChannelUriStringBuilder	networkInterface(String networkInterface) Set the address of the local interface in the form host:[port]/[subnet mask] for routing traffic.
String	prefix() Get the prefix for the additional action to be taken on the request.
ChannelUriStringBuilder	prefix(ChannelUri channelUri) Set the prefix value to be what is in the ChannelUri.
ChannelUriStringBuilder	prefix(String prefix) Set the prefix for taking an addition action such as spying on an outgoing publication with "aeron-spy".
Boolean	rejoin() Get the subscription semantics for if a stream should be rejoined after going unavailable.
ChannelUriStringBuilder	rejoin(Boolean rejoin) Set the subscription semantics for if a stream should be rejoined after going unavailable.
ChannelUriStringBuilder	rejoin(ChannelUri channelUri) Set the rejoin value to be what is in the ChannelUri which may be null.
Boolean	reliable() Get the subscription semantics for if loss is acceptable, or not, for a reliable message delivery.
ChannelUriStringBuilder	reliable(Boolean isReliable) Set the subscription semantics for if loss is acceptable, or not, for a reliable message delivery.
ChannelUriStringBuilder	reliable(ChannelUri channelUri) Set the reliable value to be what is in the ChannelUri which may be null.
Integer	sessionId() Get the session id for a publication or restricted subscription.
ChannelUriStringBuilder	sessionId(ChannelUri channelUri) Set the sessionId value to be what is in the ChannelUri which may be null.
ChannelUriStringBuilder	sessionId(Integer sessionId) Set the session id for a publication or restricted subscription.
Boolean	sparse() Should term log buffer be sparse on disk or not.
ChannelUriStringBuilder	sparse(Boolean isSparse) Set to indicate if a term log buffer should be sparse on disk or not.
ChannelUriStringBuilder	sparse(ChannelUri channelUri) Set the sparse value to be what is in the ChannelUri which may be null.
Boolean	spiesSimulateConnection() Get the publication semantics for whether the presence of spy subscriptions simulate a connection.
ChannelUriStringBuilder	spiesSimulateConnection(Boolean spiesSimulateConnection) Set the publication semantics for whether the presence of spy subscriptions simulate a connection.
ChannelUriStringBuilder	spiesSimulateConnection(ChannelUri channelUri) Set the publication semantics for whether the presence of spy subscriptions simulate a connection to be what is in the ChannelUri which may be null.
ChannelUriStringBuilder	taggedFlowControl(Long groupTag, Integer minGroupSize, String timeout) Set tagged flow control settings to be used on a stream.
String	tags() Get the tags for a channel used by a publication or subscription.
ChannelUriStringBuilder	tags(ChannelUri channelUri) Set the tags to be value which is in the ChannelUri which may be null.
ChannelUriStringBuilder	tags(String tags) Set the tags for a channel used by a publication or subscription.
Integer	termId() Get the current term id at which a publication will start.
ChannelUriStringBuilder	termId(ChannelUri channelUri) Set the termId value to be what is in the ChannelUri which may be null.
ChannelUriStringBuilder	termId(Integer termId) Set the current term id at which a publication will start.
Integer	termLength() Get the length of buffer used for each term of the log.
ChannelUriStringBuilder	termLength(ChannelUri channelUri) Set the termLength value to be what is in the ChannelUri which may be null.
ChannelUriStringBuilder	termLength(Integer termLength) Set the length of buffer used for each term of the log.
Integer	termOffset() Get the offset within a term at which a publication will start.
ChannelUriStringBuilder	termOffset(ChannelUri channelUri) Set the termOffset value to be what is in the ChannelUri which may be null.
ChannelUriStringBuilder	termOffset(Integer termOffset) Set the offset within a term at which a publication will start.
Boolean	tether() Should the subscription channel be tethered or not for local flow control.
ChannelUriStringBuilder	tether(Boolean tether) Should the subscription channel be tethered or not for local flow control.
ChannelUriStringBuilder	tether(ChannelUri channelUri) Set the tether value to be what is in the ChannelUri which may be null.
String	toString()
Integer	ttl() Get the Time To Live (TTL) for a multicast datagram.
ChannelUriStringBuilder	ttl(ChannelUri channelUri) Set the ttl value to be what is in the ChannelUri which may be null.
ChannelUriStringBuilder	ttl(Integer ttl) Set the Time To Live (TTL) for a multicast datagram.
ChannelUriStringBuilder	validate() Validates that the collection of set parameters are valid together.

Methods inherited from class java.lang.Object

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

Field Detail

TAG_PREFIX

public static final String TAG_PREFIX

Can be used when the likes of session-id wants to reference another entity such as a tagged publication.

For example session-id=tag:777 where the publication uses tags=777.

See Also:

Constant Field Values

Constructor Detail

ChannelUriStringBuilder

public ChannelUriStringBuilder()

Method Detail

clear

public ChannelUriStringBuilder clear()

Clear out all the values thus setting back to the initial state.

Returns:

this for a fluent API.

validate

public ChannelUriStringBuilder validate()

Validates that the collection of set parameters are valid together.

Returns:

this for a fluent API.

Throws:

IllegalStateException - if the combination of params is invalid.

prefix

public ChannelUriStringBuilder prefix(String prefix)

Set the prefix for taking an addition action such as spying on an outgoing publication with "aeron-spy".

Parameters:

prefix - to be applied to the URI before the the scheme.

Returns:

this for a fluent API.

See Also:

ChannelUri.SPY_QUALIFIER

prefix

public ChannelUriStringBuilder prefix(ChannelUri channelUri)

Set the prefix value to be what is in the ChannelUri.

Parameters:

channelUri - to read the value from.

Returns:

this for a fluent API.

See Also:

ChannelUri.SPY_QUALIFIER

prefix

public String prefix()

Get the prefix for the additional action to be taken on the request.

Returns:

the prefix for the additional action to be taken on the request.

media

public ChannelUriStringBuilder media(String media)

Set the media for this channel. Valid values are "udp" and "ipc".

Parameters:

media - for this channel.

Returns:

this for a fluent API.

media

public ChannelUriStringBuilder media(ChannelUri channelUri)

Set the endpoint value to be what is in the ChannelUri.

Parameters:

channelUri - to read the value from.

Returns:

this for a fluent API.

media

public String media()

The media over which the channel transmits.

Returns:

the media over which the channel transmits.

endpoint

public ChannelUriStringBuilder endpoint(String endpoint)

Set the endpoint address:port pairing for the channel. This is the address the publication sends to and the address the subscription receives from.

Parameters:

endpoint - address and port for the channel.

Returns:

this for a fluent API.

See Also:

CommonContext.ENDPOINT_PARAM_NAME

endpoint

public ChannelUriStringBuilder endpoint(ChannelUri channelUri)

Set the endpoint value to be what is in the ChannelUri which may be null.

Parameters:

channelUri - to read the value from.

Returns:

this for a fluent API.

See Also:

CommonContext.ENDPOINT_PARAM_NAME

endpoint

public String endpoint()

Get the endpoint address:port pairing for the channel.

Returns:

the endpoint address:port pairing for the channel.

See Also:

CommonContext.ENDPOINT_PARAM_NAME

networkInterface

public ChannelUriStringBuilder networkInterface(String networkInterface)

Set the address of the local interface in the form host:[port]/[subnet mask] for routing traffic.

Parameters:

networkInterface - for routing traffic.

Returns:

this for a fluent API.

See Also:

CommonContext.INTERFACE_PARAM_NAME

networkInterface

public ChannelUriStringBuilder networkInterface(ChannelUri channelUri)

Set the network interface value to be what is in the ChannelUri which may be null.

Parameters:

channelUri - to read the value from.

Returns:

this for a fluent API.

See Also:

CommonContext.INTERFACE_PARAM_NAME

networkInterface

public String networkInterface()

Get the address of the local interface in the form host:[port]/[subnet mask] for routing traffic.

Returns:

the address of the local interface in the form host:[port]/[subnet mask] for routing traffic.

See Also:

CommonContext.INTERFACE_PARAM_NAME

controlEndpoint

public ChannelUriStringBuilder controlEndpoint(String controlEndpoint)

Set the control address:port pair for dynamically joining a multi-destination-cast publication.

Parameters:

controlEndpoint - for joining a MDC control socket.

Returns:

this for a fluent API.

See Also:

CommonContext.MDC_CONTROL_PARAM_NAME

controlEndpoint

public ChannelUriStringBuilder controlEndpoint(ChannelUri channelUri)

Set the control endpoint value to be what is in the ChannelUri which may be null.

Parameters:

channelUri - to read the value from.

Returns:

this for a fluent API.

See Also:

CommonContext.MDC_CONTROL_PARAM_NAME

controlEndpoint

public String controlEndpoint()

Get the control address:port pair for dynamically joining a multi-destination-cast publication.

Returns:

the control address:port pair for dynamically joining a multi-destination-cast publication.

See Also:

CommonContext.MDC_CONTROL_PARAM_NAME

controlMode

public ChannelUriStringBuilder controlMode(String controlMode)

Set the control mode for multi-destination-cast. Set to "manual" for allowing control from the publication API.

Parameters:

controlMode - for taking control of MDC.

Returns:

this for a fluent API.

See Also:

Publication.addDestination(String), Publication.removeDestination(String), CommonContext.MDC_CONTROL_MODE_PARAM_NAME, CommonContext.MDC_CONTROL_MODE_MANUAL, CommonContext.MDC_CONTROL_MODE_DYNAMIC

controlMode

public ChannelUriStringBuilder controlMode(ChannelUri channelUri)

Set the control mode to be what is in the ChannelUri which may be null.

Parameters:

channelUri - to read the value from.

Returns:

this for a fluent API.

See Also:

CommonContext.MDC_CONTROL_MODE_PARAM_NAME

controlMode

public String controlMode()

Get the control mode for multi-destination-cast.

Returns:

the control mode for multi-destination-cast.

See Also:

CommonContext.MDC_CONTROL_MODE_PARAM_NAME, CommonContext.MDC_CONTROL_MODE_MANUAL, CommonContext.MDC_CONTROL_MODE_DYNAMIC

reliable

public ChannelUriStringBuilder reliable(Boolean isReliable)

Set the subscription semantics for if loss is acceptable, or not, for a reliable message delivery.

Parameters:

isReliable - false if loss can be be gap filled.

Returns:

this for a fluent API.

See Also:

CommonContext.RELIABLE_STREAM_PARAM_NAME

reliable

public ChannelUriStringBuilder reliable(ChannelUri channelUri)

Set the reliable value to be what is in the ChannelUri which may be null.

Parameters:

channelUri - to read the value from.

Returns:

this for a fluent API.

See Also:

CommonContext.RELIABLE_STREAM_PARAM_NAME

reliable

public Boolean reliable()

Get the subscription semantics for if loss is acceptable, or not, for a reliable message delivery.

Returns:

the subscription semantics for if loss is acceptable, or not, for a reliable message delivery.

See Also:

CommonContext.RELIABLE_STREAM_PARAM_NAME

ttl

public ChannelUriStringBuilder ttl(Integer ttl)

Set the Time To Live (TTL) for a multicast datagram. Valid values are 0-255 for the number of hops the datagram can progress along.

Parameters:

ttl - value for a multicast datagram.

Returns:

this for a fluent API.

See Also:

CommonContext.TTL_PARAM_NAME

ttl

public ChannelUriStringBuilder ttl(ChannelUri channelUri)

Set the ttl value to be what is in the ChannelUri which may be null.

Parameters:

channelUri - to read the value from.

Returns:

this for a fluent API.

See Also:

CommonContext.TTL_PARAM_NAME

ttl

public Integer ttl()

Get the Time To Live (TTL) for a multicast datagram.

Returns:

the Time To Live (TTL) for a multicast datagram.

See Also:

CommonContext.TTL_PARAM_NAME

mtu

public ChannelUriStringBuilder mtu(Integer mtu)

Set the maximum transmission unit (MTU) including Aeron header for a datagram payload. If this is greater than the network MTU for UDP then the packet will be fragmented and can amplify the impact of loss.

Parameters:

mtu - the maximum transmission unit including Aeron header for a datagram payload.

Returns:

this for a fluent API.

See Also:

CommonContext.MTU_LENGTH_PARAM_NAME

mtu

public ChannelUriStringBuilder mtu(ChannelUri channelUri)

Set the mtu value to be what is in the ChannelUri which may be null.

Parameters:

channelUri - to read the value from.

Returns:

this for a fluent API.

See Also:

CommonContext.MTU_LENGTH_PARAM_NAME

mtu

public Integer mtu()

Get the maximum transmission unit (MTU) including Aeron header for a datagram payload. If this is greater than the network MTU for UDP then the packet will be fragmented and can amplify the impact of loss.

Returns:

the maximum transmission unit (MTU) including Aeron header for a datagram payload.

See Also:

CommonContext.MTU_LENGTH_PARAM_NAME

termLength

public ChannelUriStringBuilder termLength(Integer termLength)

Set the length of buffer used for each term of the log. Valid values are powers of 2 in the 64K - 1G range.

Parameters:

termLength - of the buffer used for each term of the log.

Returns:

this for a fluent API.

See Also:

CommonContext.TERM_LENGTH_PARAM_NAME

termLength

public ChannelUriStringBuilder termLength(ChannelUri channelUri)

Set the termLength value to be what is in the ChannelUri which may be null.

Parameters:

channelUri - to read the value from.

Returns:

this for a fluent API.

See Also:

CommonContext.TERM_LENGTH_PARAM_NAME

termLength

public Integer termLength()

Get the length of buffer used for each term of the log.

Returns:

the length of buffer used for each term of the log.

See Also:

CommonContext.TERM_LENGTH_PARAM_NAME

initialTermId

public ChannelUriStringBuilder initialTermId(Integer initialTermId)

Set the initial term id at which a publication will start.

Parameters:

initialTermId - the initial term id at which a publication will start.

Returns:

this for a fluent API.

See Also:

CommonContext.INITIAL_TERM_ID_PARAM_NAME

initialTermId

public ChannelUriStringBuilder initialTermId(ChannelUri channelUri)

Set the initialTermId value to be what is in the ChannelUri which may be null.

Parameters:

channelUri - to read the value from.

Returns:

this for a fluent API.

See Also:

CommonContext.INITIAL_TERM_ID_PARAM_NAME

initialTermId

public Integer initialTermId()

the initial term id at which a publication will start.

Returns:

the initial term id at which a publication will start.

See Also:

CommonContext.INITIAL_TERM_ID_PARAM_NAME

termId

public ChannelUriStringBuilder termId(Integer termId)

Set the current term id at which a publication will start. This when combined with the initial term can establish a starting position.

Parameters:

termId - at which a publication will start.

Returns:

this for a fluent API.

See Also:

CommonContext.TERM_ID_PARAM_NAME

termId

public ChannelUriStringBuilder termId(ChannelUri channelUri)

Set the termId value to be what is in the ChannelUri which may be null.

Parameters:

channelUri - to read the value from.

Returns:

this for a fluent API.

See Also:

CommonContext.TERM_ID_PARAM_NAME

termId

public Integer termId()

Get the current term id at which a publication will start.

Returns:

the current term id at which a publication will start.

See Also:

CommonContext.TERM_ID_PARAM_NAME

termOffset

public ChannelUriStringBuilder termOffset(Integer termOffset)

Set the offset within a term at which a publication will start. This when combined with the term id can establish a starting position.

Parameters:

termOffset - within a term at which a publication will start.

Returns:

this for a fluent API.

See Also:

CommonContext.TERM_OFFSET_PARAM_NAME

termOffset

public ChannelUriStringBuilder termOffset(ChannelUri channelUri)

Set the termOffset value to be what is in the ChannelUri which may be null.

Parameters:

channelUri - to read the value from.

Returns:

this for a fluent API.

See Also:

CommonContext.TERM_OFFSET_PARAM_NAME

termOffset

public Integer termOffset()

Get the offset within a term at which a publication will start.

Returns:

the offset within a term at which a publication will start.

See Also:

CommonContext.TERM_OFFSET_PARAM_NAME

sessionId

public ChannelUriStringBuilder sessionId(Integer sessionId)

Set the session id for a publication or restricted subscription.

Parameters:

sessionId - for the publication or a restricted subscription.

Returns:

this for a fluent API.

See Also:

CommonContext.SESSION_ID_PARAM_NAME

sessionId

public ChannelUriStringBuilder sessionId(ChannelUri channelUri)

Set the sessionId value to be what is in the ChannelUri which may be null.

Parameters:

channelUri - to read the value from.

Returns:

this for a fluent API.

See Also:

CommonContext.SESSION_ID_PARAM_NAME

sessionId

public Integer sessionId()

Get the session id for a publication or restricted subscription.

Returns:

the session id for a publication or restricted subscription.

See Also:

CommonContext.SESSION_ID_PARAM_NAME

linger

public ChannelUriStringBuilder linger(Long lingerNs)

Set the time a network publication will linger in nanoseconds after being drained. This time is so that tail loss can be recovered.

Parameters:

lingerNs - time for the publication after it is drained.

Returns:

this for a fluent API.

See Also:

CommonContext.LINGER_PARAM_NAME

linger

public ChannelUriStringBuilder linger(ChannelUri channelUri)

Set the linger value to be what is in the ChannelUri which may be null.

Parameters:

channelUri - to read the value from.

Returns:

this for a fluent API.

See Also:

CommonContext.LINGER_PARAM_NAME

linger

public Long linger()

Get the time a network publication will linger in nanoseconds after being drained. This time is so that tail loss can be recovered.

Returns:

the linger time in nanoseconds a publication will wait around after being drained.

See Also:

CommonContext.LINGER_PARAM_NAME

sparse

public ChannelUriStringBuilder sparse(Boolean isSparse)

Set to indicate if a term log buffer should be sparse on disk or not. Sparse saves space at the potential expense of latency.

Parameters:

isSparse - true if the term buffer log is sparse on disk.

Returns:

this for a fluent API.

See Also:

CommonContext.SPARSE_PARAM_NAME

sparse

public ChannelUriStringBuilder sparse(ChannelUri channelUri)

Set the sparse value to be what is in the ChannelUri which may be null.

Parameters:

channelUri - to read the value from.

Returns:

this for a fluent API.

See Also:

CommonContext.SPARSE_PARAM_NAME

sparse

public Boolean sparse()

Should term log buffer be sparse on disk or not. Sparse saves space at the potential expense of latency.

Returns:

true if the term buffer log is sparse on disk.

See Also:

CommonContext.SPARSE_PARAM_NAME

eos

public ChannelUriStringBuilder eos(Boolean eos)

Set to indicate if an EOS should be sent on the media or not.

Parameters:

eos - true if the EOS should be sent.

Returns:

this for a fluent API.

See Also:

CommonContext.EOS_PARAM_NAME

eos

public ChannelUriStringBuilder eos(ChannelUri channelUri)

Set the eos value to be what is in the ChannelUri which may be null.

Parameters:

channelUri - to read the value from.

Returns:

this for a fluent API.

See Also:

CommonContext.EOS_PARAM_NAME

eos

public Boolean eos()

Should an EOS flag be sent on the media or not.

Returns:

true if the EOS param should be set.

See Also:

CommonContext.EOS_PARAM_NAME

tether

public ChannelUriStringBuilder tether(Boolean tether)

Should the subscription channel be tethered or not for local flow control.

Parameters:

tether - value to be set for the tether param.

Returns:

this for a fluent API.

See Also:

CommonContext.TETHER_PARAM_NAME

tether

public ChannelUriStringBuilder tether(ChannelUri channelUri)

Set the tether value to be what is in the ChannelUri which may be null.

Parameters:

channelUri - to read the value from.

Returns:

this for a fluent API.

See Also:

CommonContext.TETHER_PARAM_NAME

tether

public Boolean tether()

Should the subscription channel be tethered or not for local flow control.

Returns:

value of the tether param.

See Also:

CommonContext.TETHER_PARAM_NAME

group

public ChannelUriStringBuilder group(Boolean group)

Is the receiver likely to be part of a group. This informs behaviour such as loss handling.

Parameters:

group - value to be set for the group param.

Returns:

this for a fluent API.

See Also:

CommonContext.GROUP_PARAM_NAME, controlMode(), controlEndpoint()

group

public ChannelUriStringBuilder group(ChannelUri channelUri)

Set the group value to be what is in the ChannelUri which may be null.

Parameters:

channelUri - to read the value from.

Returns:

this for a fluent API.

See Also:

CommonContext.GROUP_PARAM_NAME

group

public Boolean group()

Is the receiver likely to be part of a group. This informs behaviour such as loss handling.

Returns:

value of the group param.

See Also:

CommonContext.GROUP_PARAM_NAME, controlMode(), controlEndpoint()

tags

public ChannelUriStringBuilder tags(String tags)

Set the tags for a channel used by a publication or subscription. Tags can be used to identify or tag a channel so that a configuration can be referenced and reused.

Parameters:

tags - for the channel, publication or subscription.

Returns:

this for a fluent API.

See Also:

CommonContext.TAGS_PARAM_NAME, CommonContext.TAG_PREFIX

tags

public ChannelUriStringBuilder tags(ChannelUri channelUri)

Set the tags to be value which is in the ChannelUri which may be null.

Parameters:

channelUri - to read the value from.

Returns:

this for a fluent API.

See Also:

CommonContext.TAGS_PARAM_NAME

tags

public String tags()

Get the tags for a channel used by a publication or subscription. Tags can be used to identify or tag a channel so that a configuration can be referenced and reused.

Returns:

the tags for a channel, publication or subscription.

See Also:

CommonContext.TAGS_PARAM_NAME, CommonContext.TAG_PREFIX

isSessionIdTagged

public ChannelUriStringBuilder isSessionIdTagged(boolean isSessionIdTagged)

Toggle the value for sessionId() being tagged or not.

Parameters:

isSessionIdTagged - for session id

Returns:

this for a fluent API.

See Also:

CommonContext.TAGS_PARAM_NAME, CommonContext.TAG_PREFIX

isSessionIdTagged

public boolean isSessionIdTagged()

Is the value for sessionId() a tagged.

Returns:

whether the value for sessionId() a tag reference or not.

See Also:

CommonContext.TAGS_PARAM_NAME, CommonContext.TAG_PREFIX

alias

public ChannelUriStringBuilder alias(String alias)

Set the alias for a URI. Alias's are not interpreted by Aeron and are to be used by the application.

Parameters:

alias - for the URI.

Returns:

this for a fluent API.

See Also:

CommonContext.ALIAS_PARAM_NAME

alias

public ChannelUriStringBuilder alias(ChannelUri channelUri)

Set the alias to be value which is in the ChannelUri which may be null.

Parameters:

channelUri - to read the value from.

Returns:

this for a fluent API.

See Also:

CommonContext.TAGS_PARAM_NAME

alias

public String alias()

Get the alias present in the URI.

Returns:

alias for the URI.

See Also:

CommonContext.ALIAS_PARAM_NAME

congestionControl

public ChannelUriStringBuilder congestionControl(String congestionControl)

Set the congestion control algorithm to be used on a stream.

Parameters:

congestionControl - for the URI.

Returns:

this for a fluent API.

See Also:

CommonContext.CONGESTION_CONTROL_PARAM_NAME

congestionControl

public ChannelUriStringBuilder congestionControl(ChannelUri channelUri)

Set the congestion control to be value which is in the ChannelUri which may be null.

Parameters:

channelUri - to read the value from.

Returns:

this for a fluent API.

See Also:

CommonContext.CONGESTION_CONTROL_PARAM_NAME

congestionControl

public String congestionControl()

Get the congestion control algorithm to be used on a stream.

Returns:

congestion control strategy for the channel.

See Also:

CommonContext.CONGESTION_CONTROL_PARAM_NAME

flowControl

public ChannelUriStringBuilder flowControl(String flowControl)

Set the flow control strategy to be used on a stream.

Parameters:

flowControl - for the URI.

Returns:

this for a fluent API.

See Also:

CommonContext.FLOW_CONTROL_PARAM_NAME

taggedFlowControl

public ChannelUriStringBuilder taggedFlowControl(Long groupTag,
                                                 Integer minGroupSize,
                                                 String timeout)

Set tagged flow control settings to be used on a stream. All specified values may be null and the default specified in the MediaDriver.Context will be used instead.

Parameters:

groupTag - receiver tag for this stream.

minGroupSize - group size required to allow publications for this channel to be move to connected status.

timeout - timeout receivers, default is ns, but allows suffixing of time units (e.g. 5s).

Returns:

this for fluent API.

minFlowControl

public ChannelUriStringBuilder minFlowControl(Integer minGroupSize,
                                              String timeout)

Set min flow control settings to be used on stream. All specified values may be null and the default specified in the MediaDriver.Context will be used instead.

Parameters:

minGroupSize - group size required to allow publications for this stream to be move to connected status.

timeout - timeout receivers, default is ns, but allows suffixing of time units (e.g. 5s).

Returns:

this for fluent API.

flowControl

public ChannelUriStringBuilder flowControl(ChannelUri channelUri)

Set the flow control to be value which is in the ChannelUri which may be null.

Parameters:

channelUri - to read the value from.

Returns:

this for a fluent API.

See Also:

CommonContext.FLOW_CONTROL_PARAM_NAME

flowControl

public String flowControl()

Get the flow control strategy to be used on a stream.

Returns:

flow control strategy for the stream.

See Also:

CommonContext.FLOW_CONTROL_PARAM_NAME

groupTag

public ChannelUriStringBuilder groupTag(Long groupTag)

Set the group tag (gtag) to be sent in SMs (Status Messages).

Parameters:

groupTag - to be sent in SMs

Returns:

this for fluent API.

See Also:

CommonContext.GROUP_TAG_PARAM_NAME

groupTag

public ChannelUriStringBuilder groupTag(ChannelUri channelUri)

Set the group tag (gtag) to be the value which is in the ChannelUri which may be null.

Parameters:

channelUri - to read the value from.

Returns:

this for a fluent API.

See Also:

CommonContext.GROUP_TAG_PARAM_NAME

groupTag

public Long groupTag()

Get the group tag (gtag) to be sent in SMs (Status Messages).

Returns:

receiver tag to be sent in SMs.

See Also:

CommonContext.GROUP_TAG_PARAM_NAME

rejoin

public ChannelUriStringBuilder rejoin(Boolean rejoin)

Set the subscription semantics for if a stream should be rejoined after going unavailable.

Parameters:

rejoin - false if stream is not to be rejoined.

Returns:

this for a fluent API.

See Also:

CommonContext.REJOIN_PARAM_NAME

rejoin

public ChannelUriStringBuilder rejoin(ChannelUri channelUri)

Set the rejoin value to be what is in the ChannelUri which may be null.

Parameters:

channelUri - to read the value from.

Returns:

this for a fluent API.

See Also:

CommonContext.REJOIN_PARAM_NAME

rejoin

public Boolean rejoin()

Get the subscription semantics for if a stream should be rejoined after going unavailable.

Returns:

the subscription semantics for if a stream should be rejoined after going unavailable.

See Also:

CommonContext.REJOIN_PARAM_NAME

spiesSimulateConnection

public ChannelUriStringBuilder spiesSimulateConnection(Boolean spiesSimulateConnection)

Set the publication semantics for whether the presence of spy subscriptions simulate a connection.

Parameters:

spiesSimulateConnection - true if the presence of spy subscriptions simulate a connection.

Returns:

this for a fluent API.

See Also:

CommonContext.SPIES_SIMULATE_CONNECTION_PARAM_NAME

spiesSimulateConnection

public ChannelUriStringBuilder spiesSimulateConnection(ChannelUri channelUri)

Set the publication semantics for whether the presence of spy subscriptions simulate a connection to be what is in the ChannelUri which may be null.

Parameters:

channelUri - to read the value from.

Returns:

this for a fluent API.

See Also:

CommonContext.SPIES_SIMULATE_CONNECTION_PARAM_NAME

spiesSimulateConnection

public Boolean spiesSimulateConnection()

Get the publication semantics for whether the presence of spy subscriptions simulate a connection.

Returns:

true if the presence of spy subscriptions simulate a connection, otherwise false.

See Also:

CommonContext.SPIES_SIMULATE_CONNECTION_PARAM_NAME

initialPosition

public ChannelUriStringBuilder initialPosition(long position,
                                               int initialTermId,
                                               int termLength)

Initialise a channel for restarting a publication at a given position.

Parameters:

position - at which the publication should be started.

initialTermId - what which the stream would start.

termLength - for the stream.

Returns:

this for a fluent API.

build

public String build()

Build a channel URI String for the given parameters.

Returns:

a channel URI String for the given parameters.

toString

public String toString()

Overrides:

toString in class Object