1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 package org.apache.commons.net.discard;
19
20 import java.io.OutputStream;
21
22 import org.apache.commons.net.SocketClient;
23
24 /**
25 * 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
26 * with {@link org.apache.commons.net.SocketClient#connect connect } and call {@link #getOutputStream getOutputStream() } to retrieve the discard output stream.
27 * 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
28 * properly.
29 *
30 * @see DiscardUDPClient
31 */
32 public class DiscardTCPClient extends SocketClient {
33
34 /** The default discard port. It is set to 9 according to RFC 863. */
35 public static final int DEFAULT_PORT = 9;
36
37 /**
38 * The default DiscardTCPClient constructor. It merely sets the default port to <code>DEFAULT_PORT</code>.
39 */
40 public DiscardTCPClient() {
41 setDefaultPort(DEFAULT_PORT);
42 }
43
44 /**
45 * 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.
46 * Rather, you should call {@link org.apache.commons.net.SocketClient#disconnect disconnect } to clean up properly.
47 *
48 * @return An OutputStream through which you can write data to the server.
49 */
50 public OutputStream getOutputStream() {
51 return _output_;
52 }
53 }