io.aeron.driver.media

Class UdpChannelTransport

java.lang.Object

io.aeron.driver.media.UdpChannelTransport

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

ReceiveChannelEndpoint, ReceiveDestinationTransport, SendChannelEndpoint, UdpNameResolutionTransport

public abstract class UdpChannelTransport
extends Object
implements AutoCloseable

Base class for UDP channel transports which is specialised for send or receive endpoints.

Field Summary

Fields

Modifier and Type	Field and Description
protected InetSocketAddress	bindAddress
protected InetSocketAddress	connectAddress
protected MediaDriver.Context	context
protected InetSocketAddress	endPointAddress
protected ErrorHandler	errorHandler
protected AtomicCounter	invalidPackets
protected boolean	isClosed
protected int	multicastTtl
protected DatagramChannel	receiveDatagramChannel
protected SelectionKey	selectionKey
protected DatagramChannel	sendDatagramChannel
protected UdpTransportPoller	transportPoller
protected UdpChannel	udpChannel

Constructor Summary

Constructors

Constructor and Description
UdpChannelTransport(UdpChannel udpChannel, InetSocketAddress endPointAddress, InetSocketAddress bindAddress, InetSocketAddress connectAddress, MediaDriver.Context context)

Method Summary

Modifier and Type	Method and Description
String	bindAddressAndPort() Get the bind address and port in endpoint-style format (ip:port).
void	close() Close transport, canceling any pending read operations and closing channel.
boolean	isMulticast() Is transport representing a multicast media?
boolean	isValidFrame(UnsafeBuffer buffer, int length) Is the received frame valid.
int	multicastTtl() Get the multicast TTL value for sending datagrams on the channel.
void	openDatagramChannel(AtomicCounter statusIndicator) Open the underlying channel for reading and writing.
InetSocketAddress	receive(ByteBuffer buffer) Receive a datagram from the media layer.
DatagramChannel	receiveDatagramChannel() The DatagramChannel for this transport channel.
void	receiveHook(UnsafeBuffer buffer, int length, InetSocketAddress address) Receive packet hook that can be usef for logging.
void	registerForRead(UdpTransportPoller transportPoller) Register this transport for reading from a UdpTransportPoller.
static void	sendError(int bytesToSend, IOException ex, InetSocketAddress destination) Throw a AeronException with a message for a send error.
void	sendHook(ByteBuffer buffer, InetSocketAddress address) Send packet hook that can be used for logging.
UdpChannel	udpChannel() Return underlying UdpChannel.
void	updateEndpoint(InetSocketAddress newAddress, AtomicCounter statusIndicator) Endpoint has moved to a new address.

Methods inherited from class java.lang.Object

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

Field Detail

context

protected final MediaDriver.Context context

udpChannel

protected final UdpChannel udpChannel

invalidPackets

protected final AtomicCounter invalidPackets

errorHandler

protected final ErrorHandler errorHandler

transportPoller

protected UdpTransportPoller transportPoller

selectionKey

protected SelectionKey selectionKey

bindAddress

protected final InetSocketAddress bindAddress

endPointAddress

protected final InetSocketAddress endPointAddress

connectAddress

protected InetSocketAddress connectAddress

sendDatagramChannel

protected DatagramChannel sendDatagramChannel

receiveDatagramChannel

protected DatagramChannel receiveDatagramChannel

multicastTtl

protected int multicastTtl

isClosed

protected boolean isClosed

Constructor Detail

UdpChannelTransport

public UdpChannelTransport(UdpChannel udpChannel,
                           InetSocketAddress endPointAddress,
                           InetSocketAddress bindAddress,
                           InetSocketAddress connectAddress,
                           MediaDriver.Context context)

Method Detail

sendError

public static void sendError(int bytesToSend,
                             IOException ex,
                             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(AtomicCounter statusIndicator)

Open the underlying channel for reading and writing.

Parameters:

statusIndicator - to set for ChannelEndpointStatus which could be ChannelEndpointStatus.ERRORED.

registerForRead

public void registerForRead(UdpTransportPoller transportPoller)

Register this transport for reading from a UdpTransportPoller.

Parameters:

transportPoller - to register for read with.

udpChannel

public UdpChannel udpChannel()

Return underlying UdpChannel.

Returns:

underlying channel.

receiveDatagramChannel

public 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.

bindAddressAndPort

public String bindAddressAndPort()

Get the bind address and port in endpoint-style format (ip:port).

Must be called after the channel is opened.

Returns:

the bind address and port in endpoint-style format (ip:port).

close

public void close()

Close transport, canceling any pending read operations and closing channel.

Specified by:

close in interface AutoCloseable

isMulticast

public boolean isMulticast()

Is transport representing a multicast media?

Returns:

true if transport is multicast media, otherwise false.

isValidFrame

public boolean isValidFrame(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(ByteBuffer buffer,
                     InetSocketAddress address)

Send packet hook that can be used for logging.

Parameters:

buffer - containing the packet.

address - to which the packet will be sent.

receiveHook

public void receiveHook(UnsafeBuffer buffer,
                        int length,
                        InetSocketAddress address)

Receive packet hook that can be usef for logging.

Parameters:

buffer - containing the packet.

length - length of the packet in bytes.

address - from which the packet came.

receive

public InetSocketAddress receive(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.

updateEndpoint

public void updateEndpoint(InetSocketAddress newAddress,
                           AtomicCounter statusIndicator)

Endpoint has moved to a new address. Handle this.

Parameters:

newAddress - to send data to.

statusIndicator - for the channel