aboutsummaryrefslogtreecommitdiffstats
path: root/lib
diff options
context:
space:
mode:
authorLukas Larsson <[email protected]>2016-06-03 11:59:54 +0200
committerLukas Larsson <[email protected]>2016-06-14 10:09:37 +0200
commit7c300789fffeacb24f1d00aa6e0797e06166c3c6 (patch)
tree25adcae9852ee56f64486acec76b97f5d08abfe0 /lib
parent7187d9a2c3728b1b32e9403ebb97e53c66e9b261 (diff)
downloadotp-7c300789fffeacb24f1d00aa6e0797e06166c3c6.tar.gz
otp-7c300789fffeacb24f1d00aa6e0797e06166c3c6.tar.bz2
otp-7c300789fffeacb24f1d00aa6e0797e06166c3c6.zip
kernel: Better explain controlling_process' tcp behaviour
Diffstat (limited to 'lib')
-rw-r--r--lib/kernel/doc/src/gen_tcp.xml8
1 files changed, 8 insertions, 0 deletions
diff --git a/lib/kernel/doc/src/gen_tcp.xml b/lib/kernel/doc/src/gen_tcp.xml
index 8bd94892ad..15a2f02c76 100644
--- a/lib/kernel/doc/src/gen_tcp.xml
+++ b/lib/kernel/doc/src/gen_tcp.xml
@@ -223,6 +223,14 @@ do_recv(Sock, Bs) ->
that receives messages from the socket. If called by any other
process than the current controlling process,
<c>{error, not_owner}</c> is returned.</p>
+ <p>If the socket is set in active mode, this function
+ will transfer any messages in the mailbox of the caller
+ to the new controlling process.
+ If any other process is interacting with the socket while
+ the transfer is happening, the transfer may not work correctly
+ and messages may remain in the caller's mailbox. For instance
+ changing the sockets active mode before the transfere is complete
+ may cause this.</p>
</desc>
</func>