/usr/share/doc/libghc-simple-sendfile-doc/html/Network-Sendfile.html is in libghc-simple-sendfile-doc 0.2.25-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 | <!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.Sendfile</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-Sendfile.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Network-Sendfile.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">simple-sendfile-0.2.25: Cross platform library for the sendfile system call</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>None</td></tr><tr><th>Language</th><td>Haskell2010</td></tr></table><p class="caption">Network.Sendfile</p></div><div id="description"><p class="caption">Description</p><div class="doc"><p>Cross platform library for the sendfile system call.
This library tries to call minimum system calls which
are the bottleneck of web servers.</p></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:sendfile">sendfile</a> :: <a href="file:///usr/share/doc/libghc-network-doc/html/Network-Socket.html#t:Socket">Socket</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="Network-Sendfile.html#t:FileRange">FileRange</a> -> <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/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:sendfileWithHeader">sendfileWithHeader</a> :: <a href="file:///usr/share/doc/libghc-network-doc/html/Network-Socket.html#t:Socket">Socket</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="Network-Sendfile.html#t:FileRange">FileRange</a> -> <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.html#t:ByteString">ByteString</a>] -> <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:sendfileFd">sendfileFd</a> :: <a href="file:///usr/share/doc/libghc-network-doc/html/Network-Socket.html#t:Socket">Socket</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-Posix-Types.html#t:Fd">Fd</a> -> <a href="Network-Sendfile.html#t:FileRange">FileRange</a> -> <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/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:sendfileFdWithHeader">sendfileFdWithHeader</a> :: <a href="file:///usr/share/doc/libghc-network-doc/html/Network-Socket.html#t:Socket">Socket</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-Posix-Types.html#t:Fd">Fd</a> -> <a href="Network-Sendfile.html#t:FileRange">FileRange</a> -> <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.html#t:ByteString">ByteString</a>] -> <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"><span class="keyword">data</span> <a href="#t:FileRange">FileRange</a><ul class="subs"><li>= <a href="#v:EntireFile">EntireFile</a></li><li>| <a href="#v:PartOfFile">PartOfFile</a> { <ul class="subs"><li><a href="#v:rangeOffset">rangeOffset</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Prelude.html#t:Integer">Integer</a></li><li><a href="#v:rangeLength">rangeLength</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Prelude.html#t:Integer">Integer</a></li></ul> }</li></ul></li></ul></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><a id="v:sendfile" class="def">sendfile</a> :: <a href="file:///usr/share/doc/libghc-network-doc/html/Network-Socket.html#t:Socket">Socket</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="Network-Sendfile.html#t:FileRange">FileRange</a> -> <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/System-IO.html#t:IO">IO</a> () <a href="src/Network-Sendfile-Linux.html#sendfile" class="link">Source</a> <a href="#v:sendfile" class="selflink">#</a></p><div class="doc"><p>Simple binding for sendfile() of Linux.
Used system calls:</p><ul><li>EntireFile -- open(), stat(), sendfile(), and close()</li><li>PartOfFile -- open(), sendfile(), and close()</li></ul><p>If the size of the file is unknown when sending the entire file,
specifying PartOfFile is much faster.</p><p>The fourth action argument is called when a file is sent as chunks.
Chucking is inevitable if the socket is non-blocking (this is the
default) and the file is large. The action is called after a chunk
is sent and bofore waiting the socket to be ready for writing.</p></div></div><div class="top"><p class="src"><a id="v:sendfileWithHeader" class="def">sendfileWithHeader</a> :: <a href="file:///usr/share/doc/libghc-network-doc/html/Network-Socket.html#t:Socket">Socket</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="Network-Sendfile.html#t:FileRange">FileRange</a> -> <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.html#t:ByteString">ByteString</a>] -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> () <a href="src/Network-Sendfile-Linux.html#sendfileWithHeader" class="link">Source</a> <a href="#v:sendfileWithHeader" class="selflink">#</a></p><div class="doc"><p>Simple binding for send() and sendfile() of Linux.
Used system calls:</p><ul><li>EntireFile -- send(), open(), stat(), sendfile(), and close()</li><li>PartOfFile -- send(), open(), sendfile(), and close()</li></ul><p>The fifth header is sent with send() + the MSG_MORE flag. If the
file is small enough, the header and the file is send in a single
TCP packet.</p><p>If the size of the file is unknown when sending the entire file,
specifying PartOfFile is much faster.</p><p>The fourth action argument is called when a file is sent as chunks.
Chucking is inevitable if the socket is non-blocking (this is the
default) and the file is large. The action is called after a chunk
is sent and bofore waiting the socket to be ready for writing.</p></div></div><div class="top"><p class="src"><a id="v:sendfileFd" class="def">sendfileFd</a> :: <a href="file:///usr/share/doc/libghc-network-doc/html/Network-Socket.html#t:Socket">Socket</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-Posix-Types.html#t:Fd">Fd</a> -> <a href="Network-Sendfile.html#t:FileRange">FileRange</a> -> <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/System-IO.html#t:IO">IO</a> () <a href="src/Network-Sendfile-Linux.html#sendfileFd" class="link">Source</a> <a href="#v:sendfileFd" class="selflink">#</a></p><div class="doc"><p>Simple binding for sendfile() of Linux.
Used system calls:</p><ul><li>EntireFile -- stat() and sendfile()</li><li>PartOfFile -- sendfile()</li></ul><p>If the size of the file is unknown when sending the entire file,
specifying PartOfFile is much faster.</p><p>The fourth action argument is called when a file is sent as chunks.
Chucking is inevitable if the socket is non-blocking (this is the
default) and the file is large. The action is called after a chunk
is sent and bofore waiting the socket to be ready for writing.</p></div></div><div class="top"><p class="src"><a id="v:sendfileFdWithHeader" class="def">sendfileFdWithHeader</a> :: <a href="file:///usr/share/doc/libghc-network-doc/html/Network-Socket.html#t:Socket">Socket</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-Posix-Types.html#t:Fd">Fd</a> -> <a href="Network-Sendfile.html#t:FileRange">FileRange</a> -> <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.html#t:ByteString">ByteString</a>] -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/System-IO.html#t:IO">IO</a> () <a href="src/Network-Sendfile-Linux.html#sendfileFdWithHeader" class="link">Source</a> <a href="#v:sendfileFdWithHeader" class="selflink">#</a></p><div class="doc"><p>Simple binding for send() and sendfile() of Linux.
Used system calls:</p><ul><li>EntireFile -- send(), stat() and sendfile()</li><li>PartOfFile -- send() and sendfile()</li></ul><p>The fifth header is sent with send() + the MSG_MORE flag. If the
file is small enough, the header and the file is send in a single
TCP packet.</p><p>If the size of the file is unknown when sending the entire file,
specifying PartOfFile is much faster.</p><p>The fourth action argument is called when a file is sent as chunks.
Chucking is inevitable if the socket is non-blocking (this is the
default) and the file is large. The action is called after a chunk
is sent and bofore waiting the socket to be ready for writing.</p></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a id="t:FileRange" class="def">FileRange</a> <a href="src/Network-Sendfile-Types.html#FileRange" class="link">Source</a> <a href="#t:FileRange" class="selflink">#</a></p><div class="doc"><p>File range for <code>sendfile</code>.</p></div><div class="subs constructors"><p class="caption">Constructors</p><table><tr><td class="src"><a id="v:EntireFile" class="def">EntireFile</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a id="v:PartOfFile" class="def">PartOfFile</a></td><td class="doc empty"> </td></tr><tr><td colspan="2"><div class="subs fields"><p class="caption">Fields</p><ul><li><dfn class="src"><a id="v:rangeOffset" class="def">rangeOffset</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Prelude.html#t:Integer">Integer</a></dfn><div class="doc empty"> </div></li><li><dfn class="src"><a id="v:rangeLength" class="def">rangeLength</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.9.0.0/Prelude.html#t:Integer">Integer</a></dfn><div class="doc empty"> </div></li></ul></div></td></tr></table></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>
|