View Javadoc

    1   /*
    2    * Copyright 2012 The Netty Project
    3    *
    4    * The Netty Project licenses this file to you under the Apache License,
    5    * version 2.0 (the "License"); you may not use this file except in compliance
    6    * with the License. You may obtain a copy of the License at:
    7    *
    8    *   http://www.apache.org/licenses/LICENSE-2.0
    9    *
    10   * Unless required by applicable law or agreed to in writing, software
    11   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
    12   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
    13   * License for the specific language governing permissions and limitations
    14   * under the License.
    15   */
    16  package org.jboss.netty.channel.socket;
    17
    18  import java.net.InetAddress;
    19  import java.net.InetSocketAddress;
    20  import java.net.NetworkInterface;
    21
    22  import org.jboss.netty.channel.Channel;
    23  import org.jboss.netty.channel.ChannelFuture;
    24
    25  /**
    26   * A UDP/IP {@link Channel} which is created by {@link DatagramChannelFactory}.
    27   *
    28   * @apiviz.landmark
    29   * @apiviz.composedOf org.jboss.netty.channel.socket.DatagramChannelConfig
    30   */
    31  public interface DatagramChannel extends Channel {
    32      DatagramChannelConfig getConfig();
    33      InetSocketAddress getLocalAddress();
    34      InetSocketAddress getRemoteAddress();
    35
    36      /**
    37       * Joins a multicast group.
    38       */
    39      ChannelFuture joinGroup(InetAddress multicastAddress);
    40
    41      /**
    42       * Joins the specified multicast group at the specified interface.
    43       */
    44      ChannelFuture joinGroup(InetSocketAddress multicastAddress, NetworkInterface networkInterface);
    45
    46      /**
    47       * Leaves a multicast group.
    48       */
    49      ChannelFuture leaveGroup(InetAddress multicastAddress);
    50
    51      /**
    52       * Leaves a multicast group on a specified local interface.
    53       */
    54      ChannelFuture leaveGroup(InetSocketAddress multicastAddress, NetworkInterface networkInterface);
    55  }