/usr/share/doc/libghc-network-doc/html/Network-Socket-ByteString-Lazy.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Network.Socket.ByteString.Lazy</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script src="file:///usr/share/javascript/mathjax/MathJax.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Network-Socket-ByteString-Lazy.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Network-Socket-ByteString-Lazy.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">network-2.6.3.1: Low-level networking interface</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Copyright</th><td>(c) Bryan O'Sullivan 2009</td></tr><tr><th>License</th><td>BSD-style</td></tr><tr><th>Maintainer</th><td>bos@serpentine.com</td></tr><tr><th>Stability</th><td>experimental</td></tr><tr><th>Portability</th><td>POSIX, GHC</td></tr><tr><th>Safe Haskell</th><td>None</td></tr><tr><th>Language</th><td>Haskell98</td></tr></table><p class="caption">Network.Socket.ByteString.Lazy</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Send data to a socket</a></li><li><a href="#g:2">Receive data from a socket</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>This module provides access to the BSD <em>socket</em> interface.  This
 module is generally more efficient than the <code><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-String.html#t:String">String</a></code> based network
 functions in <code><a href="Network.html#v:Socket">Socket</a></code>.  For detailed documentation, consult
 your favorite POSIX socket reference. All functions communicate
 failures by converting the error number to <code><a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#v:IOError">IOError</a></code>.</p><p>This module is made to be imported with <code><a href="Network.html#v:Socket">Socket</a></code> like so:</p><pre>import Network.Socket hiding (send, sendTo, recv, recvFrom)
import Network.Socket.ByteString.Lazy
import Prelude hiding (getContents)</pre></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><a href="#v:send">send</a> :: <a href="Network-Socket.html#t:Socket">Socket</a> -&gt; <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString-Lazy.html#t:ByteString">ByteString</a> -&gt; <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int64">Int64</a></li><li class="src short"><a href="#v:sendAll">sendAll</a> :: <a href="Network-Socket.html#t:Socket">Socket</a> -&gt; <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString-Lazy.html#t:ByteString">ByteString</a> -&gt; <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:getContents">getContents</a> :: <a href="Network-Socket.html#t:Socket">Socket</a> -&gt; <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString-Lazy.html#t:ByteString">ByteString</a></li><li class="src short"><a href="#v:recv">recv</a> :: <a href="Network-Socket.html#t:Socket">Socket</a> -&gt; <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int64">Int64</a> -&gt; <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString-Lazy.html#t:ByteString">ByteString</a></li></ul></div><div id="interface"><h1 id="g:1">Send data to a socket</h1><div class="top"><p class="src"><a id="v:send" class="def">send</a> <a href="src/Network-Socket-ByteString-Lazy-Posix.html#send" class="link">Source</a> <a href="#v:send" class="selflink">#</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Network-Socket.html#t:Socket">Socket</a></td><td class="doc"><p>Connected socket</p></td></tr><tr><td class="src">-&gt; <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString-Lazy.html#t:ByteString">ByteString</a></td><td class="doc"><p>Data to send</p></td></tr><tr><td class="src">-&gt; <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int64">Int64</a></td><td class="doc"><p>Number of bytes sent</p></td></tr></table></div></div><div class="top"><p class="src"><a id="v:sendAll" class="def">sendAll</a> <a href="src/Network-Socket-ByteString-Lazy-Posix.html#sendAll" class="link">Source</a> <a href="#v:sendAll" class="selflink">#</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Network-Socket.html#t:Socket">Socket</a></td><td class="doc"><p>Connected socket</p></td></tr><tr><td class="src">-&gt; <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString-Lazy.html#t:ByteString">ByteString</a></td><td class="doc"><p>Data to send</p></td></tr><tr><td class="src">-&gt; <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> ()</td><td class="doc empty">&nbsp;</td></tr></table></div></div><h1 id="g:2">Receive data from a socket</h1><div class="top"><p class="src"><a id="v:getContents" class="def">getContents</a> <a href="src/Network-Socket-ByteString-Lazy.html#getContents" class="link">Source</a> <a href="#v:getContents" class="selflink">#</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Network-Socket.html#t:Socket">Socket</a></td><td class="doc"><p>Connected socket</p></td></tr><tr><td class="src">-&gt; <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString-Lazy.html#t:ByteString">ByteString</a></td><td class="doc"><p>Data received</p></td></tr></table></div><div class="doc"><p>Receive data from the socket.  The socket must be in a connected
 state.  Data is received on demand, in chunks; each chunk will be
 sized to reflect the amount of data received by individual <code><a href="Network-Socket-ByteString-Lazy.html#v:recv">recv</a></code>
 calls.</p><p>All remaining data from the socket is consumed.  When there is no
 more data to be received, the receiving side of the socket is shut
 down.  If there is an error and an exception is thrown, the socket
 is not shut down.</p></div></div><div class="top"><p class="src"><a id="v:recv" class="def">recv</a> <a href="src/Network-Socket-ByteString-Lazy.html#recv" class="link">Source</a> <a href="#v:recv" class="selflink">#</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Network-Socket.html#t:Socket">Socket</a></td><td class="doc"><p>Connected socket</p></td></tr><tr><td class="src">-&gt; <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Data-Int.html#t:Int64">Int64</a></td><td class="doc"><p>Maximum number of bytes to receive</p></td></tr><tr><td class="src">-&gt; <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> <a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString-Lazy.html#t:ByteString">ByteString</a></td><td class="doc"><p>Data received</p></td></tr></table></div><div class="doc"><p>Receive data from the socket.  The socket must be in a connected
 state.  This function may return fewer bytes than specified.  If
 the received data is longer than the specified length, it may be
 discarded depending on the type of socket.  This function may block
 until a message arrives.</p><p>If there is no more data to be received, returns an empty <code><a href="file:///usr/share/doc/ghc-doc/html/libraries/bytestring-0.10.8.1/Data-ByteString-Lazy.html#t:ByteString">ByteString</a></code>.</p><p>Receiving data from closed socket may lead to undefined behaviour.</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.17.2</p></div></body></html>
libghc-network-doc 2.6.3.1-3 / usr / share / doc / libghc-network-doc / html / Network-Socket-ByteString-Lazy.html
