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