Top Inners Fields Constructors Methods
io.netty.channel.kqueue

public final Class KQueueDatagramChannel

extends AbstractKQueueDatagramChannel
implements DatagramChannel
Class Inheritance
All Implemented Interfaces
io.netty.channel.socket.DatagramChannel, io.netty.channel.Channel, java.lang.Comparable, io.netty.channel.ChannelOutboundInvoker, io.netty.util.AttributeMap
Annotations
@UnstableApi
Imports
io.netty.buffer.ByteBuf, .ByteBufAllocator, io.netty.channel.AddressedEnvelope, .ChannelFuture, .ChannelPipeline, .ChannelPromise, .DefaultAddressedEnvelope, io.netty.channel.socket.DatagramChannel, .DatagramChannelConfig, .DatagramPacket, .InternetProtocolFamily, io.netty.channel.unix.DatagramSocketAddress, .Errors, .IovArray, .UnixChannelUtil, io.netty.util.UncheckedBooleanSupplier, io.netty.util.internal.ObjectUtil, .StringUtil, .UnstableApi, java.net.InetAddress, .InetSocketAddress, .NetworkInterface, .PortUnreachableException, .SocketAddress, .SocketException, java.nio.ByteBuffer, java.nio.channels.UnresolvedAddressException

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv class

Field Summary

Modifier and TypeField and Description
private final KQueueDatagramChannelConfig
private volatile boolean
private static final String

Constructor Summary

AccessConstructor and Description
public
public
public
pack-priv
KQueueDatagramChannel(BsdSocket socket, boolean active)

Method Summary

Modifier and TypeMethod and Description
public ChannelFuture
block(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress sourceToBlock)

Implements io.netty.channel.socket.DatagramChannel.block.

Block the given sourceToBlock address for the given multicastAddress on the given networkInterface and notifies the ChannelFuture once the operation completes.
public ChannelFuture
block(final InetAddress multicastAddress, final NetworkInterface networkInterface, final InetAddress sourceToBlock, final ChannelPromise promise)

Implements io.netty.channel.socket.DatagramChannel.block.

Block the given sourceToBlock address for the given multicastAddress on the given networkInterface and notifies the ChannelFuture once the operation completes.
public ChannelFuture
block(InetAddress multicastAddress, InetAddress sourceToBlock)

Implements io.netty.channel.socket.DatagramChannel.block.

Block the given sourceToBlock address for the given multicastAddress and notifies the ChannelFuture once the operation completes.
public ChannelFuture
block(InetAddress multicastAddress, InetAddress sourceToBlock, ChannelPromise promise)

Implements io.netty.channel.socket.DatagramChannel.block.

Block the given sourceToBlock address for the given multicastAddress and notifies the ChannelFuture once the operation completes.
private static void
public KQueueDatagramChannelConfig
protected void
protected void
protected boolean
doConnect(SocketAddress remoteAddress, SocketAddress localAddress)

Overrides io.netty.channel.kqueue.AbstractKQueueChannel.doConnect.

Connect to the remote peer
protected void
doDisconnect()

Overrides io.netty.channel.kqueue.AbstractKQueueChannel.doDisconnect.

Disconnect this Channel from its remote peer
protected boolean
protected Object
filterOutboundMessage(Object msg)

Overrides io.netty.channel.AbstractChannel.filterOutboundMessage.

Invoked when a new message is added to a ChannelOutboundBuffer of this AbstractChannel, so that the Channel implementation converts the message to another.
public boolean
isActive()

Overrides io.netty.channel.kqueue.AbstractKQueueChannel.isActive.

Implements io.netty.channel.Channel.isActive.

Return true if the Channel is active and so connected.
public boolean
isConnected()

Implements io.netty.channel.socket.DatagramChannel.isConnected.

Return true if the DatagramChannel is connected to the remote peer.
public ChannelFuture
joinGroup(InetAddress multicastAddress)

Implements io.netty.channel.socket.DatagramChannel.joinGroup.

Joins a multicast group and notifies the ChannelFuture once the operation completes.
public ChannelFuture
joinGroup(InetAddress multicastAddress, ChannelPromise promise)

Implements io.netty.channel.socket.DatagramChannel.joinGroup.

Joins a multicast group and notifies the ChannelFuture once the operation completes.
public ChannelFuture
joinGroup(InetSocketAddress multicastAddress, NetworkInterface networkInterface)

Implements io.netty.channel.socket.DatagramChannel.joinGroup.

