io.aeron.driver.media

Class UdpChannelTransport

java.lang.Object

io.aeron.driver.media.UdpChannelTransport

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

ReceiveChannelEndpoint, ReceiveDestinationUdpTransport, SendChannelEndpoint

public abstract class UdpChannelTransport
extends java.lang.Object
implements java.lang.AutoCloseable

Field Summary

Fields

Modifier and Type	Field and Description
protected java.net.InetSocketAddress	bindAddress
protected java.net.InetSocketAddress	connectAddress
protected java.net.InetSocketAddress	endPointAddress
protected org.agrona.concurrent.errors.DistinctErrorLog	errorLog
protected org.agrona.concurrent.status.AtomicCounter	invalidPackets
protected boolean	isClosed
protected int	multicastTtl
protected java.nio.channels.DatagramChannel	receiveDatagramChannel
protected java.nio.channels.SelectionKey	selectionKey
protected java.nio.channels.DatagramChannel	sendDatagramChannel
protected UdpTransportPoller	transportPoller
protected UdpChannel	udpChannel

Constructor Summary

Constructors

Constructor and Description
UdpChannelTransport(UdpChannel udpChannel, java.net.InetSocketAddress endPointAddress, java.net.InetSocketAddress bindAddress, java.net.InetSocketAddress connectAddress, org.agrona.concurrent.errors.DistinctErrorLog errorLog, org.agrona.concurrent.status.AtomicCounter invalidPackets)

Method Summary

Modifier and Type	Method and Description
void	close() Close transport, canceling any pending read operations and closing channel
boolean	isMulticast() Is transport representing a multicast media or unicast
boolean	isValidFrame(org.agrona.concurrent.UnsafeBuffer buffer, int length) Is the received frame valid.
int	multicastTtl() Get the multicast TTL value for sending datagrams on the channel.
void	openDatagramChannel(org.agrona.concurrent.status.AtomicCounter statusIndicator) Create the underlying channel for reading and writing.
java.net.InetSocketAddress	receive(java.nio.ByteBuffer buffer) Receive a datagram from the media layer.
java.nio.channels.DatagramChannel	receiveDatagramChannel() The DatagramChannel for this transport channel.
void	receiveHook(org.agrona.concurrent.UnsafeBuffer buffer, int length, java.net.InetSocketAddress address)
void	registerForRead(UdpTransportPoller transportPoller) Register this transport for reading from a UdpTransportPoller.
static void	sendError(int bytesToSend, java.io.IOException ex, java.net.InetSocketAddress destination) Throw a AeronException with a message for a send error.
void	sendHook(java.nio.ByteBuffer buffer, java.net.InetSocketAddress address)
UdpChannel	udpChannel() Return underlying UdpChannel

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

udpChannel

protected final UdpChannel udpChannel

invalidPackets

protected final org.agrona.concurrent.status.AtomicCounter invalidPackets

errorLog

protected final org.agrona.concurrent.errors.DistinctErrorLog errorLog

transportPoller

protected UdpTransportPoller transportPoller

selectionKey

protected java.nio.channels.SelectionKey selectionKey

bindAddress

protected final java.net.InetSocketAddress bindAddress

endPointAddress

protected final java.net.InetSocketAddress endPointAddress

connectAddress

protected final java.net.InetSocketAddress connectAddress

sendDatagramChannel

protected java.nio.channels.DatagramChannel sendDatagramChannel

receiveDatagramChannel

protected java.nio.channels.DatagramChannel receiveDatagramChannel

multicastTtl

protected int multicastTtl

isClosed

protected boolean isClosed

Constructor Detail

UdpChannelTransport

public UdpChannelTransport(UdpChannel udpChannel,
                           java.net.InetSocketAddress endPointAddress,
                           java.net.InetSocketAddress bindAddress,
                           java.net.InetSocketAddress connectAddress,
                           org.agrona.concurrent.errors.DistinctErrorLog errorLog,
                           org.agrona.concurrent.status.AtomicCounter invalidPackets)

Method Detail

sendError

public static void sendError(int bytesToSend,
                             java.io.IOException ex,
                             java.net.InetSocketAddress destination)

Throw a AeronException with a message for a send error.

Parameters:

bytesToSend - expected to be sent to the network.

ex - experienced.

destination - to which the send was addressed.

openDatagramChannel

public void openDatagramChannel(org.agrona.concurrent.status.AtomicCounter statusIndicator)

Create the underlying channel for reading and writing.

Parameters:

statusIndicator - to set for error status

registerForRead

public void registerForRead(UdpTransportPoller transportPoller)

Register this transport for reading from a UdpTransportPoller.

Parameters:

transportPoller - to register read with

udpChannel

public UdpChannel udpChannel()

Return underlying UdpChannel

Returns:

underlying channel

receiveDatagramChannel

public java.nio.channels.DatagramChannel receiveDatagramChannel()

The DatagramChannel for this transport channel.

Returns:

DatagramChannel for this transport channel.

multicastTtl

public int multicastTtl()

Get the multicast TTL value for sending datagrams on the channel.

Returns:

the multicast TTL value for sending datagrams on the channel.

close

public void close()

Close transport, canceling any pending read operations and closing channel

Specified by:

close in interface java.lang.AutoCloseable

isMulticast

public boolean isMulticast()

Is transport representing a multicast media or unicast

Returns:

if transport is multicast media

isValidFrame

public boolean isValidFrame(org.agrona.concurrent.UnsafeBuffer buffer,
                            int length)

Is the received frame valid. This method will do some basic checks on the header and can be overridden in a subclass for further validation.

Parameters:

buffer - containing the frame.

length - of the frame.

Returns:

true if the frame is believed valid otherwise false.

sendHook

public void sendHook(java.nio.ByteBuffer buffer,
                     java.net.InetSocketAddress address)

receiveHook

public void receiveHook(org.agrona.concurrent.UnsafeBuffer buffer,
                        int length,
                        java.net.InetSocketAddress address)

receive

public java.net.InetSocketAddress receive(java.nio.ByteBuffer buffer)

Receive a datagram from the media layer.

Parameters:

buffer - into which the datagram will be received.

Returns:

the source address of the datagram if one is available otherwise false.