documentation.

Network/Sendfile/BSD.hsc

@@ -15,6 +15,10 @@ import Network.Socket
 import System.Posix.IO
 import System.Posix.Types (Fd(..), COff)
 
+{-|
+   Simple binding for sendfile() of MacOS.
+   Used system calls: open(), sendfile(), and close().
+-}
 sendfile :: Socket -> FilePath -> FileRange -> IO ()
 sendfile sock path range = bracket
     (openFd path ReadOnly Nothing defaultFileFlags)

Network/Sendfile/Fallback.hs

@@ -11,6 +11,10 @@ import Network.Sendfile.Types
 import Network.Socket
 import qualified Network.Socket.ByteString as SB
 
+{-|
+   Sendfile emulation using enumerator.
+   Used system calls: open(), stat(), read(), send() and close().
+-}
 sendfile :: Socket -> FilePath -> FileRange -> IO ()
 sendfile s fp EntireFile =
     run_ $ enumFile fp $$ sendIter s

Network/Sendfile/Linux.hsc

@@ -18,6 +18,14 @@ import System.Posix.Files
 import System.Posix.IO
 import System.Posix.Types (Fd(..))
 
+{-|
+   Simple binding for sendfile() of MacOS.
+   Used system calls:
+     EntireFile -- open(), stat(), sendfile(), and close()
+     PartOfFile -- open(), sendfile(), and close()
+   If the size of the file is unknown when sending the entire file,
+   specifying PartOfFile is much faster.
+-}
 sendfile :: Socket -> FilePath -> FileRange -> IO ()
 sendfile sock path range = bracket
     (openFd path ReadOnly Nothing defaultFileFlags)

Network/Sendfile/MacOS.hsc

@@ -16,6 +16,10 @@ import Network.Socket
 import System.Posix.IO
 import System.Posix.Types (Fd(..))
 
+{-|
+   Simple binding for sendfile() of MacOS.
+   Used system calls: open(), sendfile(), and close().
+-}
 sendfile :: Socket -> FilePath -> FileRange -> IO ()
 sendfile sock path range = bracket
     (openFd path ReadOnly Nothing defaultFileFlags)

Network/Sendfile/Types.hs

@@ -1,5 +1,8 @@
 module Network.Sendfile.Types where
 
+{-|
+  File range for 'sendfile'.
+-}
 data FileRange = EntireFile
                | PartOfFile {
                    rangeOffset :: Integer