diff options
author | Loïc Hoguin <[email protected]> | 2013-11-25 15:02:42 +0100 |
---|---|---|
committer | Loïc Hoguin <[email protected]> | 2013-11-25 15:02:42 +0100 |
commit | d2318c0a286daf51b4fe8afc5c6a232eee71ca72 (patch) | |
tree | 30a4e2cfa6f6d63c9068145eb82e9ec77c48ec2b /manual/ranch_app.md | |
parent | e4b3cf94ea41963fa0d65559e7ebb271bd96ba55 (diff) | |
download | ranch-d2318c0a286daf51b4fe8afc5c6a232eee71ca72.tar.gz ranch-d2318c0a286daf51b4fe8afc5c6a232eee71ca72.tar.bz2 ranch-d2318c0a286daf51b4fe8afc5c6a232eee71ca72.zip |
Add a manual
This is the manual for what is going to be in 1.0. It includes
two things that are not in the code yet: the shutdown option
and the accept_ack transport callback.
Diffstat (limited to 'manual/ranch_app.md')
-rw-r--r-- | manual/ranch_app.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/manual/ranch_app.md b/manual/ranch_app.md new file mode 100644 index 0000000..380931c --- /dev/null +++ b/manual/ranch_app.md @@ -0,0 +1,28 @@ +The Ranch Application +===================== + +Socket acceptor pool for TCP protocols. + +Dependencies +------------ + +The `ranch` application has no particular dependency required +to start. + +It has optional dependencies that are only required when +listening for SSL connections. The dependencies are `crypto`, +`asn1`, `public_key` and `ssl`. They are started automatically +if they weren't before. + +Environment +----------- + +The `ranch` application defines one application environment +configuration parameter. + + - profile (false) + - When enabled, Ranch will start `etop` profiling automatically. + +You can use the `ranch_app:profile_output/0` function to stop +profiling and output the results to the files `procs.profile` +and `total.profile`. Do not use in production. |