    001    /*
    002     * Licensed to the Apache Software Foundation (ASF) under one or more
    003     * contributor license agreements.  See the NOTICE file distributed with
    004     * this work for additional information regarding copyright ownership.
    005     * The ASF licenses this file to You under the Apache License, Version 2.0
    006     * (the "License"); you may not use this file except in compliance with
    007     * the License.  You may obtain a copy of the License at
    008     *
    009     *      http://www.apache.org/licenses/LICENSE-2.0
    010     *
    011     * Unless required by applicable law or agreed to in writing, software
    012     * distributed under the License is distributed on an "AS IS" BASIS,
    013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    014     * See the License for the specific language governing permissions and
    015     * limitations under the License.
    016     */
    017
    018    package org.apache.commons.net.discard;
    019
    020    import java.io.OutputStream;
    021
    022    import org.apache.commons.net.SocketClient;
    023
    024    /***
    025     * The DiscardTCPClient class is a TCP implementation of a client for the
    026     * Discard protocol described in RFC 863.  To use the class, merely
    027     * establish a connection with
    028     * {@link org.apache.commons.net.SocketClient#connect  connect }
    029     * and call {@link #getOutputStream  getOutputStream() } to
    030     * retrieve the discard output stream.  Don't close the output stream
    031     * when you're done writing to it.  Rather, call
    032     * {@link org.apache.commons.net.SocketClient#disconnect  disconnect }
    033     * to clean up properly.
    034     * <p>
    035     * <p>
    036     * @author Daniel F. Savarese
    037     * @see DiscardUDPClient
    038     ***/
    039
    040    public class DiscardTCPClient extends SocketClient
    041    {
    042        /*** The default discard port.  It is set to 9 according to RFC 863. ***/
    043        public static final int DEFAULT_PORT = 9;
    044
    045        /***
    046         * The default DiscardTCPClient constructor.  It merely sets the default
    047         * port to <code> DEFAULT_PORT </code>.
    048         ***/
    049        public DiscardTCPClient ()
    050        {
    051            setDefaultPort(DEFAULT_PORT);
    052        }
    053
    054        /***
    055         * Returns an OutputStream through which you may write data to the server.
    056         * You should NOT close the OutputStream when you're finished
    057         * reading from it.  Rather, you should call
    058         * {@link org.apache.commons.net.SocketClient#disconnect  disconnect }
    059         * to clean up properly.
    060         * <p>
    061         * @return An OutputStream through which you can write data to the server.
    062         ***/
    063        public OutputStream getOutputStream()
    064        {
    065            return _output_;
    066        }
    067    }