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