ChannelUriStringBuilder (Aeron Message Transport)

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

Constructor Summary

Constructors
Constructor and Description

ChannelUriStringBuilder()

Constructors
Constructor and Description
`ChannelUriStringBuilder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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.
`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.
`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`	`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

- 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.
  - 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.
  - endpoint
```
public java.lang.String endpoint()
```
    Get the endpoint address:port pairing for the channel.
    
    Returns:
    
    the endpoint address:port pairing for the channel.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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)
  - controlMode
```
public java.lang.String controlMode()
```
    Get the control mode for multi-destination-cast.
    
    Returns:
    
    the control mode for multi-destination-cast.
  - 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.
  - 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.
  - 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.
  - 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.
  - mtu
```
public ChannelUriStringBuilder mtu(java.lang.Integer mtu)
```
    Set the maximum transmission unit (MTU) including Aeron header for a datagram payload.
    
    Parameters:
    
    mtu - the maximum transmission unit including Aeron header for a datagram payload.
    
    Returns:
    
    this for a fluent API.
  - mtu
```
public java.lang.Integer mtu()
```
    Get the maximum transmission unit (MTU) including Aeron header for a datagram payload.
    
    Returns:
    
    the maximum transmission unit (MTU) including Aeron header for a datagram payload.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - build
```
public java.lang.String build()
```
    Build a channel URI String for the given parameters.
    
    Returns:
    
    a channel URI String for the given parameters.

Class ChannelUriStringBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ChannelUriStringBuilder

Method Detail

clear

validate

prefix

prefix

media

media

endpoint

endpoint

networkInterface

networkInterface

controlEndpoint

controlEndpoint

controlMode

controlMode

reliable

reliable

ttl

ttl

mtu

mtu

termLength

termLength

initialTermId

initialTermId

termId

termId

termOffset

termOffset

build