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