Package io.netty.channel.kqueue

Class KQueueDatagramChannel

java.lang.Object

io.netty.util.DefaultAttributeMap

io.netty.channel.AbstractChannel

io.netty.channel.kqueue.AbstractKQueueChannel

io.netty.channel.kqueue.AbstractKQueueDatagramChannel

io.netty.channel.kqueue.KQueueDatagramChannel

All Implemented Interfaces:

Channel, ChannelOutboundInvoker, DatagramChannel, UnixChannel, AttributeMap, Comparable<Channel>

public final class KQueueDatagramChannel
extends AbstractKQueueDatagramChannel
implements DatagramChannel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) final class	KQueueDatagramChannel.KQueueDatagramChannelUnsafe

Nested classes/interfaces inherited from class io.netty.channel.kqueue.AbstractKQueueChannel

AbstractKQueueChannel.AbstractKQueueUnsafe

Nested classes/interfaces inherited from class io.netty.channel.AbstractChannel

AbstractChannel.AbstractUnsafe

Nested classes/interfaces inherited from interface io.netty.channel.Channel

Channel.Unsafe

Field Summary

Fields

Modifier and Type	Field	Description
private final KQueueDatagramChannelConfig	config
private boolean	connected
private static final String	EXPECTED_TYPES

Fields inherited from class io.netty.channel.kqueue.AbstractKQueueChannel

active, inputClosedSeenErrorOnRead, readReadyRunnablePending, registration, socket

Constructor Summary

Constructors

Constructor	Description
KQueueDatagramChannel()
KQueueDatagramChannel(int fd)
KQueueDatagramChannel(BsdSocket socket, boolean active)
KQueueDatagramChannel(InternetProtocolFamily protocol)

Method Summary

Modifier and Type	Method	Description
ChannelFuture	block(InetAddress multicastAddress, InetAddress sourceToBlock)	Block the given sourceToBlock address for the given multicastAddress and notifies the ChannelFuture once the operation completes.
ChannelFuture	block(InetAddress multicastAddress, InetAddress sourceToBlock, ChannelPromise promise)	Block the given sourceToBlock address for the given multicastAddress and notifies the ChannelFuture once the operation completes.
ChannelFuture	block(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress sourceToBlock)	Block the given sourceToBlock address for the given multicastAddress on the given networkInterface and notifies the ChannelFuture once the operation completes.
ChannelFuture	block(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress sourceToBlock, ChannelPromise promise)	Block the given sourceToBlock address for the given multicastAddress on the given networkInterface and notifies the ChannelFuture once the operation completes.
private static void	checkUnresolved(AddressedEnvelope<?,?> envelope)
KQueueDatagramChannelConfig	config()	Returns the configuration of this channel.
protected void	doBind(SocketAddress localAddress)	Bind the Channel to the SocketAddress
protected void	doClose()	Close the Channel
protected boolean	doConnect(SocketAddress remoteAddress, SocketAddress localAddress)	Connect to the remote peer
protected void	doDisconnect()	Disconnect this Channel from its remote peer
protected boolean	doWriteMessage(Object msg)
protected Object	filterOutboundMessage(Object msg)	Invoked when a new message is added to a ChannelOutboundBuffer of this AbstractChannel, so that the Channel implementation converts the message to another.
boolean	isActive()	Return true if the Channel is active and so connected.
boolean	isConnected()	Return true if the DatagramChannel is connected to the remote peer.
ChannelFuture	joinGroup(InetAddress multicastAddress)	Joins a multicast group and notifies the ChannelFuture once the operation completes.
ChannelFuture	joinGroup(InetAddress multicastAddress, ChannelPromise promise)	Joins a multicast group and notifies the ChannelFuture once the operation completes.
ChannelFuture	joinGroup(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source)	Joins the specified multicast group at the specified interface and notifies the ChannelFuture once the operation completes.
ChannelFuture	joinGroup(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source, ChannelPromise promise)	Joins the specified multicast group at the specified interface and notifies the ChannelFuture once the operation completes.
ChannelFuture	joinGroup(InetSocketAddress multicastAddress, NetworkInterface networkInterface)	Joins the specified multicast group at the specified interface and notifies the ChannelFuture once the operation completes.
ChannelFuture	joinGroup(InetSocketAddress multicastAddress, NetworkInterface networkInterface, ChannelPromise promise)	Joins the specified multicast group at the specified interface and notifies the ChannelFuture once the operation completes.
ChannelFuture	leaveGroup(InetAddress multicastAddress)	Leaves a multicast group and notifies the ChannelFuture once the operation completes.
ChannelFuture	leaveGroup(InetAddress multicastAddress, ChannelPromise promise)	Leaves a multicast group and notifies the ChannelFuture once the operation completes.
ChannelFuture	leaveGroup(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source)	Leave the specified multicast group at the specified interface using the specified source and notifies the ChannelFuture once the operation completes.
ChannelFuture	leaveGroup(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source, ChannelPromise promise)	Leave the specified multicast group at the specified interface using the specified source and notifies the ChannelFuture once the operation completes.
ChannelFuture	leaveGroup(InetSocketAddress multicastAddress, NetworkInterface networkInterface)	Leaves a multicast group on a specified local interface and notifies the ChannelFuture once the operation completes.
ChannelFuture	leaveGroup(InetSocketAddress multicastAddress, NetworkInterface networkInterface, ChannelPromise promise)	Leaves a multicast group on a specified local interface and notifies the ChannelFuture once the operation completes.
InetSocketAddress	localAddress()	Returns the local address where this channel is bound to.
protected AbstractKQueueChannel.AbstractKQueueUnsafe	newUnsafe()	Create a new AbstractChannel.AbstractUnsafe instance which will be used for the life-time of the Channel
InetSocketAddress	remoteAddress()	Returns the remote address where this channel is connected to.
private static IOException	translateForConnected(Errors.NativeIoException e)

