From 33caf70b63ef4cdb7ba5f3b24d7f04c596f081eb Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B6rn=20Gustavsson?= <bjorn@erlang.org>
Date: Wed, 8 Sep 2010 16:19:54 +0200
Subject: Make gen_tcp:recv/2 consistent with ssl:recv/2

When the HTTP packet mode has been enabled for a socket,
the ssl and gen_tcp modules have different error indications
when there is an error while parsing the HTTP header:

  ssl:recv(SSLSocket, 0) -> {ok, {http_error, _Str}}

  gen_tcp:recv(Socket, 0) -> {error, {http_error, _Str}}

We have decided to change gen_tcp:recv/2 to behave the same
way as ssl:recv/2. That means that there will be always be
an ok tuple if data could be succefully read from the socket,
and an error tuple if there was a read error at the socket level.
---
 lib/kernel/doc/src/gen_tcp.xml | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

(limited to 'lib/kernel/doc/src/gen_tcp.xml')

diff --git a/lib/kernel/doc/src/gen_tcp.xml b/lib/kernel/doc/src/gen_tcp.xml
index 032dcc5251..8e7192a496 100644
--- a/lib/kernel/doc/src/gen_tcp.xml
+++ b/lib/kernel/doc/src/gen_tcp.xml
@@ -4,7 +4,7 @@
 <erlref>
   <header>
     <copyright>
-      <year>1997</year><year>2009</year>
+      <year>1997</year><year>2010</year>
       <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
@@ -284,9 +284,10 @@ socket()
       <type>
         <v>Socket = socket()</v>
         <v>Length  = int()</v>
-        <v>Packet = [char()] | binary()</v>
+        <v>Packet = [char()] | binary() | HttpPacket</v>
         <v>Timeout = int() | infinity</v>
         <v>Reason = closed | posix()</v>
+        <v>HttpPacket = see the description of <c>HttpPacket</c> in <seealso marker="erts:erlang#decode_packet/3">erlang:decode_packet/3</seealso></v>
       </type>
       <desc>
         <p>This function receives a packet from a socket in passive
-- 
cgit v1.2.3