    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.OutputStream;
    58
    59  /****
    60   * The DiscardTCPClient class is a TCP implementation of a client for the
    61   * Discard protocol described in RFC 863.  To use the class, merely
    62   * establish a connection with
    63   * <a href="org.apache.commons.net.SocketClient.html#connect"> connect </a>
    64   * and call <a href="#getOutputStream"> getOutputStream() </a> to
    65   * retrieve the discard output stream.  Don't close the output stream
    66   * when you're done writing to it.  Rather, call
    67   * <a href="org.apache.commons.net.SocketClient.html#disconnect"> disconnect </a>
    68   * to clean up properly.
    69   * <p>
    70   * <p>
    71   * @author Daniel F. Savarese
    72   * @see DiscardUDPClient
    73   ***/
    74
    75  public class DiscardTCPClient extends SocketClient
    76  {
    77      /**** The default discard port.  It is set to 9 according to RFC 863. ***/
    78      public static final int DEFAULT_PORT = 9;
    79
    80      /****
    81       * The default DiscardTCPClient constructor.  It merely sets the default
    82       * port to <code> DEFAULT_PORT </code>.
    83       ***/
    84      public DiscardTCPClient ()
    85      {
    86          setDefaultPort(DEFAULT_PORT);
    87      }
    88
    89      /****
    90       * Returns an OutputStream through which you may write data to the server.
    91       * You should NOT close the OutputStream when you're finished
    92       * reading from it.  Rather, you should call
    93       * <a href="org.apache.commons.net.SocketClient.html#disconnect"> disconnect </a>
    94       * to clean up properly.
    95       * <p>
    96       * @return An OutputStream through which you can write data to the server.
    97       ***/
    98      public OutputStream getOutputStream()
    99      {
    100         return _output_;
    101     }
    102 }

This page was automatically generated by Maven