aboutsummaryrefslogtreecommitdiffstats
path: root/manual
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2013-12-07 16:20:30 +0100
committerLoïc Hoguin <[email protected]>2013-12-07 16:20:30 +0100
commitc331076bad75ed89ff01c67d9e2c12688da7cc10 (patch)
treeed68d8e36537c9a867bbe23205abdef53e344777 /manual
parent20a48ce65e0f14898e5027df080ec01813c1feb0 (diff)
downloadranch-c331076bad75ed89ff01c67d9e2c12688da7cc10.tar.gz
ranch-c331076bad75ed89ff01c67d9e2c12688da7cc10.tar.bz2
ranch-c331076bad75ed89ff01c67d9e2c12688da7cc10.zip
Add Transport:shutdown/2
Allows closing the socket in one or two directions.
Diffstat (limited to 'manual')
-rw-r--r--manual/ranch_transport.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/manual/ranch_transport.md b/manual/ranch_transport.md
index 291b0e4..7ae3e31 100644
--- a/manual/ranch_transport.md
+++ b/manual/ranch_transport.md
@@ -167,6 +167,14 @@ Callbacks
>
> This is mainly useful for switching to active or passive mode.
+### shutdown(CSocket, How) -> ok | {error, atom()}
+
+> Types:
+> * CSocket = any()
+> * How = read | write | read_write
+>
+> Immediately close the socket in one or two directions.
+
### sockname(CSocket) -> {ok, {IP, Port}} | {error, atom()}
> Types: