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


-- | Socket to Socket Data Splicing (supports all operating systems)
--   
--   A library that implements most efficient socket to socket data
--   transfer loops for proxy servers on each operating system.
--   
--   On Linux, it uses and exposes the zero-copy <tt>splice()</tt> system
--   call: <a>http://kerneltrap.org/node/6505</a>.
--   
--   On other operating systems, it currently falls back to a portable
--   Haskell implementation.
--   
--   <ul>
--   <li><i>Corsis Research</i> This work is funded by Corsis Research
--   (<a>http://corsis.eu</a>) for the development of</li>
--   <li><i>PortFusion ]-[ayabusa (はやぶさ) (Hayabusa)</i> – German-Japanese
--   joint research project for building the simplest and most concise
--   high-performance distributed reverse / forward proxy possible
--   (<a>https://sourceforge.net/p/portfusion/wiki/RoadMap/</a>).</li>
--   </ul>
@package splice
@version 0.3


-- | This library implements most efficient socket to socket data transfer
--   loops for proxy servers on each operating system.
--   
--   On Linux, it uses and exposes the zero-copy <tt>splice()</tt> system
--   call: <a>http://kerneltrap.org/node/6505</a>.
--   
--   On other operating systems, it currently falls back to a portable
--   Haskell implementation – which first allocates a constant-sized memory
--   buffer in user address, then enters an inner loop which uses
--   <a>hGetBufSome</a> and <a>hPutBuf</a> on this user-space buffer. This
--   avoids tony of tiny allocations as might otherwise be caused by
--   <a>recv</a> and <a>sendAll</a> from the <tt>bytestring</tt> package.
module Network.Socket.Splice

-- | Pipes data from one socket to another in an <i>infinite loop</i>.
--   
--   On Linux this uses the <tt>splice()</tt> system call and eliminates
--   copying between kernel and user address spaces.
--   
--   On other operating systems, a portable Haskell implementation utilizes
--   a user space buffer.
splice :: ChunkSize -> Socket -> Socket -> IO ()

-- | The numeric type to recommend chunk sizes for moving data between
--   sockets used by both zero-copy and portable implementations of
--   <a>splice</a>.
type ChunkSize = Int

-- | Indicates whether <a>splice</a> uses zero-copy system calls or the
--   portable user space Haskell implementation.
zeroCopy :: Bool

-- | Similar to <a>try</a> but used when an obvious exception is expected
--   which can be safely ignored.
try_ :: IO () -> IO ()