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