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 package org.apache.commons.net;
18
19 import java.io.OutputStream;
20
21 /***
22 * The DiscardTCPClient class is a TCP implementation of a client for the
23 * Discard protocol described in RFC 863. To use the class, merely
24 * establish a connection with
25 * {@link org.apache.commons.net.SocketClient#connect connect }
26 * and call {@link #getOutputStream getOutputStream() } to
27 * retrieve the discard output stream. Don't close the output stream
28 * when you're done writing to it. Rather, call
29 * {@link org.apache.commons.net.SocketClient#disconnect disconnect }
30 * to clean up properly.
31 * <p>
32 * <p>
33 * @author Daniel F. Savarese
34 * @see DiscardUDPClient
35 ***/
36
37 public class DiscardTCPClient extends SocketClient
38 {
39 /*** The default discard port. It is set to 9 according to RFC 863. ***/
40 public static final int DEFAULT_PORT = 9;
41
42 /***
43 * The default DiscardTCPClient constructor. It merely sets the default
44 * port to <code> DEFAULT_PORT </code>.
45 ***/
46 public DiscardTCPClient ()
47 {
48 setDefaultPort(DEFAULT_PORT);
49 }
50
51 /***
52 * Returns an OutputStream through which you may write data to the server.
53 * You should NOT close the OutputStream when you're finished
54 * reading from it. Rather, you should call
55 * {@link org.apache.commons.net.SocketClient#disconnect disconnect }
56 * to clean up properly.
57 * <p>
58 * @return An OutputStream through which you can write data to the server.
59 ***/
60 public OutputStream getOutputStream()
61 {
62 return _output_;
63 }
64 }