Methods inherited from class io.netty.channel.kqueue.AbstractKQueueDatagramChannel

doWrite, metadata

Methods inherited from class io.netty.channel.kqueue.AbstractKQueueChannel

checkResolvable, clearReadFilter, doBeginRead, doConnect0, doDeregister, doReadBytes, doRegister, doWriteBytes, fd, isCompatible, isOpen, isSoErrorZero, localAddress0, newDirectBuffer, newDirectBuffer, readFilter, remoteAddress0, resetCachedAddresses, shouldBreakReadReady, unregisterFilters, writeFilter

Methods inherited from class io.netty.channel.AbstractChannel

alloc, bind, bind, bytesBeforeUnwritable, bytesBeforeWritable, close, close, closeFuture, compareTo, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, doShutdownOutput, equals, eventLoop, flush, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, maxMessagesPerWrite, newChannelPipeline, newFailedFuture, newId, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, toString, unsafe, validateFileRegion, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from class io.netty.util.DefaultAttributeMap

attr, hasAttr

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.util.AttributeMap

attr, hasAttr

Methods inherited from interface io.netty.channel.Channel

alloc, bytesBeforeUnwritable, bytesBeforeWritable, closeFuture, eventLoop, flush, id, isOpen, isRegistered, isWritable, metadata, parent, pipeline, read, unsafe

Methods inherited from interface io.netty.channel.ChannelOutboundInvoker

bind, bind, close, close, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from interface java.lang.Comparable

compareTo

Field Details

EXPECTED_TYPES

private static final String EXPECTED_TYPES

connected

private volatile boolean connected

config

private final KQueueDatagramChannelConfig config

Constructor Details

KQueueDatagramChannel

public KQueueDatagramChannel()

KQueueDatagramChannel

public KQueueDatagramChannel(InternetProtocolFamily protocol)

KQueueDatagramChannel

public KQueueDatagramChannel(int fd)

KQueueDatagramChannel

KQueueDatagramChannel(BsdSocket socket,
 boolean active)

Method Details

remoteAddress

public InetSocketAddress remoteAddress()

Description copied from interface: Channel

Returns the remote address where this channel is connected to. The returned SocketAddress is supposed to be down-cast into more concrete type such as InetSocketAddress to retrieve the detailed information.

Specified by:

remoteAddress in interface Channel

Specified by:

remoteAddress in interface DatagramChannel

Overrides:

remoteAddress in class AbstractChannel

Returns:

