Top Description Fields Constructors Methods
io.netty.channel.socket.oio

public Class OioDatagramChannel

extends AbstractOioMessageChannel
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
@Deprecated
Imports
io.netty.buffer.ByteBuf, .ByteBufUtil, io.netty.channel.AddressedEnvelope, .Channel, .ChannelException, .ChannelFuture, .ChannelMetadata, .ChannelOption, .ChannelOutboundBuffer, .ChannelPromise, .RecvByteBufAllocator, io.netty.channel.oio.AbstractOioMessageChannel, io.netty.channel.socket.DatagramChannel, .DatagramChannelConfig, .DatagramPacket, io.netty.util.internal.EmptyArrays, .PlatformDependent, .StringUtil, io.netty.util.internal.logging.InternalLogger, .InternalLoggerFactory, java.io.IOException, java.net.InetAddress, .InetSocketAddress, .MulticastSocket, .NetworkInterface, .SocketAddress, .SocketException, .SocketTimeoutException, java.nio.channels.NotYetConnectedException, .UnresolvedAddressException, java.util.List, .Locale

Deprecated

use NIO / EPOLL / KQUEUE transport.

An OIO datagram Channel that sends and receives an AddressedEnvelope<ByteBuf, SocketAddress>.
See Also
AddressedEnvelope, DatagramPacket

Field Summary

Modifier and TypeField and Description
private final OioDatagramChannelConfig
config

Deprecated as a consequence of OioDatagramChannelConfig being deprecated.
private static final String
private static final InternalLogger
private static final ChannelMetadata
private final MulticastSocket
private final DatagramPacket

Constructor Summary

AccessConstructor and Description
public
OioDatagramChannel()

Create a new instance with an new MulticastSocket.

public
OioDatagramChannel(MulticastSocket
the MulticastSocket which is used by this instance
socket
)

Create a new instance from the given MulticastSocket.

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(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress sourceToBlock, 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 DatagramChannelConfig
config()

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

Returns the configuration of this channel.
protected void
doBind(SocketAddress localAddress)

Implements abstract io.netty.channel.AbstractChannel.doBind.

Bind the Channel to the SocketAddress
protected void
protected void
doConnect(SocketAddress remoteAddress, SocketAddress localAddress)

Implements abstract io.netty.channel.oio.AbstractOioChannel.doConnect.

Connect to the remote peer using the given localAddress if one is specified or null otherwise.
protected void
doDisconnect()

Implements abstract io.netty.channel.AbstractChannel.doDisconnect.

Disconnect this Channel from its remote peer
protected int
doReadMessages(List<Object> buf)

Implements abstract io.netty.channel.oio.AbstractOioMessageChannel.doReadMessages.

Read messages into the given array and return the amount which was read.
protected void
doWrite(ChannelOutboundBuffer in)

Implements abstract io.netty.channel.AbstractChannel.doWrite.

Flush the content of the given buffer to the remote peer.
private void
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()

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

Implements io.netty.channel.Channel.isOpen.

Returns true if the Channel is open and may get active later
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(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source, 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(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source, 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 SocketAddress
localAddress0()

Implements abstract io.netty.channel.AbstractChannel.localAddress0.

Returns the SocketAddress which is bound locally.
public ChannelMetadata
metadata()

Implements io.netty.channel.Channel.metadata.

Return the ChannelMetadata of the Channel which describe the nature of the Channel.
private static MulticastSocket
public InetSocketAddress
protected SocketAddress
remoteAddress0()

Implements abstract io.netty.channel.AbstractChannel.remoteAddress0.

Return the SocketAddress which the Channel is connected to.
Inherited from io.netty.channel.oio.AbstractOioMessageChannel:
doRead

Field Detail

configback to summary
private final OioDatagramChannelConfig config

Deprecated

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

EXPECTED_TYPESback to summary
private static final String EXPECTED_TYPES
loggerback to summary
private static final InternalLogger logger

Hides io.netty.channel.AbstractChannel.logger.

METADATAback to summary
private static final ChannelMetadata METADATA
socketback to summary
private final MulticastSocket socket
tmpPacketback to summary
private final DatagramPacket tmpPacket

Constructor Detail

OioDatagramChannelback to summary
public OioDatagramChannel()

Create a new instance with an new MulticastSocket.

OioDatagramChannelback to summary
public OioDatagramChannel(MulticastSocket socket)

Create a new instance from the given MulticastSocket.

Parameters
socket:MulticastSocket

the MulticastSocket which is used by this instance

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(InetAddress multicastAddress, NetworkInterface networkInterface, 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 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 DatagramChannelConfig 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. This can be safely cast to OioDatagramChannelConfig.

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

Implements abstract io.netty.channel.AbstractChannel.doBind.

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

Bind the Channel to the SocketAddress

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

Implements abstract io.netty.channel.AbstractChannel.doClose.

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

Close the Channel

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

Implements abstract io.netty.channel.oio.AbstractOioChannel.doConnect.

Doc from io.netty.channel.oio.AbstractOioChannel.doConnect.

Connect to the remote peer using the given localAddress if one is specified or null otherwise.

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

Implements abstract io.netty.channel.AbstractChannel.doDisconnect.

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

Disconnect this Channel from its remote peer

Annotations
@Override
doReadMessagesback to summary
protected int doReadMessages(List<Object> buf) throws Exception

Implements abstract io.netty.channel.oio.AbstractOioMessageChannel.doReadMessages.

Doc from io.netty.channel.oio.AbstractOioMessageChannel.doReadMessages.

Read messages into the given array and return the amount which was read.

Annotations
@Override
doWriteback to summary
protected void doWrite(ChannelOutboundBuffer in) throws Exception

Implements abstract io.netty.channel.AbstractChannel.doWrite.

Doc from io.netty.channel.AbstractChannel.doWrite.

Flush the content of the given buffer to the remote peer.

Annotations
@Override
ensureBoundback to summary
private void ensureBound()
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()

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
isOpenback to summary
public boolean isOpen()

Implements io.netty.channel.Channel.isOpen.

Doc from io.netty.channel.Channel.isOpen.

Returns true if the Channel is open and may get active later

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(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source, 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(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source, 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
localAddress0back to summary
protected SocketAddress localAddress0()

Implements abstract io.netty.channel.AbstractChannel.localAddress0.

Doc from io.netty.channel.AbstractChannel.localAddress0.

Returns the SocketAddress which is bound locally.

Annotations
@Override
metadataback to summary
public ChannelMetadata metadata()

Implements io.netty.channel.Channel.metadata.

Doc from io.netty.channel.Channel.metadata.

Return the ChannelMetadata of the Channel which describe the nature of the Channel.

Annotations
@Override
newSocketback to summary
private static MulticastSocket newSocket()
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
remoteAddress0back to summary
protected SocketAddress remoteAddress0()

Implements abstract io.netty.channel.AbstractChannel.remoteAddress0.

Doc from io.netty.channel.AbstractChannel.remoteAddress0.

Return the SocketAddress which the Channel is connected to.

Annotations
@Override