diff options
Diffstat (limited to 'examples/tcp_reverse/README.md')
-rw-r--r-- | examples/tcp_reverse/README.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/examples/tcp_reverse/README.md b/examples/tcp_reverse/README.md new file mode 100644 index 0000000..c73ae60 --- /dev/null +++ b/examples/tcp_reverse/README.md @@ -0,0 +1,29 @@ +Ranch TCP Reverse +================= + +This example uses a gen_server to handle a protocol to revese input. See +reverse_protocol.erl for the implementation, and documentation at +the following URL: + +http://ninenines.eu/docs/en/ranch/HEAD/guide/protocols/#using_gen_server + +To build the example: +``` bash +$ make +``` + +To start the release in the foreground: + +``` bash +$ ./_rel/bin/tcp_reverse_example console +``` + +Then start a telnet session to port 5555: +``` bash +$ telnet localhost 5555 +``` + +Type in a few words and see them reversed! Amazing! + +Be aware that there is a timeout of 5 seconds without receiving +data before the example server disconnects your session. |