panda.net.echo.EchoTCPClient Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of panda-nets Show documentation

Panda Nets is a client side library of many basic Internet protocols.

There is a newer version: 1.8.0

package panda.net.echo;

import java.io.InputStream;

import panda.net.discard.DiscardTCPClient;

/***
 * 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
 * {@link panda.net.SocketClient#connect connect } and call {@link DiscardTCPClient#getOutputStream
 * getOutputStream() } to retrieve the echo output stream and {@link #getInputStream
 * getInputStream() } to get the echo input stream. Don't close either stream when you're done using
 * them. Rather, call {@link panda.net.SocketClient#disconnect disconnect } to clean up properly.
 * 
 * @see EchoUDPClient
 * @see DiscardTCPClient
 ***/

public final class EchoTCPClient extends DiscardTCPClient {
	/*** The default echo port. It is set to 7 according to RFC 862. ***/
	public static final int DEFAULT_PORT = 7;

	/***
	 * The default EchoTCPClient constructor. It merely sets the default port to
	 *  DEFAULT_PORT .
	 ***/
	public EchoTCPClient() {
		setDefaultPort(DEFAULT_PORT);
	}

	/***
	 * 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. Rather, you should call
	 * {@link panda.net.SocketClient#disconnect disconnect } to clean up properly.
	 * 
	 * @return An InputStream from which you can read echoed data from the server.
	 ***/
	public InputStream getInputStream() {
		return _input_;
	}

}