diff options
author | Raimo Niskanen <raimo@erlang.org> | 2016-11-09 08:30:48 +0100 |
---|---|---|
committer | Raimo Niskanen <raimo@erlang.org> | 2016-11-09 08:30:48 +0100 |
commit | 992c594106ca23cd4120249cd904f6ffa7bdd13e (patch) | |
tree | c78ec2505c048874eac4fc65cc5055c0d53a2759 /lib/kernel/doc/src/gen_tcp.xml | |
parent | 251012d820ab75833c6dd787b2450a94e1bb5aa2 (diff) | |
parent | 70526ab4e8b5a0d84c5cfd27557a481707420ce2 (diff) | |
download | otp-992c594106ca23cd4120249cd904f6ffa7bdd13e.tar.gz otp-992c594106ca23cd4120249cd904f6ffa7bdd13e.tar.bz2 otp-992c594106ca23cd4120249cd904f6ffa7bdd13e.zip |
Merge branch 'gomoripeti/kernel/controlling_proc_badarg_doc/PR-1208/OTP-14022' into maint
* gomoripeti/kernel/controlling_proc_badarg_doc/PR-1208/OTP-14022:
controlling_process can return {error, badarg}
Diffstat (limited to 'lib/kernel/doc/src/gen_tcp.xml')
-rw-r--r-- | lib/kernel/doc/src/gen_tcp.xml | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/lib/kernel/doc/src/gen_tcp.xml b/lib/kernel/doc/src/gen_tcp.xml index 08454b9832..e97db20062 100644 --- a/lib/kernel/doc/src/gen_tcp.xml +++ b/lib/kernel/doc/src/gen_tcp.xml @@ -231,7 +231,11 @@ do_recv(Sock, Bs) -> <c><anno>Socket</anno></c>. The controlling process is the process 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> + <c>{error, not_owner}</c> is returned. If the process identified + by <c><anno>Pid</anno></c> is not an existing local pid, + <c>{error, badarg}</c> is returned. <c>{error, badarg}</c> may also + be returned in some cases when <c><anno>Socket</anno></c> is closed + during the execution of this function.</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. |