ChannelUri (Aeron Message Transport)

java.lang.Object
- io.aeron.ChannelUri

public final class ChannelUri
extends Object

Parser for Aeron channel URIs. The format is:

 aeron-uri = "aeron:" media [ "?" param *( "|" param ) ]
 media     = *( "[^?:]" )
 param     = key "=" value
 key       = *( "[^=]" )
 value     = *( "[^|]" )

Multiple params with the same key are allowed, the last value specified takes precedence.

See Also:: ChannelUriStringBuilder

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AERON_SCHEME` URI Scheme for Aeron channels and destinations.
`static long`	`INVALID_TAG` Invalid tag value returned when calling `getTag(String)` and the channel is not tagged.
`static String`	`SPY_QUALIFIER` Qualifier for spy subscriptions which spy on outgoing network destined traffic efficiently.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`addSessionId(String channel, int sessionId)` Add a sessionId to a given channel.
`String`	`channelTag()` Get the channel tag, if it exists, that refers to another channel.
`boolean`	`containsKey(String key)` Does the URI contain a value for the given key.
`static String`	`createDestinationUri(String channel, String endpoint)` Create a channel URI for a destination, i.e.
`String`	`entityTag()` Get the entity tag, if it exists, that refers to an entity such as subscription or publication.
`boolean`	`equals(Object o)`
`String`	`get(String key)` Get a value for a given parameter key.
`String`	`get(String key, String defaultValue)` Get the value for a given parameter key or the default value provided if the key does not exist.
`static long`	`getTag(String paramValue)` Get the value of the tag from a given parameter value.
`int`	`hashCode()`
`void`	`initialPosition(long position, int initialTermId, int termLength)` Initialise a channel for restarting a publication at a given position.
`boolean`	`isIpc()` Is the channel `media()` equal to `CommonContext.IPC_MEDIA`.
`static boolean`	`isTagged(String paramValue)` Is the param value tagged? (starts with the "tag:" prefix).
`boolean`	`isUdp()` Is the channel `media()` equal to `CommonContext.UDP_MEDIA`.
`String`	`media()` The media over which the channel operates.
`ChannelUri`	`media(String media)` Set the media over which the channel operates.
`static ChannelUri`	`parse(CharSequence cs)` Parse a `CharSequence` which contains an Aeron URI.
`String`	`prefix()` The prefix for the channel.
`ChannelUri`	`prefix(String prefix)` Change the prefix from what has been parsed.
`String`	`put(String key, String value)` Put a key and value pair in the map of params.
`String`	`remove(String key)` Remove a key pair in the map of params.
`void`	`replaceEndpointWildcardPort(String resolvedEndpoint)` Uses the supplied endpoint to resolve any wildcard ports.
`String`	`scheme()` The scheme for the URI.
`String`	`toString()` Generate a String representation of the URI that is valid for an Aeron channel.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - AERON_SCHEME
```
public static final String AERON_SCHEME
```
    URI Scheme for Aeron channels and destinations.
    
    See Also:
    
    Constant Field Values
  - SPY_QUALIFIER
```
public static final String SPY_QUALIFIER
```
    Qualifier for spy subscriptions which spy on outgoing network destined traffic efficiently.
    
    See Also:
    
    Constant Field Values
  - INVALID_TAG
```
public static final long INVALID_TAG
```
    Invalid tag value returned when calling getTag(String) and the channel is not tagged.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - prefix
```
public String prefix()
```
    The prefix for the channel.
    
    Returns:
    
    the prefix for the channel.
  - prefix
```
public ChannelUri prefix(String prefix)
```
    Change the prefix from what has been parsed.
    
    Parameters:
    
    prefix - to replace the existing prefix.
    
    Returns:
    
    this for a fluent API.
  - media
```
public String media()
```
    The media over which the channel operates.
    
    Returns:
    
    the media over which the channel operates.
  - media
```
public ChannelUri media(String media)
```
    Set the media over which the channel operates.
    
    Parameters:
    
    media - to replace the parsed value.
    
    Returns:
    
    this for a fluent API.
  - isUdp
```
public boolean isUdp()
```
    Is the channel media() equal to CommonContext.UDP_MEDIA.
    
    Returns:
    
    true the channel media() equals CommonContext.UDP_MEDIA.
  - isIpc
```
public boolean isIpc()
```
    Is the channel media() equal to CommonContext.IPC_MEDIA.
    
    Returns:
    
    true the channel media() equals CommonContext.IPC_MEDIA.
  - scheme
```
public String scheme()
```
    The scheme for the URI. Must be "aeron".
    
    Returns:
    
    the scheme for the URI.
  - get
```
public String get(String key)
```
    Get a value for a given parameter key.
    
    Parameters:
    
    key - to lookup.
    
    Returns:
    
    the value if set for the key otherwise null.
  - get
```
public String get(String key,
                  String defaultValue)
