View Javadoc

    1   /*
    2    * Copyright 2009 Red Hat, Inc.
    3    *
    4    * Red Hat licenses this file to you under the Apache License, version 2.0
    5    * (the "License"); you may not use this file except in compliance with the
    6    * 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
    24  /**
    25   * A UDP/IP {@link Channel} which is created by {@link DatagramChannelFactory}.
    26   *
    27   * @author <a href="http://www.jboss.org/netty/">The Netty Project</a>
    28   * @author <a href="http://gleamynode.net/">Trustin Lee</a>
    29   *
    30   * @version $Rev: 2080 $, $Date: 2010-01-26 18:04:19 +0900 (Tue, 26 Jan 2010) $
    31   *
    32   * @apiviz.landmark
    33   * @apiviz.composedOf org.jboss.netty.channel.socket.DatagramChannelConfig
    34   */
    35  public interface DatagramChannel extends Channel {
    36      DatagramChannelConfig getConfig();
    37      InetSocketAddress getLocalAddress();
    38      InetSocketAddress getRemoteAddress();
    39
    40      /**
    41       * Joins a multicast group.
    42       */
    43      void joinGroup(InetAddress multicastAddress);
    44
    45      /**
    46       * Joins the specified multicast group at the specified interface.
    47       */
    48      void joinGroup(InetSocketAddress multicastAddress, NetworkInterface networkInterface);
    49
    50      /**
    51       * Leaves a multicast group.
    52       */
    53      void leaveGroup(InetAddress multicastAddress);
    54
    55      /**
    56       * Leaves a multicast group on a specified local interface.
    57       */
    58      void leaveGroup(InetSocketAddress multicastAddress, NetworkInterface networkInterface);
    59  }