<?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>src/Network/Socket/SendFile/Handle.hs</title> <link type='text/css' rel='stylesheet' href='hscolour.css' /> </head> <body> <pre><a name="line-1"></a><span class='hs-comment'>-- | Handle-based versions of some of the functions exported by</span> <a name="line-2"></a><span class='hs-comment'>-- Network.Socket.SendFile. </span> <a name="line-3"></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'>SendFile</span><span class='hs-varop'>.</span><span class='hs-conid'>Handle</span> <span class='hs-layout'>(</span> <a name="line-4"></a> <span class='hs-conid'>ByteCount</span><span class='hs-layout'>,</span> <a name="line-5"></a> <span class='hs-conid'>Offset</span><span class='hs-layout'>,</span> <a name="line-6"></a> <span class='hs-conid'>Iter</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'>runIter</span><span class='hs-layout'>,</span> <a name="line-7"></a> <span class='hs-comment'>-- * Handle-based sendFiles</span> <a name="line-8"></a> <span class='hs-varid'>sendFile</span><span class='hs-layout'>,</span> <a name="line-9"></a> <span class='hs-varid'>sendFileIterWith</span><span class='hs-layout'>,</span> <a name="line-10"></a> <span class='hs-varid'>sendFile'</span><span class='hs-layout'>,</span> <a name="line-11"></a> <span class='hs-varid'>sendFileIterWith'</span> <a name="line-12"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span> <a name="line-13"></a> <a name="line-14"></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-layout'>(</span><span class='hs-conid'>Handle</span><span class='hs-layout'>,</span> <span class='hs-varid'>hFileSize</span><span class='hs-layout'>)</span> <a name="line-15"></a> <a name="line-16"></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'>SendFile</span><span class='hs-varop'>.</span><span class='hs-conid'>Internal</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>Internal</span> <a name="line-17"></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'>SendFile</span><span class='hs-varop'>.</span><span class='hs-conid'>Iter</span> <span class='hs-layout'>(</span><span class='hs-conid'>Iter</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'>runIter</span><span class='hs-layout'>)</span> <a name="line-18"></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'>SendFile</span> <span class='hs-layout'>(</span><span class='hs-conid'>ByteCount</span><span class='hs-layout'>,</span> <span class='hs-conid'>Offset</span><span class='hs-layout'>)</span> <a name="line-19"></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> <a name="line-20"></a> <a name="line-21"></a><a name="sendFile"></a><span class='hs-comment'>-- | Simple sendFile - give it a Socket and a Handle, and it sends the entire</span> <a name="line-22"></a><span class='hs-comment'>-- file through the socket.</span> <a name="line-23"></a><span class='hs-comment'>--</span> <a name="line-24"></a><span class='hs-comment'>-- WARNING: This function will raise 'IOError' 'IllegalOperation'</span> <a name="line-25"></a><span class='hs-comment'>-- if the 'Handle' is not for an 'Fd'.</span> <a name="line-26"></a><span class='hs-definition'>sendFile</span> <a name="line-27"></a> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Socket</span> <a name="line-28"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Handle</span> <a name="line-29"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span> <a name="line-30"></a><span class='hs-definition'>sendFile</span> <span class='hs-varid'>outs</span> <span class='hs-varid'>inh</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span> <a name="line-31"></a> <span class='hs-varid'>count</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>hFileSize</span> <span class='hs-varid'>inh</span> <a name="line-32"></a> <span class='hs-conid'>Internal</span><span class='hs-varop'>.</span><span class='hs-varid'>sendFile''</span> <span class='hs-varid'>outs</span> <span class='hs-varid'>inh</span> <span class='hs-num'>0</span> <span class='hs-varid'>count</span> <a name="line-33"></a> <a name="line-34"></a><a name="sendFileIterWith"></a><span class='hs-comment'>-- | A more interactive version of sendFile, which accepts a callback function</span> <a name="line-35"></a><span class='hs-comment'>-- in addition to the socket and handle. The callback will be called for each</span> <a name="line-36"></a><span class='hs-comment'>-- chunk of data the sendFileIterWith function acts on.</span> <a name="line-37"></a><span class='hs-comment'>--</span> <a name="line-38"></a><span class='hs-comment'>-- WARNING: This function will raise 'IOError' 'IllegalOperation'</span> <a name="line-39"></a><span class='hs-comment'>-- if the 'Handle' is not for an 'Fd'.</span> <a name="line-40"></a><span class='hs-definition'>sendFileIterWith</span> <a name="line-41"></a> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>IO</span> <span class='hs-conid'>Iter</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <a name="line-42"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Socket</span> <a name="line-43"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Handle</span> <a name="line-44"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ByteCount</span> <a name="line-45"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>a</span> <a name="line-46"></a><span class='hs-definition'>sendFileIterWith</span> <span class='hs-varid'>stepper</span> <span class='hs-varid'>outs</span> <span class='hs-varid'>inh</span> <span class='hs-varid'>blockSize</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span> <a name="line-47"></a> <span class='hs-varid'>count</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>hFileSize</span> <span class='hs-varid'>inh</span> <a name="line-48"></a> <span class='hs-conid'>Internal</span><span class='hs-varop'>.</span><span class='hs-varid'>sendFileIterWith''</span> <span class='hs-varid'>stepper</span> <span class='hs-varid'>outs</span> <span class='hs-varid'>inh</span> <span class='hs-varid'>blockSize</span> <span class='hs-num'>0</span> <span class='hs-varid'>count</span> <a name="line-49"></a> <a name="line-50"></a><a name="sendFile'"></a><span class='hs-comment'>-- | A sendFile that allows the user to send a subset of the file associated</span> <a name="line-51"></a><span class='hs-comment'>-- with the given handle.</span> <a name="line-52"></a><span class='hs-comment'>--</span> <a name="line-53"></a><span class='hs-comment'>-- WARNING: This function will raise 'IOError' 'IllegalOperation'</span> <a name="line-54"></a><span class='hs-comment'>-- if the 'Handle' is not for an 'Fd'.</span> <a name="line-55"></a><span class='hs-definition'>sendFile'</span> <a name="line-56"></a> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Socket</span> <a name="line-57"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Handle</span> <a name="line-58"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Offset</span> <a name="line-59"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ByteCount</span> <a name="line-60"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span> <a name="line-61"></a><span class='hs-definition'>sendFile'</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Internal</span><span class='hs-varop'>.</span><span class='hs-varid'>sendFile''</span> <a name="line-62"></a> <a name="line-63"></a><a name="sendFileIterWith'"></a><span class='hs-comment'>-- | A more powerful version of sendFileIterWith, which allows the sending of a</span> <a name="line-64"></a><span class='hs-comment'>-- subset of the given file.</span> <a name="line-65"></a><span class='hs-comment'>--</span> <a name="line-66"></a><span class='hs-comment'>-- WARNING: This function will raise 'IOError' 'IllegalOperation'</span> <a name="line-67"></a><span class='hs-comment'>-- if the 'Handle' is not for an 'Fd'.</span> <a name="line-68"></a><span class='hs-definition'>sendFileIterWith'</span> <a name="line-69"></a> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>IO</span> <span class='hs-conid'>Iter</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <a name="line-70"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Socket</span> <a name="line-71"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Handle</span> <a name="line-72"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ByteCount</span> <a name="line-73"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Offset</span> <a name="line-74"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ByteCount</span> <a name="line-75"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>a</span> <a name="line-76"></a><span class='hs-definition'>sendFileIterWith'</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Internal</span><span class='hs-varop'>.</span><span class='hs-varid'>sendFileIterWith''</span> </pre></body> </html>