Joins the specified multicast group at the specified interface and notifies the ChannelFuture once the operation completes.
public ChannelFuture
joinGroup(InetSocketAddress multicastAddress, NetworkInterface networkInterface, ChannelPromise promise)

Implements io.netty.channel.socket.DatagramChannel.joinGroup.

Joins the specified multicast group at the specified interface and notifies the ChannelFuture once the operation completes.
public ChannelFuture
joinGroup(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source)

Implements io.netty.channel.socket.DatagramChannel.joinGroup.

Joins the specified multicast group at the specified interface and notifies the ChannelFuture once the operation completes.
public ChannelFuture
joinGroup(final InetAddress multicastAddress, final NetworkInterface networkInterface, final InetAddress source, final ChannelPromise promise)

Implements io.netty.channel.socket.DatagramChannel.joinGroup.

Joins the specified multicast group at the specified interface and notifies the ChannelFuture once the operation completes.
public ChannelFuture
leaveGroup(InetAddress multicastAddress)

Implements io.netty.channel.socket.DatagramChannel.leaveGroup.

Leaves a multicast group and notifies the ChannelFuture once the operation completes.
public ChannelFuture
leaveGroup(InetAddress multicastAddress, ChannelPromise promise)

Implements io.netty.channel.socket.DatagramChannel.leaveGroup.

Leaves a multicast group and notifies the ChannelFuture once the operation completes.
public ChannelFuture
leaveGroup(InetSocketAddress multicastAddress, NetworkInterface networkInterface)

Implements io.netty.channel.socket.DatagramChannel.leaveGroup.

Leaves a multicast group on a specified local interface and notifies the ChannelFuture once the operation completes.
public ChannelFuture
leaveGroup(InetSocketAddress multicastAddress, NetworkInterface networkInterface, ChannelPromise promise)

Implements io.netty.channel.socket.DatagramChannel.leaveGroup.

Leaves a multicast group on a specified local interface and notifies the ChannelFuture once the operation completes.
public ChannelFuture
leaveGroup(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source)

Implements io.netty.channel.socket.DatagramChannel.leaveGroup.

Leave the specified multicast group at the specified interface using the specified source and notifies the ChannelFuture once the operation completes.
public ChannelFuture
leaveGroup(final InetAddress multicastAddress, final NetworkInterface networkInterface, final InetAddress source, final ChannelPromise promise)

Implements io.netty.channel.socket.DatagramChannel.leaveGroup.

Leave the specified multicast group at the specified interface using the specified source and notifies the ChannelFuture once the operation completes.
public InetSocketAddress
protected AbstractKQueueChannel.AbstractKQueueUnsafe
newUnsafe()

Implements abstract io.netty.channel.kqueue.AbstractKQueueChannel.newUnsafe.

Create a new AbstractUnsafe instance which will be used for the life-time of the Channel
public InetSocketAddress
Inherited from io.netty.channel.kqueue.AbstractKQueueDatagramChannel:
doWritemetadata

Field Detail

configback to summary
private final KQueueDatagramChannelConfig config
connectedback to summary
private volatile boolean connected
EXPECTED_TYPESback to summary
private static final String EXPECTED_TYPES

Constructor Detail

KQueueDatagramChannelback to summary
public KQueueDatagramChannel()
KQueueDatagramChannelback to summary
public KQueueDatagramChannel(InternetProtocolFamily protocol)
KQueueDatagramChannelback to summary
public KQueueDatagramChannel(int fd)
KQueueDatagramChannelback to summary
pack-priv KQueueDatagramChannel(BsdSocket socket, boolean active)

Method Detail

blockback to summary
public ChannelFuture block(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress sourceToBlock)

Implements io.netty.channel.socket.DatagramChannel.block.

Doc from io.netty.channel.socket.DatagramChannel.block.

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.

Annotations
@Override
blockback to summary
public ChannelFuture block(final InetAddress multicastAddress, final NetworkInterface networkInterface, final InetAddress sourceToBlock, final ChannelPromise promise)

Implements io.netty.channel.socket.DatagramChannel.block.

Doc from io.netty.channel.socket.DatagramChannel.block.

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.

Annotations
@Override
blockback to summary
public ChannelFuture block(InetAddress multicastAddress, InetAddress sourceToBlock)

Implements io.netty.channel.socket.DatagramChannel.block.

Doc from io.netty.channel.socket.DatagramChannel.block.

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.

Annotations
@Override
blockback to summary
public ChannelFuture block(InetAddress multicastAddress, InetAddress sourceToBlock, ChannelPromise promise)

