<?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.hs</title> <link type='text/css' rel='stylesheet' href='hscolour.css' /> </head> <body> <pre><a name="line-1"></a><span class='hs-comment'>-- | A cross-platform wrapper for sendfile -- this implements an available operating-system call if supported, otherwise it falls back to a portable haskell implementation.</span> <a name="line-2"></a><span class='hs-comment'>--</span> <a name="line-3"></a><span class='hs-comment'>-- Two interfaces are provided for both the unsafe and safe sets of functions. The first interface accepts an output socket\/handle and the path of the file you want to send; sendFile and unsafeSendFile comprise this interface. The second interface accepts an output socket\/handle, a handle to the file you want to send, an offset, and the number of bytes you want to send; sendFile' and unsafeSendFile' comprise this interface.</span> <a name="line-4"></a><span class='hs-comment'>--</span> <a name="line-5"></a><span class='hs-comment'>-- For consistent read/write behavior with either sendFile' or unsafeSendFile', the input handle should be opened in Binary mode rather than Text mode.</span> <a name="line-6"></a><span class='hs-comment'>--</span> <a name="line-7"></a> <a name="line-8"></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-layout'>(</span> <a name="line-9"></a> <span class='hs-conid'>ByteCount</span><span class='hs-layout'>,</span> <a name="line-10"></a> <span class='hs-conid'>Offset</span><span class='hs-layout'>,</span> <a name="line-11"></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-12"></a> <span class='hs-comment'>-- * Safe functions (recommended)</span> <a name="line-13"></a> <span class='hs-varid'>sendFile</span><span class='hs-layout'>,</span> <a name="line-14"></a> <span class='hs-varid'>sendFileIterWith</span><span class='hs-layout'>,</span> <a name="line-15"></a> <span class='hs-varid'>sendFile'</span><span class='hs-layout'>,</span> <a name="line-16"></a> <span class='hs-varid'>sendFileIterWith'</span><span class='hs-layout'>,</span> <a name="line-17"></a> <span class='hs-comment'>-- * Unsafe functions</span> <a name="line-18"></a> <span class='hs-comment'>-- | These functions are unsafe simply because there is no guarantee that the 'Handle' used for output is actually bound to a 'Socket'. If it is not, it will result in a runtime error.</span> <a name="line-19"></a> <span class='hs-varid'>unsafeSendFile</span><span class='hs-layout'>,</span> <a name="line-20"></a> <span class='hs-varid'>unsafeSendFileIterWith</span><span class='hs-layout'>,</span> <a name="line-21"></a> <span class='hs-varid'>unsafeSendFile'</span><span class='hs-layout'>,</span> <a name="line-22"></a> <span class='hs-varid'>unsafeSendFileIterWith'</span><span class='hs-layout'>,</span> <a name="line-23"></a> <span class='hs-comment'>-- * Utility functions</span> <a name="line-24"></a> <span class='hs-varid'>sendFileMode</span> <a name="line-25"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span> <a name="line-26"></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-layout'>(</span><span class='hs-varid'>sendFile</span><span class='hs-layout'>,</span> <span class='hs-varid'>sendFileIterWith</span><span class='hs-layout'>,</span> <span class='hs-varid'>sendFile'</span><span class='hs-layout'>,</span> <span class='hs-varid'>sendFileIterWith'</span><span class='hs-layout'>,</span> <a name="line-27"></a> <span class='hs-varid'>unsafeSendFile</span><span class='hs-layout'>,</span> <span class='hs-varid'>unsafeSendFileIterWith</span><span class='hs-layout'>,</span> <span class='hs-varid'>unsafeSendFile'</span><span class='hs-layout'>,</span> <span class='hs-varid'>unsafeSendFileIterWith'</span><span class='hs-layout'>,</span> <a name="line-28"></a> <span class='hs-varid'>sendFileMode</span><span class='hs-layout'>)</span> <a name="line-29"></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-30"></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-31"></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> <a name="line-32"></a> <a name="line-33"></a><a name="Offset"></a><span class='hs-comment'>-- | The file offset (in bytes) to start from</span> <a name="line-34"></a><a name="Offset"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>Offset</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Integer</span> <a name="line-35"></a> <a name="line-36"></a><a name="ByteCount"></a><span class='hs-comment'>-- | The length (in bytes) which should be sent</span> <a name="line-37"></a><a name="ByteCount"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>ByteCount</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Integer</span> <a name="line-38"></a> <a name="line-39"></a><a name="sendFile"></a><span class='hs-comment'>-- | The simplest interface. Simply give it an output `Socket` and the `FilePath` to the input file.</span> <a name="line-40"></a><span class='hs-definition'>sendFile</span> <a name="line-41"></a> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Socket</span> <span class='hs-comment'>-- ^ The output socket</span> <a name="line-42"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>FilePath</span> <span class='hs-comment'>-- ^ The path where the input file resides</span> <a name="line-43"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span> <a name="line-44"></a><span class='hs-definition'>sendFile</span> <span class='hs-keyglyph'>=</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-varop'>.</span><span class='hs-varid'>sendFile</span> <a name="line-45"></a> <a name="line-46"></a><a name="sendFileIterWith"></a><span class='hs-comment'>-- | The simplest interface. Simply give it an output `Socket` and the `FilePath` to the input file.</span> <a name="line-47"></a><span class='hs-comment'>--</span> <a name="line-48"></a><span class='hs-comment'>-- This variant takes a function to drive the iteration loop. See 'Iter' for more information.</span> <a name="line-49"></a><span class='hs-definition'>sendFileIterWith</span> <a name="line-50"></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-51"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Socket</span> <span class='hs-comment'>-- ^ The output socket</span> <a name="line-52"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>FilePath</span> <span class='hs-comment'>-- ^ The path where the input file resides</span> <a name="line-53"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ByteCount</span> <span class='hs-comment'>-- ^ Maximum bytes to send per block (may send less)</span> <a name="line-54"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>a</span> <a name="line-55"></a><span class='hs-definition'>sendFileIterWith</span> <span class='hs-keyglyph'>=</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-varop'>.</span><span class='hs-varid'>sendFileIterWith</span> <a name="line-56"></a> <a name="line-57"></a><a name="sendFile'"></a><span class='hs-comment'>-- | A more powerful interface than sendFile which accepts a starting offset, and the bytecount to send; the offset and the count must be a positive integer. The initial position of the input file handle matters not since the offset is absolute, and the final position may be different depending on the platform -- no assumptions can be made.</span> <a name="line-58"></a><span class='hs-definition'>sendFile'</span> <a name="line-59"></a> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Socket</span> <span class='hs-comment'>-- ^ The output socket</span> <a name="line-60"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>FilePath</span> <span class='hs-comment'>-- ^ The input file path</span> <a name="line-61"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Offset</span> <span class='hs-comment'>-- ^ The offset to start at</span> <a name="line-62"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ByteCount</span> <span class='hs-comment'>-- ^ The number of bytes to send</span> <a name="line-63"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span> <a name="line-64"></a><span class='hs-definition'>sendFile'</span> <span class='hs-keyglyph'>=</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-varop'>.</span><span class='hs-varid'>sendFile'</span> <a name="line-65"></a> <a name="line-66"></a><a name="sendFileIterWith'"></a><span class='hs-comment'>-- | A more powerful interface than sendFile which accepts a starting offset, and the bytecount to send; the offset and the count must be a positive integer. The initial position of the input file handle matters not since the offset is absolute, and the final position may be different depending on the platform -- no assumptions can be made.</span> <a name="line-67"></a><span class='hs-comment'>--</span> <a name="line-68"></a><span class='hs-comment'>-- This variant takes a function to drive the iteration loop. See 'Iter' for more information.</span> <a name="line-69"></a><span class='hs-definition'>sendFileIterWith'</span> <a name="line-70"></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-71"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Socket</span> <span class='hs-comment'>-- ^ The output socket</span> <a name="line-72"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>FilePath</span> <span class='hs-comment'>-- ^ The input file path</span> <a name="line-73"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ByteCount</span> <span class='hs-comment'>-- ^ Maximum bytes to send per block (may send less)</span> <a name="line-74"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Offset</span> <span class='hs-comment'>-- ^ The offset to start at</span> <a name="line-75"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ByteCount</span> <span class='hs-comment'>-- ^ The number of bytes to send</span> <a name="line-76"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>a</span> <a name="line-77"></a><span class='hs-definition'>sendFileIterWith'</span> <span class='hs-keyglyph'>=</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-varop'>.</span><span class='hs-varid'>sendFileIterWith'</span> <a name="line-78"></a> <a name="line-79"></a><a name="unsafeSendFile"></a><span class='hs-comment'>-- | The unsafe version of sendFile which accepts a `Handle` instead of a `Socket` for the output. It will flush the output handle before sending any file data.</span> <a name="line-80"></a><span class='hs-definition'>unsafeSendFile</span> <a name="line-81"></a> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Handle</span> <span class='hs-comment'>-- ^ The output handle</span> <a name="line-82"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>FilePath</span> <span class='hs-comment'>-- ^ The path where the input file resides</span> <a name="line-83"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span> <a name="line-84"></a><span class='hs-definition'>unsafeSendFile</span> <span class='hs-keyglyph'>=</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-varop'>.</span><span class='hs-varid'>unsafeSendFile</span> <a name="line-85"></a> <a name="line-86"></a><a name="unsafeSendFileIterWith"></a><span class='hs-comment'>-- | The unsafe version of sendFile which accepts a `Handle` instead of a `Socket` for the output. It will flush the output handle before sending any file data.</span> <a name="line-87"></a><span class='hs-comment'>--</span> <a name="line-88"></a><span class='hs-comment'>-- This variant takes a function to drive the iteration loop. See 'Iter' for more information.</span> <a name="line-89"></a><span class='hs-definition'>unsafeSendFileIterWith</span> <a name="line-90"></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-91"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Handle</span> <span class='hs-comment'>-- ^ The output handle</span> <a name="line-92"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>FilePath</span> <span class='hs-comment'>-- ^ The path where the input file resides</span> <a name="line-93"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ByteCount</span> <span class='hs-comment'>-- ^ Maximum bytes to send per block (may send less)</span> <a name="line-94"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>a</span> <a name="line-95"></a><span class='hs-definition'>unsafeSendFileIterWith</span> <span class='hs-keyglyph'>=</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-varop'>.</span><span class='hs-varid'>unsafeSendFileIterWith</span> <a name="line-96"></a> <a name="line-97"></a><a name="unsafeSendFile'"></a><span class='hs-comment'>-- | The unsafe version of sendFile' which accepts a `Handle` instead of a `Socket` for the output. It will flush the output handle before sending any file data.</span> <a name="line-98"></a><span class='hs-definition'>unsafeSendFile'</span> <a name="line-99"></a> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Handle</span> <span class='hs-comment'>-- ^ The output handle</span> <a name="line-100"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>FilePath</span> <span class='hs-comment'>-- ^ The input filepath</span> <a name="line-101"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Offset</span> <span class='hs-comment'>-- ^ The offset to start at</span> <a name="line-102"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ByteCount</span> <span class='hs-comment'>-- ^ The number of bytes to send</span> <a name="line-103"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span> <a name="line-104"></a><span class='hs-definition'>unsafeSendFile'</span> <span class='hs-keyglyph'>=</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-varop'>.</span><span class='hs-varid'>unsafeSendFile'</span> <a name="line-105"></a> <a name="line-106"></a><a name="unsafeSendFileIterWith'"></a><span class='hs-comment'>-- | The unsafe version of sendFile' which accepts a `Handle` instead of a `Socket` for the output. It will flush the output handle before sending any file data.</span> <a name="line-107"></a><span class='hs-comment'>--</span> <a name="line-108"></a><span class='hs-comment'>-- This variant takes a function to drive the iteration loop. See 'Iter' for more information.</span> <a name="line-109"></a><span class='hs-definition'>unsafeSendFileIterWith'</span> <a name="line-110"></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-111"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Handle</span> <span class='hs-comment'>-- ^ The output handle</span> <a name="line-112"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>FilePath</span> <span class='hs-comment'>-- ^ The input filepath</span> <a name="line-113"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ByteCount</span> <span class='hs-comment'>-- ^ The number of bytes to send</span> <a name="line-114"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Offset</span> <span class='hs-comment'>-- ^ The offset to start at</span> <a name="line-115"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ByteCount</span> <span class='hs-comment'>-- ^ The number of bytes to send</span> <a name="line-116"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>a</span> <a name="line-117"></a><span class='hs-definition'>unsafeSendFileIterWith'</span> <span class='hs-keyglyph'>=</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-varop'>.</span><span class='hs-varid'>unsafeSendFileIterWith'</span> <a name="line-118"></a> <a name="line-119"></a><a name="sendFileMode"></a><span class='hs-comment'>-- | Returns the mode that sendfile was compiled with. Mainly for debugging use.</span> <a name="line-120"></a><span class='hs-comment'>-- Possible values are 'WIN32_SENDFILE', 'LINUX_SENDFILE', 'FREEBSD_SENDFILE',</span> <a name="line-121"></a><span class='hs-comment'>-- 'DARWIN_SENDFILE', and 'PORTABLE_SENDFILE'.</span> <a name="line-122"></a><span class='hs-definition'>sendFileMode</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-comment'>-- ^ The mode that sendfile was compiled with</span> <a name="line-123"></a><span class='hs-definition'>sendFileMode</span> <span class='hs-keyglyph'>=</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-varop'>.</span><span class='hs-varid'>sendFileMode</span> <a name="line-124"></a> </pre></body> </html>
