Expose NullSockAddr, add send-with-fds functions

CHANGELOG.md

@@ -1,3 +1,10 @@
+## Version 3.1.5.0
+
+* [#541](https://github.com/haskell/network/issues/541)
+  * Export `Network.Socket.Internal.NullSockAddr`
+  * Add `Network.Socket.ByteString.sendManyWithFds`
+  * Add `Network.Socket.ByteString.Lazy.sendWithFds`
+
 ## Version 3.1.4.0
 
 * Install and use afunix_compat.h header.

Network/Socket/ByteString.hs

@@ -29,6 +29,7 @@ module Network.Socket.ByteString
     -- $vectored
     , sendMany
     , sendManyTo
+    , sendManyWithFds
 
     -- * Receive data from a socket
     , recv

Network/Socket/ByteString/IO.hsc

@@ -24,6 +24,7 @@ module Network.Socket.ByteString.IO
     -- $vectored
     , sendMany
     , sendManyTo
+    , sendManyWithFds
 
     -- * Receive data from a socket
     , recv
@@ -53,6 +54,7 @@ import Data.ByteString.Internal (create, ByteString(..))
 import Foreign.ForeignPtr (withForeignPtr)
 import Foreign.Marshal.Utils (with)
 import Network.Socket.Internal
+import System.Posix.Types (Fd(..))
 
 import Network.Socket.Flag
 
@@ -217,6 +219,21 @@ sendManyTo s cs addr = do
                   peek send_ptr
 #endif
 
+-- | Send data and file descriptors over a UNIX-domain socket in
+--   a single system call. This function does not work on Windows.
+sendManyWithFds :: Socket       -- ^ Socket
+                -> [ByteString] -- ^ Data to send
+                -> [Fd]         -- ^ File descriptors
+                -> IO ()
+sendManyWithFds s bss fds =
+    void $
+        withBufSizs bss $ \bufsizs ->
+            sendBufMsg s addr bufsizs cmsgs flags
+  where
+    addr = NullSockAddr
+    cmsgs = encodeCmsg <$> fds
+    flags = mempty
+
 -- ----------------------------------------------------------------------------
 -- Receiving
 

Network/Socket/ByteString/Lazy.hs

@@ -23,6 +23,7 @@ module Network.Socket.ByteString.Lazy (
     -- * Send data to a socket
     send
   , sendAll
+  , sendWithFds
     -- * Receive data from a socket
   , getContents
   , recv
@@ -33,6 +34,7 @@ import           Network.Socket                (ShutdownCmd (..), shutdown)
 import           Prelude                       hiding (getContents)
 import           System.IO.Unsafe              (unsafeInterleaveIO)
 import           System.IO.Error               (catchIOError)
+import           System.Posix.Types            (Fd(..))
 
 #if defined(mingw32_HOST_OS)
 import Network.Socket.ByteString.Lazy.Windows  (send, sendAll)
@@ -41,10 +43,19 @@ import Network.Socket.ByteString.Lazy.Posix    (send, sendAll)
 #endif
 
 import qualified Data.ByteString               as S
+import qualified Data.ByteString.Lazy          as L
 import qualified Network.Socket.ByteString     as N
 import           Network.Socket.Imports
 import           Network.Socket.Types
 
+-- | Send data and file descriptors over a UNIX-domain socket in
+--   a single system call. This function does not work on Windows.
+sendWithFds :: Socket     -- ^ Socket
+            -> ByteString -- ^ Data to send
+            -> [Fd]       -- ^ File descriptors
+            -> IO ()
+sendWithFds s lbs fds = N.sendManyWithFds s (L.toChunks lbs) fds
+
 -- -----------------------------------------------------------------------------
 -- Receiving
 -- | Receive data from the socket.  The socket must be in a connected

Network/Socket/Internal.hs

@@ -48,6 +48,9 @@ module Network.Socket.Internal
     -- * Initialization
     , withSocketsDo
 
+    -- * Null socket address type
+    , NullSockAddr (..)
+
     -- * Low-level helpers
     , zeroMemory
     ) where

Network/Socket/Types.hsc

@@ -67,6 +67,9 @@ module Network.Socket.Types (
     , pokeSockAddr
     , withSockAddr
 
+    -- * Null socket address type
+    , NullSockAddr(..)
+
     -- * Unsorted
     , ProtocolNumber
     , defaultProtocol
@@ -1021,6 +1024,17 @@ withNewSocketAddress f = allocaBytes sockaddrStorageLen $ \ptr -> do
     zeroMemory ptr $ fromIntegral sockaddrStorageLen
     f ptr sockaddrStorageLen
 
+------------------------------------------------------------------------
+
+-- | A null 'SocketAddress' for situations where a socket address
+--   parameter is optional.
+data NullSockAddr = NullSockAddr
+
+instance SocketAddress NullSockAddr where
+    sizeOfSocketAddress _ = 0
+    peekSocketAddress _   = return NullSockAddr
+    pokeSocketAddress _ _ = return ()
+
 ------------------------------------------------------------------------
 -- Socket addresses
 

Network/Socket/Unix.hsc

@@ -133,13 +133,6 @@ getPeerEid _ = return (0, 0)
 isUnixDomainSocketAvailable :: Bool
 isUnixDomainSocketAvailable = True
 
-data NullSockAddr = NullSockAddr
-
-instance SocketAddress NullSockAddr where
-    sizeOfSocketAddress _ = 0
-    peekSocketAddress _   = return NullSockAddr
-    pokeSocketAddress _ _ = return ()
-
 -- | Send a file descriptor over a UNIX-domain socket.
 --   This function does not work on Windows.
 sendFd :: Socket -> CInt -> IO ()

network.cabal

@@ -1,6 +1,6 @@
 cabal-version:      1.18
 name:               network
-version:            3.1.4.0
+version:            3.1.5.0
 license:            BSD3
 license-file:       LICENSE
 maintainer:         Kazu Yamamoto, Evan Borden