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 EchoTCPClient class is a TCP implementation of a client for the
23 * Echo protocol described in RFC 862. To use the class, merely
24 * establish a connection with
25 * {@link org.apache.commons.net.SocketClient#connect connect }
26 * and call {@link DiscardTCPClient#getOutputStream getOutputStream() } to
27 * retrieve the echo output stream and
28 * {@link #getInputStream getInputStream() }
29 * to get the echo input stream.
30 * Don't close either stream when you're done using them. Rather, call
31 * {@link org.apache.commons.net.SocketClient#disconnect disconnect }
32 * to clean up properly.
33 * <p>
34 * <p>
35 * @author Daniel F. Savarese
36 * @see EchoUDPClient
37 * @see DiscardTCPClient
38 ***/
39
40 public final class EchoTCPClient extends DiscardTCPClient
41 {
42 /*** The default echo port. It is set to 7 according to RFC 862. ***/
43 public static final int DEFAULT_PORT = 7;
44
45 /***
46 * The default EchoTCPClient constructor. It merely sets the default
47 * port to <code> DEFAULT_PORT </code>.
48 ***/
49 public EchoTCPClient ()
50 {
51 setDefaultPort(DEFAULT_PORT);
52 }
53
54 /***
55 * Returns an InputStream from which you may read echoed data from
56 * the server. You should NOT close the InputStream when you're finished
57 * reading from it. Rather, you should call
58 * {@link org.apache.commons.net.SocketClient#disconnect disconnect }
59 * to clean up properly.
60 * <p>
61 * @return An InputStream from which you can read echoed data from the
62 * server.
63 ***/
64 public InputStream getInputStream()
65 {
66 return _input_;
67 }
68
69 }