```
    Get the value for a given parameter key or the default value provided if the key does not exist.
    
    Parameters:
    
    key - to lookup.
    
    defaultValue - to be returned if no key match is found.
    
    Returns:
    
    the value if set for the key otherwise the default value provided.
  - put
```
public String put(String key,
                  String value)
```
    Put a key and value pair in the map of params.
    
    Parameters:
    
    key - of the param to be put.
    
    value - of the param to be put.
    
    Returns:
    
    the existing value otherwise null.
  - remove
```
public String remove(String key)
```
    Remove a key pair in the map of params.
    
    Parameters:
    
    key - of the param to be removed.
    
    Returns:
    
    the previous value of the param or null.
  - containsKey
```
public boolean containsKey(String key)
```
    Does the URI contain a value for the given key.
    
    Parameters:
    
    key - to be lookup.
    
    Returns:
    
    true if the key has a value otherwise false.
  - channelTag
```
public String channelTag()
```
    Get the channel tag, if it exists, that refers to another channel.
    
    Returns:
    
    channel tag if it exists or null if not in this URI.
    
    See Also:
    
    CommonContext.TAGS_PARAM_NAME, CommonContext.TAG_PREFIX
  - entityTag
```
public String entityTag()
```
    Get the entity tag, if it exists, that refers to an entity such as subscription or publication.
    
    Returns:
    
    entity tag if it exists or null if not in this URI.
    
    See Also:
    
    CommonContext.TAGS_PARAM_NAME, CommonContext.TAG_PREFIX
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Generate a String representation of the URI that is valid for an Aeron channel.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a String representation of the URI that is valid for an Aeron channel.
  - initialPosition
```
public void 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.
  - parse
```
public static ChannelUri parse(CharSequence cs)
```
    Parse a CharSequence which contains an Aeron URI.
    
    Parameters:
    
    cs - to be parsed.
    
    Returns:
    
    a new ChannelUri representing the URI string.
  - addSessionId
```
public static String addSessionId(String channel,
                                  int sessionId)
```
    Add a sessionId to a given channel.
    
    Parameters:
    
    channel - to add sessionId to.
    
    sessionId - to add to channel.
    
    Returns:
    
    new string that represents channel with sessionId added.
  - isTagged
```
public static boolean isTagged(String paramValue)
```
    Is the param value tagged? (starts with the "tag:" prefix).
    
    Parameters:
    
    paramValue - to check if tagged.
    
    Returns:
    
    true if tagged or false if not.
    
    See Also:
    
    CommonContext.TAGS_PARAM_NAME, CommonContext.TAG_PREFIX
  - getTag
```
public static long getTag(String paramValue)
```
    Get the value of the tag from a given parameter value.
    
    Parameters:
    
    paramValue - to extract the tag value from.
    
    Returns:
    
    the value of the tag or INVALID_TAG if not tagged.
    
    See Also:
    
    CommonContext.TAGS_PARAM_NAME, CommonContext.TAG_PREFIX
  - createDestinationUri
```
public static String createDestinationUri(String channel,
                                          String endpoint)
```
    Create a channel URI for a destination, i.e. a channel that uses media and interface parameters of the original channel and adds specified endpoint to it. For example given the input channel is aeron:udp?mtu=1440|ttl=0|endpoint=localhost:8090|term-length=128k|interface=eth0 and the endpoint is 192.168.0.14 the output of this method will be aeron:udp?endpoint=192.168.0.14|interface=eth0.
    
    Parameters:
    
    channel - for which the destination is being added.
    
    endpoint - for the target destination.
    
    Returns:
    
    new channel URI for a destination.
  - replaceEndpointWildcardPort
```
public void replaceEndpointWildcardPort(String resolvedEndpoint)
```
    Uses the supplied endpoint to resolve any wildcard ports. If the existing endpoint has a value of "0" for then the port of this endpoint will be used instead. If the endpoint is not specified in this uri, then the whole supplied endpoint is used. If the endpoint exists and has a non-wildcard port, then the existing endpoint is retained.
    
    Parameters:
    
    resolvedEndpoint - The endpoint to supply a resolved endpoint port.
    
    Throws:
    
    IllegalArgumentException - if the supplied resolvedEndpoint does not have a port or the port is zero.
    
    NullPointerException - if the supplied resolvedEndpoint is null

Class ChannelUri

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

AERON_SCHEME

SPY_QUALIFIER

INVALID_TAG

Method Detail

prefix

prefix

media

media

isUdp

isIpc

scheme

get

get

put

remove

containsKey

channelTag

entityTag

equals

hashCode

toString

initialPosition

parse

addSessionId

isTagged

getTag

createDestinationUri

replaceEndpointWildcardPort