README

Name
	etcproxy - a TCP proxy in Erlang for various testing purpose.

Description
	This proxy is useful for various network-related tests. It's capable to
	listen to a local port and relay all traffic on it to certain remote/local
	address/port. The advanced functionalities includes:

		* Split upstream packet into packet-per-byte before relaying and vice
		versa.

		* Specify delays in forward/backward traffic relaying (delays are
		inserted every N bytes).

		* Force connection closing after forward/backward relaying traffic
		reached certain threshold (in bytes).

Synopsis
	You should first install Erlang which can be obtained from here:

		http://www.erlang.org/download.html

	Then you can run etcproxy by running it directly:

		$ ./etcproxy <local port> [<remote addr>:]<remote port>

	If <remote addr> is ignored, etcproxy will default to 127.0.0.1. Advanced
	options can only be turned on by modifying macros in etcproxy script for
	now, a more convinent command-line interface will be added soon.

Authors
	chaoslawful (王晓哲)

Copyright & License
	This program is licenced under the BSD license.

	Copyright (c) 2009, chaoslawful <chaoslawful@gmail.com>.

	All rights reserved.

	Redistribution and use in source and binary forms, with or without
	modification, are permitted provided that the following conditions
	are met:

		* Redistributions of source code must retain the above copyright
		notice, this list of conditions and the following disclaimer.

		* Redistributions in binary form must reproduce the above copyright
		notice, this list of conditions and the following disclaimer in the
		documentation and/or other materials provided with the distribution.

		* Neither the name of the Taobao Inc. nor the names of its
		contributors may be used to endorse or promote products derived from
		this software without specific prior written permission.

	THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
	A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
	HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
	SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
	TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
	PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
	LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
	NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
	SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.