the remote address of this channel. null if this channel is not connected. If this channel is not connected but it can receive messages from arbitrary remote addresses (e.g. DatagramChannel, use DefaultAddressedEnvelope.recipient() to determine the origination of the received message as this method will return null.

localAddress

public InetSocketAddress localAddress()

Description copied from interface: Channel

Returns the local address where this channel is bound to. The returned SocketAddress is supposed to be down-cast into more concrete type such as InetSocketAddress to retrieve the detailed information.

Specified by:

localAddress in interface Channel

Specified by:

localAddress in interface DatagramChannel

Overrides:

localAddress in class AbstractChannel

Returns:

the local address of this channel. null if this channel is not bound.

isActive

public boolean isActive()

Description copied from interface: Channel

Return true if the Channel is active and so connected.

Specified by:

isActive in interface Channel

Overrides:

isActive in class AbstractKQueueChannel

isConnected

public boolean isConnected()

Description copied from interface: DatagramChannel

Return true if the DatagramChannel is connected to the remote peer.

Specified by:

isConnected in interface DatagramChannel

joinGroup

public ChannelFuture joinGroup(InetAddress multicastAddress)

Description copied from interface: DatagramChannel

Joins a multicast group and notifies the ChannelFuture once the operation completes.

Specified by:

joinGroup in interface DatagramChannel

joinGroup

public ChannelFuture joinGroup(InetAddress multicastAddress,
 ChannelPromise promise)

Description copied from interface: DatagramChannel

Joins a multicast group and notifies the ChannelFuture once the operation completes. The given ChannelFuture will be notified and also returned.

Specified by:

joinGroup in interface DatagramChannel

joinGroup

public ChannelFuture joinGroup(InetSocketAddress multicastAddress,
 NetworkInterface networkInterface)

Description copied from interface: DatagramChannel

Joins the specified multicast group at the specified interface and notifies the ChannelFuture once the operation completes.

Specified by:

joinGroup in interface DatagramChannel

joinGroup

public ChannelFuture joinGroup(InetSocketAddress multicastAddress,
 NetworkInterface networkInterface,
 ChannelPromise promise)

Description copied from interface: DatagramChannel

Joins the specified multicast group at the specified interface and notifies the ChannelFuture once the operation completes. The given ChannelFuture will be notified and also returned.

Specified by:

joinGroup in interface DatagramChannel

joinGroup

public ChannelFuture joinGroup(InetAddress multicastAddress,
 NetworkInterface networkInterface,
 InetAddress source)

Description copied from interface: DatagramChannel

Joins the specified multicast group at the specified interface and notifies the ChannelFuture once the operation completes.

Specified by:

joinGroup in interface DatagramChannel

joinGroup

public ChannelFuture joinGroup(InetAddress multicastAddress,
 NetworkInterface networkInterface,
 InetAddress source,
 ChannelPromise promise)

Description copied from interface: DatagramChannel

Joins the specified multicast group at the specified interface and notifies the ChannelFuture once the operation completes. The given ChannelFuture will be notified and also returned.

Specified by:

joinGroup in interface DatagramChannel

leaveGroup

public ChannelFuture leaveGroup(InetAddress multicastAddress)

Description copied from interface: DatagramChannel

Leaves a multicast group and notifies the ChannelFuture once the operation completes.

Specified by:

leaveGroup in interface DatagramChannel

leaveGroup

public ChannelFuture leaveGroup(InetAddress multicastAddress,
 ChannelPromise promise)

Description copied from interface: DatagramChannel

Leaves a multicast group and notifies the ChannelFuture once the operation completes. The given ChannelFuture will be notified and also returned.

Specified by:

leaveGroup in interface DatagramChannel

leaveGroup

public ChannelFuture leaveGroup(InetSocketAddress multicastAddress,
 NetworkInterface networkInterface)

Description copied from interface: DatagramChannel

Leaves a multicast group on a specified local interface and notifies the ChannelFuture once the operation completes.

Specified by:

leaveGroup in interface DatagramChannel

leaveGroup

public ChannelFuture leaveGroup(InetSocketAddress multicastAddress,
 NetworkInterface networkInterface,
 ChannelPromise promise)

Description copied from interface: DatagramChannel

Leaves a multicast group on a specified local interface and notifies the ChannelFuture once the operation completes. The given ChannelFuture will be notified and also returned.

Specified by:

leaveGroup in interface DatagramChannel

leaveGroup

public ChannelFuture leaveGroup(InetAddress multicastAddress,
 NetworkInterface networkInterface,
 InetAddress source)

Description copied from interface: DatagramChannel

Leave the specified multicast group at the specified interface using the specified source and notifies the ChannelFuture once the operation completes.

Specified by:

leaveGroup in interface DatagramChannel

leaveGroup

public ChannelFuture leaveGroup(InetAddress multicastAddress,
 NetworkInterface networkInterface,
 InetAddress source,
 ChannelPromise promise)

Description copied from interface: DatagramChannel

Leave the specified multicast group at the specified interface using the specified source and notifies the ChannelFuture once the operation completes. The given ChannelFuture will be notified and also returned.

Specified by:

leaveGroup in interface DatagramChannel

block

public ChannelFuture block(InetAddress multicastAddress,
 NetworkInterface networkInterface,
 InetAddress sourceToBlock)

Description copied from interface: DatagramChannel

Block the given sourceToBlock address for the given multicastAddress on the given networkInterface and notifies the ChannelFuture once the operation completes. The given ChannelFuture will be notified and also returned.

Specified by:

block in interface DatagramChannel

block

public ChannelFuture block(InetAddress multicastAddress,
 NetworkInterface networkInterface,
 InetAddress sourceToBlock,
 ChannelPromise promise)

Description copied from interface: DatagramChannel

Block the given sourceToBlock address for the given multicastAddress on the given networkInterface and notifies the ChannelFuture once the operation completes. The given ChannelFuture will be notified and also returned.

Specified by:

block in interface DatagramChannel

block

public ChannelFuture block(InetAddress multicastAddress,
 InetAddress sourceToBlock)

Description copied from interface: DatagramChannel

Block the given sourceToBlock address for the given multicastAddress and notifies the ChannelFuture once the operation completes. The given ChannelFuture will be notified and also returned.

Specified by:

block in interface DatagramChannel

block

public ChannelFuture block(InetAddress multicastAddress,
 InetAddress sourceToBlock,
 ChannelPromise promise)

Description copied from interface: DatagramChannel

Block the given sourceToBlock address for the given multicastAddress and notifies the ChannelFuture once the operation completes. The given ChannelFuture will be notified and also returned.

Specified by:

block in interface DatagramChannel

newUnsafe

protected AbstractKQueueChannel.AbstractKQueueUnsafe newUnsafe()

Description copied from class: AbstractChannel

Create a new AbstractChannel.AbstractUnsafe instance which will be used for the life-time of the Channel

Specified by:

newUnsafe in class AbstractKQueueChannel

doBind

protected void doBind(SocketAddress localAddress)
               throws Exception

Description copied from class: AbstractChannel

Bind the Channel to the SocketAddress

Overrides:

doBind in class AbstractKQueueChannel

Throws:

Exception

doWriteMessage

protected boolean doWriteMessage(Object msg)
                          throws Exception

Specified by:

doWriteMessage in class AbstractKQueueDatagramChannel

Throws:

Exception

translateForConnected

private static IOException translateForConnected(Errors.NativeIoException e)

checkUnresolved

private static void checkUnresolved(AddressedEnvelope<?,?> envelope)

filterOutboundMessage

protected Object filterOutboundMessage(Object msg)

Description copied from class: AbstractChannel

Invoked when a new message is added to a ChannelOutboundBuffer of this AbstractChannel, so that the Channel implementation converts the message to another. (e.g. heap buffer -> direct buffer)

Overrides:

filterOutboundMessage in class AbstractChannel

config

public KQueueDatagramChannelConfig config()

Description copied from interface: Channel

Returns the configuration of this channel.

Specified by:

config in interface Channel

Specified by:

config in interface DatagramChannel

Specified by:

config in class AbstractKQueueChannel

doDisconnect

protected void doDisconnect()
                     throws Exception

Description copied from class: AbstractChannel

Disconnect this Channel from its remote peer

Overrides:

doDisconnect in class AbstractKQueueChannel

Throws:

Exception

doConnect

protected boolean doConnect(SocketAddress remoteAddress,
 SocketAddress localAddress)
                     throws Exception

Description copied from class: AbstractKQueueChannel

Connect to the remote peer

Overrides:

doConnect in class AbstractKQueueChannel

Throws:

Exception

doClose

protected void doClose()
                throws Exception

Description copied from class: AbstractChannel

Close the Channel

Overrides:

doClose in class AbstractKQueueChannel

Throws:

Exception