    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 *      https://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
    018package org.apache.commons.net.discard;
    019
    020import java.io.OutputStream;
    021
    022import org.apache.commons.net.SocketClient;
    023
    024/**
    025 * The DiscardTCPClient class is a TCP implementation of a client for the Discard protocol described in RFC 863. To use the class, merely establish a connection
    026 * with {@link org.apache.commons.net.SocketClient#connect connect} and call {@link #getOutputStream getOutputStream()} to retrieve the discard output stream.
    027 * Don't close the output stream when you're done writing to it. Rather, call {@link org.apache.commons.net.SocketClient#disconnect disconnect} to clean up
    028 * properly.
    029 *
    030 * @see DiscardUDPClient
    031 */
    032public class DiscardTCPClient extends SocketClient {
    033
    034    /** The default discard port. It is set to 9 according to RFC 863. */
    035    public static final int DEFAULT_PORT = 9;
    036
    037    /**
    038     * The default DiscardTCPClient constructor. It merely sets the default port to {@code DEFAULT_PORT}.
    039     */
    040    public DiscardTCPClient() {
    041        setDefaultPort(DEFAULT_PORT);
    042    }
    043
    044    /**
    045     * Gets an OutputStream through which you may write data to the server. You should NOT close the OutputStream when you're finished reading from it.
    046     * Rather, you should call {@link org.apache.commons.net.SocketClient#disconnect disconnect} to clean up properly.
    047     *
    048     * @return An OutputStream through which you can write data to the server.
    049     */
    050    public OutputStream getOutputStream() {
    051        return _output_;
    052    }
    053}