View Javadoc
1 package org.apache.commons.net; 2 3 /* ==================================================================== 4 * The Apache Software License, Version 1.1 5 * 6 * Copyright (c) 2001 The Apache Software Foundation. All rights 7 * reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in 18 * the documentation and/or other materials provided with the 19 * distribution. 20 * 21 * 3. The end-user documentation included with the redistribution, 22 * if any, must include the following acknowledgment: 23 * "This product includes software developed by the 24 * Apache Software Foundation (http://www.apache.org/)." 25 * Alternately, this acknowledgment may appear in the software itself, 26 * if and wherever such third-party acknowledgments normally appear. 27 * 28 * 4. The names "Apache" and "Apache Software Foundation" and 29 * "Apache Commons" must not be used to endorse or promote products 30 * derived from this software without prior written permission. For 31 * written permission, please contact apache@apache.org. 32 * 33 * 5. Products derived from this software may not be called "Apache", 34 * nor may "Apache" appear in their name, without 35 * prior written permission of the Apache Software Foundation. 36 * 37 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED 38 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 39 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 40 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR 41 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 42 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 43 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 44 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 45 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 46 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 47 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 48 * SUCH DAMAGE. 49 * ==================================================================== 50 * 51 * This software consists of voluntary contributions made by many 52 * individuals on behalf of the Apache Software Foundation. For more 53 * information on the Apache Software Foundation, please see 54 * <http://www.apache.org/>;. 55 */ 56 57 import java.io.InputStream; 58 59 /**** 60 * The EchoTCPClient class is a TCP implementation of a client for the 61 * Echo protocol described in RFC 862. To use the class, merely 62 * establish a connection with 63 * <a href="org.apache.commons.net.SocketClient.html#connect"> connect </a> 64 * and call <a href="#getOutputStream"> getOutputStream() </a> to 65 * retrieve the echo output stream and 66 * <a href="org.apache.commons.net.DiscardTCPClient.html#getInputStream"> 67 * getInputStream() </a> to get the echo input stream. 68 * Don't close either stream when you're done using them. Rather, call 69 * <a href="org.apache.commons.net.SocketClient.html#disconnect"> disconnect </a> 70 * to clean up properly. 71 * <p> 72 * <p> 73 * @author Daniel F. Savarese 74 * @see EchoUDPClient 75 * @see DiscardTCPClient 76 ***/ 77 78 public final class EchoTCPClient extends DiscardTCPClient 79 { 80 /**** The default echo port. It is set to 7 according to RFC 862. ***/ 81 public static final int DEFAULT_PORT = 7; 82 83 /**** 84 * The default EchoTCPClient constructor. It merely sets the default 85 * port to <code> DEFAULT_PORT </code>. 86 ***/ 87 public EchoTCPClient () 88 { 89 setDefaultPort(DEFAULT_PORT); 90 } 91 92 /**** 93 * Returns an InputStream from which you may read echoed data from 94 * the server. You should NOT close the InputStream when you're finished 95 * reading from it. Rather, you should call 96 * <a href="org.apache.commons.net.SocketClient.html#disconnect"> disconnect </a> 97 * to clean up properly. 98 * <p> 99 * @return An InputStream from which you can read echoed data from the 100 * server. 101 ***/ 102 public InputStream getInputStream() 103 { 104 return _input_; 105 } 106 107 }

This page was automatically generated by Maven