-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Cross platform library for the sendfile system call
--   
--   Cross platform library for the sendfile system call. This library
--   tries to call minimum system calls which are the bottleneck of web
--   servers.
@package simple-sendfile
@version 0.2.25


-- | Cross platform library for the sendfile system call. This library
--   tries to call minimum system calls which are the bottleneck of web
--   servers.
module Network.Sendfile

-- | Simple binding for sendfile() of BSD and MacOS.
--   
--   <ul>
--   <li>Used system calls: open(), sendfile(), and close().</li>
--   </ul>
--   
--   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.
sendfile :: Socket -> FilePath -> FileRange -> IO () -> IO ()

-- | Simple binding for sendfile() of BSD and MacOS.
--   
--   <ul>
--   <li>Used system calls: open(), sendfile(), and close().</li>
--   </ul>
--   
--   The fifth header is also sent with sendfile(). If the file is small
--   enough, the header and the file is send in a single TCP packet on
--   FreeBSD. MacOS sends the header and the file separately but it is
--   fast.
--   
--   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.
sendfileWithHeader :: Socket -> FilePath -> FileRange -> IO () -> [ByteString] -> IO ()

-- | Simple binding for sendfile() of BSD and MacOS.
--   
--   <ul>
--   <li>Used system calls: sendfile()</li>
--   </ul>
--   
--   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.
sendfileFd :: Socket -> Fd -> FileRange -> IO () -> IO ()

-- | Simple binding for sendfile() of BSD and MacOS.
--   
--   <ul>
--   <li>Used system calls: sendfile()</li>
--   </ul>
--   
--   The fifth header is also sent with sendfile(). If the file is small
--   enough, the header and the file is send in a single TCP packet on
--   FreeBSD. MacOS sends the header and the file separately but it is
--   fast.
--   
--   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.
sendfileFdWithHeader :: Socket -> Fd -> FileRange -> IO () -> [ByteString] -> IO ()

-- | File range for <tt>sendfile</tt>.
data FileRange
EntireFile :: FileRange
PartOfFile :: Integer -> Integer -> FileRange
[rangeOffset] :: FileRange -> Integer
[rangeLength] :: FileRange -> Integer