io.aeron.driver.media

Class UdpChannelTransport

java.lang.Object

io.aeron.driver.media.UdpChannelTransport

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

ReceiveChannelEndpoint, 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.UnsafeBuffer	receiveBuffer
protected java.nio.ByteBuffer	receiveByteBuffer
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)

Method Summary

Modifier and Type	Method and Description
void	close() Close transport, canceling any pending read operations and closing channel
<T> T	getOption(java.net.SocketOption<T> name) Return socket option value
boolean	isMulticast() Is transport representing a multicast media or unicast
boolean	isValidFrame(org.agrona.concurrent.UnsafeBuffer receiveBuffer, int length)
int	multicastTtl()
void	openDatagramChannel() Create the underlying channel for reading and writing.
abstract int	pollForData() Attempt to receive waiting data.
protected java.net.InetSocketAddress	receive()
int	receiveBufferCapacity() Return the capacity of the ByteBuffer used for reception
java.nio.channels.DatagramChannel	receiveDatagramChannel() The DatagramChannel for this transport channel.
void	registerForRead(UdpTransportPoller transportPoller) Register this transport for reading from a UdpTransportPoller.
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

bindAddress

protected java.net.InetSocketAddress bindAddress

endPointAddress

protected java.net.InetSocketAddress endPointAddress

connectAddress

protected java.net.InetSocketAddress connectAddress

selectionKey

protected java.nio.channels.SelectionKey selectionKey

transportPoller

protected UdpTransportPoller transportPoller

udpChannel

protected final UdpChannel udpChannel

errorLog

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

receiveByteBuffer

protected final java.nio.ByteBuffer receiveByteBuffer

receiveBuffer

protected final org.agrona.concurrent.UnsafeBuffer receiveBuffer

sendDatagramChannel

protected java.nio.channels.DatagramChannel sendDatagramChannel

receiveDatagramChannel

protected java.nio.channels.DatagramChannel receiveDatagramChannel

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)

Method Detail

openDatagramChannel

public void openDatagramChannel()

Create the underlying channel for reading and writing.

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()

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

getOption

public <T> T getOption(java.net.SocketOption<T> name)

Return socket option value

Type Parameters:

T - type of option

Parameters:

name - of the socket option

Returns:

option value

receiveBufferCapacity

public int receiveBufferCapacity()

Return the capacity of the ByteBuffer used for reception

Returns:

capacity of receiving byte buffer

pollForData

public abstract int pollForData()

Attempt to receive waiting data.

Returns:

number of bytes received.

isValidFrame

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

receive

protected java.net.InetSocketAddress receive()