io.aeron.driver.media

Class UdpChannel

java.lang.Object

io.aeron.driver.media.UdpChannel

public final class UdpChannel
extends java.lang.Object

The media configuration for Aeron UDP channels as an instantiation of the socket addresses for a ChannelUri.

See Also:

ChannelUri, ChannelUriStringBuilder

Method Summary

Modifier and Type	Method and Description
java.lang.String	canonicalForm() The canonical form for the channel
static java.lang.String	canonicalise(java.net.InetSocketAddress localData, java.net.InetSocketAddress remoteData) Return a string which is a canonical form of the channel suitable for use as a file or directory name and also as a method of hashing, etc.
ChannelUri	channelUri() Get the ChannelUri for this channel.
java.lang.String	description() Used for debugging to get a human readable description of the channel.
static java.net.InetSocketAddress	destinationAddress(ChannelUri uri) Get the endpoint address from the URI.
boolean	doesTagMatch(UdpChannel udpChannel)
boolean	equals(java.lang.Object o)
boolean	hasExplicitControl() Does the channel have an explicit control address as used with multi-destination-cast or not?
int	hashCode()
boolean	hasTag()
boolean	isMulticast() Does channel represent a multicast or not
java.net.InetSocketAddress	localControl() Local control address information
java.net.InetSocketAddress	localData() Local data address information
java.net.NetworkInterface	localInterface() Local interface to be used by the channel.
int	multicastTtl() Multicast TTL information
java.lang.String	originalUriString() Original URI of the channel URI.
static UdpChannel	parse(java.lang.String channelUriString) Parse channel URI and create a UdpChannel.
java.net.ProtocolFamily	protocolFamily() Get the ProtocolFamily for this channel.
java.net.InetSocketAddress	remoteControl() Remote control address information
java.net.InetSocketAddress	remoteData() Remote data address information
long	tag()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

parse

public static UdpChannel parse(java.lang.String channelUriString)

Parse channel URI and create a UdpChannel.

Parameters:

channelUriString - to parse

Returns:

a new UdpChannel

Throws:

InvalidChannelException - if an error occurs.

canonicalise

public static java.lang.String canonicalise(java.net.InetSocketAddress localData,
                                            java.net.InetSocketAddress remoteData)

Return a string which is a canonical form of the channel suitable for use as a file or directory name and also as a method of hashing, etc.

A canonical form:

• begins with the string "UDP-"
• has all addresses converted to hexadecimal
• uses "-" as all field separators

The general format is: UDP-interface-localPort-remoteAddress-remotePort

Parameters:

localData - address/interface for the channel

remoteData - address for the channel

Returns:

canonical representation as a string

remoteData

public java.net.InetSocketAddress remoteData()

Remote data address information

Returns:

remote data address information

localData

public java.net.InetSocketAddress localData()

Local data address information

Returns:

local data address information

remoteControl

public java.net.InetSocketAddress remoteControl()

Remote control address information

Returns:

remote control address information

localControl

public java.net.InetSocketAddress localControl()

Local control address information

Returns:

local control address information

channelUri

public ChannelUri channelUri()

Get the ChannelUri for this channel.

Returns:

the ChannelUri for this channel.

multicastTtl

public int multicastTtl()

Multicast TTL information

Returns:

multicast TTL value

canonicalForm

public java.lang.String canonicalForm()

The canonical form for the channel

canonicalise(java.net.InetSocketAddress, java.net.InetSocketAddress)

Returns:

canonical form for channel

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isMulticast

public boolean isMulticast()

Does channel represent a multicast or not

Returns:

does channel represent a multicast or not

localInterface

public java.net.NetworkInterface localInterface()

Local interface to be used by the channel.

Returns:

NetworkInterface for the local interface used by the channel

originalUriString

public java.lang.String originalUriString()

Original URI of the channel URI.

Returns:

the original uri

protocolFamily

public java.net.ProtocolFamily protocolFamily()

Get the ProtocolFamily for this channel.

Returns:

the ProtocolFamily for this channel.

tag

public long tag()

hasExplicitControl

public boolean hasExplicitControl()

Does the channel have an explicit control address as used with multi-destination-cast or not?

Returns:

does channel have an explicit control address or not?

hasTag

public boolean hasTag()

doesTagMatch

public boolean doesTagMatch(UdpChannel udpChannel)

destinationAddress

public static java.net.InetSocketAddress destinationAddress(ChannelUri uri)

Get the endpoint address from the URI.

Parameters:

uri - to check

Returns:

endpoint address for URI

description

public java.lang.String description()

Used for debugging to get a human readable description of the channel.

Returns:

a human readable description of the channel.