io.aeron.driver.media

Class UdpChannel

java.lang.Object

io.aeron.driver.media.UdpChannel

public final class UdpChannel
extends java.lang.Object

Encapsulation of UDP Channels. Format of URI as in AeronUri.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONTROL_KEY
static java.lang.String	ENDPOINT_KEY
static java.lang.String	INTERFACE_KEY
static java.lang.String	MULTICAST_TTL_KEY
static java.lang.String	UDP_MEDIA_ID

Method Summary

Modifier and Type	Method and Description
AeronUri	aeronUri() Get the AeronUri for this channel.
java.lang.String	canonicalForm() The canonical form for the channel canonicalise(java.net.InetSocketAddress, java.net.InetSocketAddress)
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.
java.lang.String	description()
static java.net.InetSocketAddress	destinationAddress(AeronUri uri) Get the endpoint address from the URI.
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	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 uriStr) Parse URI and create channel
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
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

UDP_MEDIA_ID

public static final java.lang.String UDP_MEDIA_ID

See Also:

Constant Field Values

INTERFACE_KEY

public static final java.lang.String INTERFACE_KEY

See Also:

Constant Field Values

ENDPOINT_KEY

public static final java.lang.String ENDPOINT_KEY

See Also:

Constant Field Values

MULTICAST_TTL_KEY

public static final java.lang.String MULTICAST_TTL_KEY

See Also:

Constant Field Values

CONTROL_KEY

public static final java.lang.String CONTROL_KEY

See Also:

Constant Field Values

Method Detail

parse

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

Parse URI and create channel

Parameters:

uriStr - to parse

Returns:

created channel

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 hostnames converted to hexadecimal - has all fields expanded out - uses "-" as all field separators The general format is: UDP-interface-localPort-remoteAddress-remotePort

Parameters:

localData - for the channel

remoteData - 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

aeronUri

public AeronUri aeronUri()

Get the AeronUri for this channel.

Returns:

the AeronUri 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()
                                         throws java.net.SocketException

Local interface to be used by the channel.

Returns:

NetworkInterface for the local interface used by the channel

Throws:

java.net.SocketException - if an error occurs

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.

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

destinationAddress

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

Get the endpoint address from the URI.

Parameters:

uri - to check

Returns:

endpoint address for URI

description

public java.lang.String description()