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