/*
* Copyright 2012 The Netty Project
*
* The Netty Project licenses this file to you under the Apache License,
* version 2.0 (the "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*/
package io.netty.channel.socket;
import io.netty.channel.
Channel;
import io.netty.channel.
ChannelFuture;
import io.netty.channel.
ChannelPromise;
import java.net.
InetAddress;
import java.net.
InetSocketAddress;
import java.net.
NetworkInterface;
/**
* A UDP/IP {@link Channel}.
*/
public interface
DatagramChannel extends
Channel {
@
Override
DatagramChannelConfig config();
@
Override
InetSocketAddress localAddress();
@
Override
InetSocketAddress remoteAddress();
/**
* Return {@code true} if the {@link DatagramChannel} is connected to the remote peer.
*/
boolean
isConnected();
/**
* Joins a multicast group and notifies the {@link ChannelFuture} once the operation completes.
*/
ChannelFuture joinGroup(
InetAddress multicastAddress);
/**
* Joins a multicast group and notifies the {@link ChannelFuture} once the operation completes.
*
* The given {@link ChannelFuture} will be notified and also returned.
*/
ChannelFuture joinGroup(
InetAddress multicastAddress,
ChannelPromise future);
/**
* Joins the specified multicast group at the specified interface and notifies the {@link ChannelFuture}
* once the operation completes.
*/
ChannelFuture joinGroup(
InetSocketAddress multicastAddress,
NetworkInterface networkInterface);
/**
* Joins the specified multicast group at the specified interface and notifies the {@link ChannelFuture}
* once the operation completes.
*
* The given {@link ChannelFuture} will be notified and also returned.
*/
ChannelFuture joinGroup(
InetSocketAddress multicastAddress,
NetworkInterface networkInterface,
ChannelPromise future);
/**
* Joins the specified multicast group at the specified interface and notifies the {@link 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 {@link ChannelFuture}
* once the operation completes.
*
* The given {@link ChannelFuture} will be notified and also returned.
*/
ChannelFuture joinGroup(
InetAddress multicastAddress,
NetworkInterface networkInterface,
InetAddress source,
ChannelPromise future);
/**
* Leaves a multicast group and notifies the {@link ChannelFuture} once the operation completes.
*/
ChannelFuture leaveGroup(
InetAddress multicastAddress);
/**
* Leaves a multicast group and notifies the {@link ChannelFuture} once the operation completes.
*
* The given {@link ChannelFuture} will be notified and also returned.
*/
ChannelFuture leaveGroup(
InetAddress multicastAddress,
ChannelPromise future);
/**
* Leaves a multicast group on a specified local interface and notifies the {@link ChannelFuture} once the
* operation completes.
*/
ChannelFuture leaveGroup(
InetSocketAddress multicastAddress,
NetworkInterface networkInterface);
/**
* Leaves a multicast group on a specified local interface and notifies the {@link ChannelFuture} once the
* operation completes.
*
* The given {@link ChannelFuture} will be notified and also returned.
*/
ChannelFuture leaveGroup(
InetSocketAddress multicastAddress,
NetworkInterface networkInterface,
ChannelPromise future);
/**
* Leave the specified multicast group at the specified interface using the specified source and notifies
* the {@link 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 {@link ChannelFuture} once the operation completes.
*
* The given {@link ChannelFuture} will be notified and also returned.
*/
ChannelFuture leaveGroup(
InetAddress multicastAddress,
NetworkInterface networkInterface,
InetAddress source,
ChannelPromise future);
/**
* Block the given sourceToBlock address for the given multicastAddress on the given networkInterface and notifies
* the {@link ChannelFuture} once the operation completes.
*
* The given {@link ChannelFuture} will be notified and also returned.
*/
ChannelFuture block(
InetAddress multicastAddress,
NetworkInterface networkInterface,
InetAddress sourceToBlock);
/**
* Block the given sourceToBlock address for the given multicastAddress on the given networkInterface and notifies
* the {@link ChannelFuture} once the operation completes.
*
* The given {@link ChannelFuture} will be notified and also returned.
*/
ChannelFuture block(
InetAddress multicastAddress,
NetworkInterface networkInterface,
InetAddress sourceToBlock,
ChannelPromise future);
/**
* Block the given sourceToBlock address for the given multicastAddress and notifies the {@link ChannelFuture} once
* the operation completes.
*
* The given {@link ChannelFuture} will be notified and also returned.
*/
ChannelFuture block(
InetAddress multicastAddress,
InetAddress sourceToBlock);
/**
* Block the given sourceToBlock address for the given multicastAddress and notifies the {@link ChannelFuture} once
* the operation completes.
*
* The given {@link ChannelFuture} will be notified and also returned.
*/
ChannelFuture block(
InetAddress multicastAddress,
InetAddress sourceToBlock,
ChannelPromise future);
}