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   * <p>
35   * <p>
36   * @see DiscardUDPClient
37   ***/
38  
39  public class DiscardTCPClient extends SocketClient
40  {
41      /*** The default discard port.  It is set to 9 according to RFC 863. ***/
42      public static final int DEFAULT_PORT = 9;
43  
44      /***
45       * The default DiscardTCPClient constructor.  It merely sets the default
46       * port to <code> DEFAULT_PORT </code>.
47       ***/
48      public DiscardTCPClient ()
49      {
50          setDefaultPort(DEFAULT_PORT);
51      }
52  
53      /***
54       * Returns an OutputStream through which you may write data to the server.
55       * You should NOT close the OutputStream when you're finished
56       * reading from it.  Rather, you should call
57       * {@link org.apache.commons.net.SocketClient#disconnect  disconnect }
58       * to clean up properly.
59       * <p>
60       * @return An OutputStream through which you can write data to the server.
61       ***/
62      public OutputStream getOutputStream()
63      {
64          return _output_;
65      }
66  }