1. /*

  2.  * Copyright 2001-2004 The Apache Software Foundation

  3.  *

  4.  * Licensed under the Apache License, Version 2.0 (the "License");

  5.  * you may not use this file except in compliance with the License.

  6.  * You may obtain a copy of the License at

  7.  *

  8.  *     http://www.apache.org/licenses/LICENSE-2.0

  9.  *

  10.  * Unless required by applicable law or agreed to in writing, software

  11.  * distributed under the License is distributed on an "AS IS" BASIS,

  12.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

  13.  * See the License for the specific language governing permissions and

  14.  * limitations under the License.

  15.  */

  16. package org.apache.commons.net;

  17. import java.io.InputStream;

  18. 

  19. /***

  20.  * The CharGenTCPClient class is a TCP implementation of a client for the

  21.  * character generator protocol described in RFC 864.  It can also be

  22.  * used for Systat (RFC 866), Quote of the Day (RFC 865), and netstat

  23.  * (port 15).  All of these protocols involve connecting to the appropriate

  24.  * port, and reading data from an input stream.  The chargen protocol

  25.  * actually sends data until the receiving end closes the connection.  All

  26.  * of the others send only a fixed amount of data and then close the

  27.  * connection.

  28.  * <p>

  29.  * To use the CharGenTCPClient class, just establish a

  30.  * connection with

  31.  * <a href="org.apache.commons.net.SocketClient.html#connect"> connect </a>

  32.  * and call <a href="#getInputStream"> getInputStream() </a> to access

  33.  * the data.  Don't close the input stream when you're done with it.  Rather,

  34.  * call <a href="org.apache.commons.net.SocketClient.html#disconnect"> disconnect </a>

  35.  * to clean up properly.

  36.  * <p>

  37.  * <p>

  38.  * @author Daniel F. Savarese

  39.  * @see CharGenUDPClient

  40.  ***/

  41. 

  42. public final class CharGenTCPClient extends SocketClient

  43. {

  44.     /*** The systat port value of 11 according to RFC 866. ***/

  45.     public static final int SYSTAT_PORT = 11;

  46.     /*** The netstat port value of 19. ***/

  47.     public static final int NETSTAT_PORT = 15;

  48.     /*** The quote of the day port value of 17 according to RFC 865. ***/

  49.     public static final int QUOTE_OF_DAY_PORT = 17;

  50.     /*** The character generator port value of 19 according to RFC 864. ***/

  51.     public static final int CHARGEN_PORT = 19;

  52.     /*** The default chargen port.  It is set to 19 according to RFC 864. ***/

  53.     public static final int DEFAULT_PORT = 19;

  54. 

  55.     /***

  56.      * The default constructor for CharGenTCPClient.  It merely sets the

  57.      * default port to <code> DEFAULT_PORT </code>.

  58.      ***/

  59.     public CharGenTCPClient ()

  60.     {

  61.         setDefaultPort(DEFAULT_PORT);

  62.     }

  63. 

  64.     /***

  65.      * Returns an InputStream from which the server generated data can be

  66.      * read.  You should NOT close the InputStream when you're finished

  67.      * reading from it.  Rather, you should call

  68.      * <a href="org.apache.commons.net.SocketClient.html#disconnect"> disconnect </a>

  69.      * to clean up properly.

  70.      * <p>

  71.      * @return An InputStream from which the server generated data can be read.

  72.      ***/

  73.     public InputStream getInputStream()

  74.     {

  75.         return _input_;

  76.     }

  77. }

  78. 

  79. 

  80. 

  81.