aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSverker Eriksson <[email protected]>2011-09-15 18:05:13 +0200
committerSverker Eriksson <[email protected]>2011-09-16 18:52:38 +0200
commitee9fe61f2fae977aff53a4c4a6fa647b02f9092b (patch)
tree7fe49f913fb3d1451baf3d8f413e2ef1f1bec0cb
parent2d6bb0b74427e29b9333bba57683472181243ba5 (diff)
downloadotp-ee9fe61f2fae977aff53a4c4a6fa647b02f9092b.tar.gz
otp-ee9fe61f2fae977aff53a4c4a6fa647b02f9092b.tar.bz2
otp-ee9fe61f2fae977aff53a4c4a6fa647b02f9092b.zip
[inet] Clearify doc about packet types httph and httph_bin
-rw-r--r--lib/kernel/doc/src/inet.xml10
1 files changed, 8 insertions, 2 deletions
diff --git a/lib/kernel/doc/src/inet.xml b/lib/kernel/doc/src/inet.xml
index b36c28e027..fad5af85bb 100644
--- a/lib/kernel/doc/src/inet.xml
+++ b/lib/kernel/doc/src/inet.xml
@@ -555,8 +555,14 @@ fe80::204:acff:fe17:bf38
mode will return <c>{ok, HttpPacket}</c> from <c>gen_tcp:recv</c>
while an active socket will send messages like <c>{http,
Socket, HttpPacket}</c>.</p>
- <p>Note that the packet type <c>httph</c> is not
- needed when reading from a socket.</p>
+ </item>
+ <tag><c>httph | httph_bin</c></tag>
+ <item>
+ <p>These two types are often not needed as the socket will
+ automatically switch from <c>http</c>/<c>http_bin</c> to
+ <c>httph</c>/<c>httph_bin</c> internally after the first line
+ has been read. There might be occasions however when they are
+ useful, such as parsing trailers from chunked encoding.</p>
</item>
</taglist>
</item>