io.aeron

Class ChannelUriStringBuilder

java.lang.Object

io.aeron.ChannelUriStringBuilder

public class ChannelUriStringBuilder
extends java.lang.Object

Type safe 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 java.lang.String	TAG_PREFIX

Constructor Summary

Constructors

Constructor and Description
ChannelUriStringBuilder()

Method Summary

Modifier and Type	Method and Description
java.lang.String	alias() Get the alias present in the URI.
ChannelUriStringBuilder	alias(java.lang.String alias) Set the alias for a URI.
java.lang.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.
java.lang.String	controlEndpoint() Get the control address:port pair for dynamically joining a multi-destination-cast publication.
ChannelUriStringBuilder	controlEndpoint(java.lang.String controlEndpoint) Set the control address:port pair for dynamically joining a multi-destination-cast publication.
java.lang.String	controlMode() Get the control mode for multi-destination-cast.
ChannelUriStringBuilder	controlMode(java.lang.String controlMode) Set the control mode for multi-destination-cast.
java.lang.String	endpoint() Get the endpoint address:port pairing for the channel.
ChannelUriStringBuilder	endpoint(java.lang.String endpoint) Set the endpoint address:port pairing for the channel.
ChannelUriStringBuilder	initialPosition(long position, int initialTermId, int termLength) Initialise a channel for restarting a publication at a given position.
java.lang.Integer	initialTermId() the initial term id at which a publication will start.
ChannelUriStringBuilder	initialTermId(java.lang.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.
java.lang.Long	linger() Get the time a network publication will linger in nanoseconds after being drained.
ChannelUriStringBuilder	linger(java.lang.Long lingerNs) Set the time a network publication will linger in nanoseconds after being drained.
java.lang.String	media() The media over which the channel transmits.
ChannelUriStringBuilder	media(java.lang.String media) Set the media for this channel.
java.lang.Integer	mtu() Get the maximum transmission unit (MTU) including Aeron header for a datagram payload.
ChannelUriStringBuilder	mtu(java.lang.Integer mtu) Set the maximum transmission unit (MTU) including Aeron header for a datagram payload.
java.lang.String	networkInterface() Get the address of the local interface in the form host:[port]/[subnet mask] for routing traffic.
ChannelUriStringBuilder	networkInterface(java.lang.String networkInterface) Set the address of the local interface in the form host:[port]/[subnet mask] for routing traffic.
java.lang.String	prefix() Get the prefix for the additional action to be taken on the request.
ChannelUriStringBuilder	prefix(java.lang.String prefix) Set the prefix for taking an addition action such as spying on an outgoing publication with "aeron-spy".
java.lang.Boolean	reliable() Get the subscription semantics for if loss is acceptable, or not, for a reliable message delivery.
ChannelUriStringBuilder	reliable(java.lang.Boolean isReliable) Set the subscription semantics for if loss is acceptable, or not, for a reliable message delivery.
java.lang.Integer	sessionId() Get the session id for a publication or restricted subscription.
ChannelUriStringBuilder	sessionId(java.lang.Integer sessionId) Set the session id for a publication or restricted subscription.
java.lang.Boolean	sparse() Get if a term log buffer should be sparse on disk or not.
ChannelUriStringBuilder	sparse(java.lang.Boolean isSparse) Set to indicate if a term log buffer should be sparse on disk or not.
java.lang.String	tags() Get the tags for a channel used by a publication or subscription.
ChannelUriStringBuilder	tags(java.lang.String tags) Set the tags for a channel used by a publication or subscription.
java.lang.Integer	termId() Get the current term id at which a publication will start.
ChannelUriStringBuilder	termId(java.lang.Integer termId) Set the current term id at which a publication will start.
java.lang.Integer	termLength() Get the length of buffer used for each term of the log.
ChannelUriStringBuilder	termLength(java.lang.Integer termLength) Set the length of buffer used for each term of the log.
java.lang.Integer	termOffset() Get the offset within a term at which a publication will start.
ChannelUriStringBuilder	termOffset(java.lang.Integer termOffset) Set the offset within a term at which a publication will start.
java.lang.Integer	ttl() Get the Time To Live (TTL) for a multicast datagram.
ChannelUriStringBuilder	ttl(java.lang.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, toString, wait, wait, wait

Field Detail

TAG_PREFIX

public static final java.lang.String TAG_PREFIX

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:

java.lang.IllegalStateException - if the combination of params is invalid.

prefix

public ChannelUriStringBuilder prefix(java.lang.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 java.lang.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(java.lang.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 java.lang.String media()

The media over which the channel transmits.

Returns:

the media over which the channel transmits.

endpoint

public ChannelUriStringBuilder endpoint(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.Boolean sparse()

Get if a term log buffer should 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

tags

public ChannelUriStringBuilder tags(java.lang.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 java.lang.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(java.lang.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 java.lang.String alias()

Get the alias present in the URI.

Returns:

alias for the URI.

See Also:

CommonContext.ALIAS_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 java.lang.String build()

Build a channel URI String for the given parameters.

Returns:

a channel URI String for the given parameters.