Implements io.netty.channel.socket.DatagramChannel.block.

Doc from io.netty.channel.socket.DatagramChannel.block.

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.

Annotations
@Override
checkUnresolvedback to summary
private static void checkUnresolved(AddressedEnvelope<?, ?> envelope)
configback to summary
public KQueueDatagramChannelConfig config()

Implements abstract io.netty.channel.kqueue.AbstractKQueueChannel.config.

Implements io.netty.channel.socket.DatagramChannel.config, io.netty.channel.Channel.config.

Doc from io.netty.channel.Channel.config.

Returns the configuration of this channel.

Annotations
@Override
doBindback to summary
protected void doBind(SocketAddress localAddress) throws Exception

Overrides io.netty.channel.kqueue.AbstractKQueueChannel.doBind.

Doc from io.netty.channel.AbstractChannel.doBind.

Bind the Channel to the SocketAddress

Annotations
@Override
doCloseback to summary
protected void doClose() throws Exception

Overrides io.netty.channel.kqueue.AbstractKQueueChannel.doClose.

Doc from io.netty.channel.AbstractChannel.doClose.

Close the Channel

Annotations
@Override
doConnectback to summary
protected boolean doConnect(SocketAddress remoteAddress, SocketAddress localAddress) throws Exception

Overrides io.netty.channel.kqueue.AbstractKQueueChannel.doConnect.

Doc from io.netty.channel.kqueue.AbstractKQueueChannel.doConnect.

Connect to the remote peer

Annotations
@Override
doDisconnectback to summary
protected void doDisconnect() throws Exception

Overrides io.netty.channel.kqueue.AbstractKQueueChannel.doDisconnect.

Doc from io.netty.channel.AbstractChannel.doDisconnect.

Disconnect this Channel from its remote peer

Annotations
@Override
doWriteMessageback to summary
protected boolean doWriteMessage(Object msg) throws Exception

Implements abstract io.netty.channel.kqueue.AbstractKQueueDatagramChannel.doWriteMessage.

Annotations
@Override
filterOutboundMessageback to summary
protected Object filterOutboundMessage(Object msg)

Overrides io.netty.channel.AbstractChannel.filterOutboundMessage.

Doc from io.netty.channel.AbstractChannel.filterOutboundMessage.

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)

Annotations
@Override
isActiveback to summary
public boolean isActive()

Overrides io.netty.channel.kqueue.AbstractKQueueChannel.isActive.

Implements io.netty.channel.Channel.isActive.

Doc from io.netty.channel.Channel.isActive.

Return true if the Channel is active and so connected.

Annotations
@Override
@SuppressWarnings:deprecation
isConnectedback to summary
public boolean isConnected()

Implements io.netty.channel.socket.DatagramChannel.isConnected.

Doc from io.netty.channel.socket.DatagramChannel.isConnected.

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

Annotations
@Override
joinGroupback to summary
public ChannelFuture joinGroup(InetAddress multicastAddress)

Implements io.netty.channel.socket.DatagramChannel.joinGroup.

Doc from io.netty.channel.socket.DatagramChannel.joinGroup.

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

Annotations
@Override
joinGroupback to summary
public ChannelFuture joinGroup(InetAddress multicastAddress, ChannelPromise promise)

Implements io.netty.channel.socket.DatagramChannel.joinGroup.

Doc from io.netty.channel.socket.DatagramChannel.joinGroup.

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

Annotations
@Override
joinGroupback to summary
public ChannelFuture joinGroup(InetSocketAddress multicastAddress, NetworkInterface networkInterface)

Implements io.netty.channel.socket.DatagramChannel.joinGroup.

Doc from io.netty.channel.socket.DatagramChannel.joinGroup.

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

Annotations
@Override
joinGroupback to summary
public ChannelFuture joinGroup(InetSocketAddress multicastAddress, NetworkInterface networkInterface, ChannelPromise promise)

Implements io.netty.channel.socket.DatagramChannel.joinGroup.

Doc from io.netty.channel.socket.DatagramChannel.joinGroup.

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.

Annotations
@Override
joinGroupback to summary
public ChannelFuture joinGroup(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source)

Implements io.netty.channel.socket.DatagramChannel.joinGroup.

Doc from io.netty.channel.socket.DatagramChannel.joinGroup.

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

Annotations
@Override
joinGroupback to summary
public ChannelFuture joinGroup(final InetAddress multicastAddress, final NetworkInterface networkInterface, final InetAddress source, final ChannelPromise promise)

