    View Javadoc
    1   package org.apache.commons.net;
    2
    3   /* ====================================================================
    4    * The Apache Software License, Version 1.1
    5    *
    6    * Copyright (c) 2001 The Apache Software Foundation.  All rights
    7    * reserved.
    8    *
    9    * Redistribution and use in source and binary forms, with or without
    10   * modification, are permitted provided that the following conditions
    11   * are met:
    12   *
    13   * 1. Redistributions of source code must retain the above copyright
    14   *    notice, this list of conditions and the following disclaimer.
    15   *
    16   * 2. Redistributions in binary form must reproduce the above copyright
    17   *    notice, this list of conditions and the following disclaimer in
    18   *    the documentation and/or other materials provided with the
    19   *    distribution.
    20   *
    21   * 3. The end-user documentation included with the redistribution,
    22   *    if any, must include the following acknowledgment:
    23   *       "This product includes software developed by the
    24   *        Apache Software Foundation (http://www.apache.org/)."
    25   *    Alternately, this acknowledgment may appear in the software itself,
    26   *    if and wherever such third-party acknowledgments normally appear.
    27   *
    28   * 4. The names "Apache" and "Apache Software Foundation" and
    29   *    "Apache Commons" must not be used to endorse or promote products
    30   *    derived from this software without prior written permission. For
    31   *    written permission, please contact apache@apache.org.
    32   *
    33   * 5. Products derived from this software may not be called "Apache",
    34   *    nor may "Apache" appear in their name, without
    35   *    prior written permission of the Apache Software Foundation.
    36   *
    37   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
    38   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
    39   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
    40   * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
    41   * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    42   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
    43   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
    44   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
    45   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
    46   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
    47   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    48   * SUCH DAMAGE.
    49   * ====================================================================
    50   *
    51   * This software consists of voluntary contributions made by many
    52   * individuals on behalf of the Apache Software Foundation.  For more
    53   * information on the Apache Software Foundation, please see
    54   * <http://www.apache.org/>;.
    55   */
    56
    57  import java.io.IOException;
    58  import java.net.DatagramPacket;
    59  import java.net.InetAddress;
    60
    61  /****
    62   * The DiscardUDPClient class is a UDP implementation of a client for the
    63   * Discard protocol described in RFC 863.  To use the class,
    64   * just open a local UDP port
    65   * with <a href="org.apache.commons.net.DatagramSocketClient.html#open"> open </a>
    66   * and call <a href="#send"> send </a> to send datagrams to the server
    67   * After you're done sending discard data, call
    68   * <a href="org.apache.commons.net.DatagramSocketClient.html#close"> close() </a>
    69   * to clean up properly.
    70   * <p>
    71   * <p>
    72   * @author Daniel F. Savarese
    73   * @see DiscardTCPClient
    74   ***/
    75
    76  public class DiscardUDPClient extends DatagramSocketClient
    77  {
    78      /**** The default discard port.  It is set to 9 according to RFC 863. ***/
    79      public static final int DEFAULT_PORT = 9;
    80
    81      DatagramPacket _sendPacket;
    82
    83      public DiscardUDPClient()
    84      {
    85          _sendPacket = new DatagramPacket(new byte[0], 0);
    86      }
    87
    88
    89      /****
    90       * Sends the specified data to the specified server at the specified port.
    91       * <p>
    92       * @param data  The discard data to send.
    93       * @param length  The length of the data to send.  Should be less than
    94       *    or equal to the length of the data byte array.
    95       * @param host  The address of the server.
    96       * @param port  The service port.
    97       * @exception IOException If an error occurs during the datagram send
    98       *            operation.
    99       ***/
    100     public void send(byte[] data, int length, InetAddress host, int port)
    101     throws IOException
    102     {
    103         _sendPacket.setData(data);
    104         _sendPacket.setLength(length);
    105         _sendPacket.setAddress(host);
    106         _sendPacket.setPort(port);
    107         _socket_.send(_sendPacket);
    108     }
    109
    110
    111     /****
    112      * Same as
    113      * <code>send(data, length, host. DiscardUDPClient.DEFAULT_PORT)</code>.
    114      ***/
    115     public void send(byte[] data, int length, InetAddress host)
    116     throws IOException
    117     {
    118         send(data, length, host, DEFAULT_PORT);
    119     }
    120
    121
    122     /****
    123      * Same as
    124      * <code>send(data, data.length, host. DiscardUDPClient.DEFAULT_PORT)</code>.
    125      ***/
    126     public void send(byte[] data, InetAddress host) throws IOException
    127     {
    128         send(data, data.length, host, DEFAULT_PORT);
    129     }
    130
    131 }
    132

This page was automatically generated by Maven