/usr/share/doc/libghc-network-doc/html/src/Network-Socket-ByteString-Lazy.html is in libghc-network-doc 2.6.3.1-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<!-- Generated by HsColour, http://code.haskell.org/~malcolm/hscolour/ -->
<title>Network/Socket/ByteString/Lazy.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-# LANGUAGE CPP #-}</span>
<a name="line-2"></a>
<a name="line-3"></a><span class='hs-comment'>-- |</span>
<a name="line-4"></a><span class='hs-comment'>-- Module : Network.Socket.ByteString.Lazy</span>
<a name="line-5"></a><span class='hs-comment'>-- Copyright : (c) Bryan O'Sullivan 2009</span>
<a name="line-6"></a><span class='hs-comment'>-- License : BSD-style</span>
<a name="line-7"></a><span class='hs-comment'>--</span>
<a name="line-8"></a><span class='hs-comment'>-- Maintainer : bos@serpentine.com</span>
<a name="line-9"></a><span class='hs-comment'>-- Stability : experimental</span>
<a name="line-10"></a><span class='hs-comment'>-- Portability : POSIX, GHC</span>
<a name="line-11"></a><span class='hs-comment'>--</span>
<a name="line-12"></a><span class='hs-comment'>-- This module provides access to the BSD /socket/ interface. This</span>
<a name="line-13"></a><span class='hs-comment'>-- module is generally more efficient than the 'String' based network</span>
<a name="line-14"></a><span class='hs-comment'>-- functions in 'Network.Socket'. For detailed documentation, consult</span>
<a name="line-15"></a><span class='hs-comment'>-- your favorite POSIX socket reference. All functions communicate</span>
<a name="line-16"></a><span class='hs-comment'>-- failures by converting the error number to 'System.IO.IOError'.</span>
<a name="line-17"></a><span class='hs-comment'>--</span>
<a name="line-18"></a><span class='hs-comment'>-- This module is made to be imported with 'Network.Socket' like so:</span>
<a name="line-19"></a><span class='hs-comment'>--</span>
<a name="line-20"></a><span class='hs-comment'>-- > import Network.Socket hiding (send, sendTo, recv, recvFrom)</span>
<a name="line-21"></a><span class='hs-comment'>-- > import Network.Socket.ByteString.Lazy</span>
<a name="line-22"></a><span class='hs-comment'>-- > import Prelude hiding (getContents)</span>
<a name="line-23"></a><span class='hs-comment'>--</span>
<a name="line-24"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Network</span><span class='hs-varop'>.</span><span class='hs-conid'>Socket</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span><span class='hs-varop'>.</span><span class='hs-conid'>Lazy</span>
<a name="line-25"></a> <span class='hs-layout'>(</span>
<a name="line-26"></a> <span class='hs-comment'>-- * Send data to a socket</span>
<a name="line-27"></a> <span class='hs-varid'>send</span>
<a name="line-28"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>sendAll</span>
<a name="line-29"></a> <span class='hs-layout'>,</span>
<a name="line-30"></a>
<a name="line-31"></a> <span class='hs-comment'>-- * Receive data from a socket</span>
<a name="line-32"></a> <span class='hs-varid'>getContents</span>
<a name="line-33"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>recv</span>
<a name="line-34"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-35"></a>
<a name="line-36"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Monad</span> <span class='hs-layout'>(</span><span class='hs-varid'>liftM</span><span class='hs-layout'>)</span>
<a name="line-37"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span><span class='hs-varop'>.</span><span class='hs-conid'>Lazy</span><span class='hs-varop'>.</span><span class='hs-conid'>Internal</span> <span class='hs-layout'>(</span><span class='hs-conid'>ByteString</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-varid'>defaultChunkSize</span><span class='hs-layout'>)</span>
<a name="line-38"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Int</span> <span class='hs-layout'>(</span><span class='hs-conid'>Int64</span><span class='hs-layout'>)</span>
<a name="line-39"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Network</span><span class='hs-varop'>.</span><span class='hs-conid'>Socket</span> <span class='hs-layout'>(</span><span class='hs-conid'>Socket</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-conid'>ShutdownCmd</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-varid'>shutdown</span><span class='hs-layout'>)</span>
<a name="line-40"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Prelude</span> <span class='hs-varid'>hiding</span> <span class='hs-layout'>(</span><span class='hs-varid'>getContents</span><span class='hs-layout'>)</span>
<a name="line-41"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>IO</span><span class='hs-varop'>.</span><span class='hs-conid'>Unsafe</span> <span class='hs-layout'>(</span><span class='hs-varid'>unsafeInterleaveIO</span><span class='hs-layout'>)</span>
<a name="line-42"></a>
<a name="line-43"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>S</span>
<a name="line-44"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>Network</span><span class='hs-varop'>.</span><span class='hs-conid'>Socket</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>N</span>
<a name="line-45"></a>
<a name="line-46"></a><span class='hs-cpp'>#if defined(mingw32_HOST_OS)</span>
<a name="line-47"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Network</span><span class='hs-varop'>.</span><span class='hs-conid'>Socket</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span><span class='hs-varop'>.</span><span class='hs-conid'>Lazy</span><span class='hs-varop'>.</span><span class='hs-conid'>Windows</span> <span class='hs-layout'>(</span><span class='hs-varid'>send</span><span class='hs-layout'>,</span> <span class='hs-varid'>sendAll</span><span class='hs-layout'>)</span>
<a name="line-48"></a><span class='hs-cpp'>#else</span>
<a name="line-49"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Network</span><span class='hs-varop'>.</span><span class='hs-conid'>Socket</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span><span class='hs-varop'>.</span><span class='hs-conid'>Lazy</span><span class='hs-varop'>.</span><span class='hs-conid'>Posix</span> <span class='hs-layout'>(</span><span class='hs-varid'>send</span><span class='hs-layout'>,</span> <span class='hs-varid'>sendAll</span><span class='hs-layout'>)</span>
<a name="line-50"></a><span class='hs-cpp'>#endif</span>
<a name="line-51"></a>
<a name="line-52"></a><span class='hs-comment'>-- -----------------------------------------------------------------------------</span>
<a name="line-53"></a><span class='hs-comment'>-- Receiving</span>
<a name="line-54"></a>
<a name="line-55"></a><a name="getContents"></a><span class='hs-comment'>-- | Receive data from the socket. The socket must be in a connected</span>
<a name="line-56"></a><span class='hs-comment'>-- state. Data is received on demand, in chunks; each chunk will be</span>
<a name="line-57"></a><span class='hs-comment'>-- sized to reflect the amount of data received by individual 'recv'</span>
<a name="line-58"></a><span class='hs-comment'>-- calls.</span>
<a name="line-59"></a><span class='hs-comment'>--</span>
<a name="line-60"></a><span class='hs-comment'>-- All remaining data from the socket is consumed. When there is no</span>
<a name="line-61"></a><span class='hs-comment'>-- more data to be received, the receiving side of the socket is shut</span>
<a name="line-62"></a><span class='hs-comment'>-- down. If there is an error and an exception is thrown, the socket</span>
<a name="line-63"></a><span class='hs-comment'>-- is not shut down.</span>
<a name="line-64"></a><span class='hs-definition'>getContents</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Socket</span> <span class='hs-comment'>-- ^ Connected socket</span>
<a name="line-65"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>ByteString</span> <span class='hs-comment'>-- ^ Data received</span>
<a name="line-66"></a><span class='hs-definition'>getContents</span> <span class='hs-varid'>sock</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>loop</span> <span class='hs-keyword'>where</span>
<a name="line-67"></a> <span class='hs-varid'>loop</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>unsafeInterleaveIO</span> <span class='hs-varop'>$</span> <span class='hs-keyword'>do</span>
<a name="line-68"></a> <span class='hs-varid'>s</span> <span class='hs-keyglyph'><-</span> <span class='hs-conid'>N</span><span class='hs-varop'>.</span><span class='hs-varid'>recv</span> <span class='hs-varid'>sock</span> <span class='hs-varid'>defaultChunkSize</span>
<a name="line-69"></a> <span class='hs-keyword'>if</span> <span class='hs-conid'>S</span><span class='hs-varop'>.</span><span class='hs-varid'>null</span> <span class='hs-varid'>s</span>
<a name="line-70"></a> <span class='hs-keyword'>then</span> <span class='hs-varid'>shutdown</span> <span class='hs-varid'>sock</span> <span class='hs-conid'>ShutdownReceive</span> <span class='hs-varop'>>></span> <span class='hs-varid'>return</span> <span class='hs-conid'>Empty</span>
<a name="line-71"></a> <span class='hs-keyword'>else</span> <span class='hs-conid'>Chunk</span> <span class='hs-varid'>s</span> <span class='hs-varop'>`liftM`</span> <span class='hs-varid'>loop</span>
<a name="line-72"></a>
<a name="line-73"></a><a name="recv"></a><span class='hs-comment'>-- | Receive data from the socket. The socket must be in a connected</span>
<a name="line-74"></a><span class='hs-comment'>-- state. This function may return fewer bytes than specified. If</span>
<a name="line-75"></a><span class='hs-comment'>-- the received data is longer than the specified length, it may be</span>
<a name="line-76"></a><span class='hs-comment'>-- discarded depending on the type of socket. This function may block</span>
<a name="line-77"></a><span class='hs-comment'>-- until a message arrives.</span>
<a name="line-78"></a><span class='hs-comment'>--</span>
<a name="line-79"></a><span class='hs-comment'>-- If there is no more data to be received, returns an empty 'ByteString'.</span>
<a name="line-80"></a><span class='hs-comment'>--</span>
<a name="line-81"></a><span class='hs-comment'>-- Receiving data from closed socket may lead to undefined behaviour.</span>
<a name="line-82"></a><span class='hs-definition'>recv</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Socket</span> <span class='hs-comment'>-- ^ Connected socket</span>
<a name="line-83"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Int64</span> <span class='hs-comment'>-- ^ Maximum number of bytes to receive</span>
<a name="line-84"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>ByteString</span> <span class='hs-comment'>-- ^ Data received</span>
<a name="line-85"></a><span class='hs-definition'>recv</span> <span class='hs-varid'>sock</span> <span class='hs-varid'>nbytes</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>chunk</span> <span class='hs-varop'>`liftM`</span> <span class='hs-conid'>N</span><span class='hs-varop'>.</span><span class='hs-varid'>recv</span> <span class='hs-varid'>sock</span> <span class='hs-layout'>(</span><span class='hs-varid'>fromIntegral</span> <span class='hs-varid'>nbytes</span><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-86"></a> <span class='hs-varid'>chunk</span> <span class='hs-varid'>k</span>
<a name="line-87"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>S</span><span class='hs-varop'>.</span><span class='hs-varid'>null</span> <span class='hs-varid'>k</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Empty</span>
<a name="line-88"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>otherwise</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Chunk</span> <span class='hs-varid'>k</span> <span class='hs-conid'>Empty</span>
</pre></body>
</html>
|