Implements io.netty.channel.socket.DatagramChannel.joinGroup.

Doc from io.netty.channel.socket.DatagramChannel.joinGroup.

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.

Annotations
@Override
leaveGroupback to summary
public ChannelFuture leaveGroup(InetAddress multicastAddress)

Implements io.netty.channel.socket.DatagramChannel.leaveGroup.

Doc from io.netty.channel.socket.DatagramChannel.leaveGroup.

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

Annotations
@Override
leaveGroupback to summary
public ChannelFuture leaveGroup(InetAddress multicastAddress, ChannelPromise promise)

Implements io.netty.channel.socket.DatagramChannel.leaveGroup.

Doc from io.netty.channel.socket.DatagramChannel.leaveGroup.

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

Annotations
@Override
leaveGroupback to summary
public ChannelFuture leaveGroup(InetSocketAddress multicastAddress, NetworkInterface networkInterface)

Implements io.netty.channel.socket.DatagramChannel.leaveGroup.

Doc from io.netty.channel.socket.DatagramChannel.leaveGroup.

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

Annotations
@Override
leaveGroupback to summary
public ChannelFuture leaveGroup(InetSocketAddress multicastAddress, NetworkInterface networkInterface, ChannelPromise promise)

Implements io.netty.channel.socket.DatagramChannel.leaveGroup.

Doc from io.netty.channel.socket.DatagramChannel.leaveGroup.

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.

Annotations
@Override
leaveGroupback to summary
public ChannelFuture leaveGroup(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source)

Implements io.netty.channel.socket.DatagramChannel.leaveGroup.

Doc from io.netty.channel.socket.DatagramChannel.leaveGroup.

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

Annotations
@Override
leaveGroupback to summary
public ChannelFuture leaveGroup(final InetAddress multicastAddress, final NetworkInterface networkInterface, final InetAddress source, final ChannelPromise promise)

Implements io.netty.channel.socket.DatagramChannel.leaveGroup.

Doc from io.netty.channel.socket.DatagramChannel.leaveGroup.

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.

Annotations
@Override
localAddressback to summary
public InetSocketAddress localAddress()

Overrides io.netty.channel.AbstractChannel.localAddress.

Implements io.netty.channel.socket.DatagramChannel.localAddress, io.netty.channel.Channel.localAddress.

Doc from io.netty.channel.Channel.localAddress.

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.

Returns:InetSocketAddress

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

Annotations
@Override
newUnsafeback to summary
protected AbstractKQueueChannel.AbstractKQueueUnsafe newUnsafe()

Implements abstract io.netty.channel.kqueue.AbstractKQueueChannel.newUnsafe.

Doc from io.netty.channel.AbstractChannel.newUnsafe.

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

Annotations
@Override
remoteAddressback to summary
public InetSocketAddress remoteAddress()

Overrides io.netty.channel.AbstractChannel.remoteAddress.

Implements io.netty.channel.socket.DatagramChannel.remoteAddress, io.netty.channel.Channel.remoteAddress.

Doc from io.netty.channel.Channel.remoteAddress.

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.

Returns:InetSocketAddress

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 DatagramPacket#recipient() to determine the origination of the received message as this method will return null.

Annotations
@Override
io.netty.channel.kqueue back to summary

pack-priv final Class KQueueDatagramChannel.KQueueDatagramChannelUnsafe

extends AbstractKQueueUnsafe
Class Inheritance

Field Summary

Inherited from io.netty.channel.kqueue.AbstractKQueueChannel.AbstractKQueueUnsafe:
maybeMoreDataToReadreadPending

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
pack-priv void
Inherited from io.netty.channel.kqueue.AbstractKQueueChannel.AbstractKQueueUnsafe:
clearReadFilter0connectexecuteReadReadyRunnablefailConnectPromiseflush0readEOFreadReadyreadReadyBeforereadReadyFinallyrecvBufAllocHandleshutdownInputwriteReady

Constructor Detail

KQueueDatagramChannelUnsafeback to summary
pack-priv KQueueDatagramChannelUnsafe()

Method Detail

readReadyback to summary
pack-priv void readReady(KQueueRecvByteAllocatorHandle allocHandle)

Implements abstract io.netty.channel.kqueue.AbstractKQueueChannel.AbstractKQueueUnsafe.readReady.

Deprecated

as a consequence of KQueueRecvByteAllocatorHandle being deprecated. See corresponding docs for further information.

Annotations
@Override