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.chargen;
19  
20  import java.io.InputStream;
21  
22  import org.apache.commons.net.SocketClient;
23  
24  /***
25   * The CharGenTCPClient class is a TCP implementation of a client for the
26   * character generator protocol described in RFC 864.  It can also be
27   * used for Systat (RFC 866), Quote of the Day (RFC 865), and netstat
28   * (port 15).  All of these protocols involve connecting to the appropriate
29   * port, and reading data from an input stream.  The chargen protocol
30   * actually sends data until the receiving end closes the connection.  All
31   * of the others send only a fixed amount of data and then close the
32   * connection.
33   * <p>
34   * To use the CharGenTCPClient class, just establish a
35   * connection with
36   * {@link org.apache.commons.net.SocketClient#connect  connect }
37   * and call {@link #getInputStream  getInputStream() } to access
38   * the data.  Don't close the input stream when you're done with it.  Rather,
39   * call {@link org.apache.commons.net.SocketClient#disconnect  disconnect }
40   * to clean up properly.
41   * <p>
42   * <p>
43   * @see CharGenUDPClient
44   ***/
45  
46  public final class CharGenTCPClient extends SocketClient
47  {
48      /*** The systat port value of 11 according to RFC 866. ***/
49      public static final int SYSTAT_PORT = 11;
50      /*** The netstat port value of 19. ***/
51      public static final int NETSTAT_PORT = 15;
52      /*** The quote of the day port value of 17 according to RFC 865. ***/
53      public static final int QUOTE_OF_DAY_PORT = 17;
54      /*** The character generator port value of 19 according to RFC 864. ***/
55      public static final int CHARGEN_PORT = 19;
56      /*** The default chargen port.  It is set to 19 according to RFC 864. ***/
57      public static final int DEFAULT_PORT = 19;
58  
59      /***
60       * The default constructor for CharGenTCPClient.  It merely sets the
61       * default port to <code> DEFAULT_PORT </code>.
62       ***/
63      public CharGenTCPClient ()
64      {
65          setDefaultPort(DEFAULT_PORT);
66      }
67  
68      /***
69       * Returns an InputStream from which the server generated data can be
70       * read.  You should NOT close the InputStream when you're finished
71       * reading from it.  Rather, you should call
72       * {@link org.apache.commons.net.SocketClient#disconnect  disconnect }
73       * to clean up properly.
74       * <p>
75       * @return An InputStream from which the server generated data can be read.
76       ***/
77      public InputStream getInputStream()
78      {
79          return _input_;
80      }
81  }
82  
83  
84  
85