{-# LINE 1 "Network/Socket.hsc" #-} {-# LANGUAGE CPP, ScopedTypeVariables #-} {-# LINE 2 "Network/Socket.hsc" #-} {-# OPTIONS_GHC -fno-warn-orphans -fno-warn-unused-do-bind #-} ----------------------------------------------------------------------------- -- | -- Module : Network.Socket -- Copyright : (c) The University of Glasgow 2001 -- License : BSD-style (see the file libraries/network/LICENSE) -- -- Maintainer : libraries@haskell.org -- Stability : provisional -- Portability : portable -- -- The "Network.Socket" module is for when you want full control over -- sockets. Essentially the entire C socket API is exposed through -- this module; in general the operations follow the behaviour of the C -- functions of the same name (consult your favourite Unix networking book). -- -- A higher level interface to networking operations is provided -- through the module "Network". -- ----------------------------------------------------------------------------- {-# LINE 24 "Network/Socket.hsc" #-} -- NOTE: ##, we want this interpreted when compiling the .hs, not by hsc2hs. #include "Typeable.h" -- In order to process this file, you need to have CALLCONV defined. module Network.Socket ( -- * Types Socket(..) , Family(..) , isSupportedFamily , SocketType(..) , isSupportedSocketType , SockAddr(..) , SocketStatus(..) , HostAddress {-# LINE 42 "Network/Socket.hsc" #-} , HostAddress6 , FlowInfo , ScopeID {-# LINE 46 "Network/Socket.hsc" #-} , ShutdownCmd(..) , ProtocolNumber , defaultProtocol , PortNumber(..) -- PortNumber is used non-abstractly in Network.BSD. ToDo: remove -- this use and make the type abstract. -- * Address operations , HostName , ServiceName {-# LINE 59 "Network/Socket.hsc" #-} , AddrInfo(..) , AddrInfoFlag(..) , addrInfoFlagImplemented , defaultHints , getAddrInfo , NameInfoFlag(..) , getNameInfo {-# LINE 72 "Network/Socket.hsc" #-} -- * Socket operations , socket {-# LINE 76 "Network/Socket.hsc" #-} , socketPair {-# LINE 78 "Network/Socket.hsc" #-} , connect , bind , listen , accept , getPeerName , getSocketName {-# LINE 86 "Network/Socket.hsc" #-} -- get the credentials of our domain socket peer. , getPeerCred {-# LINE 89 "Network/Socket.hsc" #-} , socketPort , socketToHandle -- ** Sending and receiving data -- $sendrecv , sendTo , sendBufTo , recvFrom , recvBufFrom , send , recv , recvLen , inet_addr , inet_ntoa , shutdown , close -- ** Predicates on sockets , isConnected , isBound , isListening , isReadable , isWritable -- * Socket options , SocketOption(..) , isSupportedSocketOption , getSocketOption , setSocketOption -- * File descriptor transmission {-# LINE 127 "Network/Socket.hsc" #-} , sendFd , recvFd {-# LINE 131 "Network/Socket.hsc" #-} -- * Special constants , aNY_PORT , iNADDR_ANY {-# LINE 136 "Network/Socket.hsc" #-} , iN6ADDR_ANY {-# LINE 138 "Network/Socket.hsc" #-} , sOMAXCONN , sOL_SOCKET {-# LINE 141 "Network/Socket.hsc" #-} , sCM_RIGHTS {-# LINE 143 "Network/Socket.hsc" #-} , maxListenQueue -- * Initialisation , withSocketsDo -- * Very low level operations -- in case you ever want to get at the underlying file descriptor.. , fdSocket , mkSocket -- * Deprecated aliases -- $deprecated-aliases , bindSocket , sClose , sIsConnected , sIsBound , sIsListening , sIsReadable , sIsWritable -- * Internal -- | The following are exported ONLY for use in the BSD module and -- should not be used anywhere else. , packFamily , unpackFamily , packSocketType ) where {-# LINE 185 "Network/Socket.hsc" #-} import Data.Bits import Data.List (foldl') import Data.Maybe (fromMaybe, isJust) import Data.Word (Word16, Word32) import Foreign.Ptr (Ptr, castPtr, nullPtr) import Foreign.Storable (Storable(..)) import Foreign.C.Error import Foreign.C.String (CString, withCString, peekCString, peekCStringLen) import Foreign.C.Types (CUInt, CChar) {-# LINE 196 "Network/Socket.hsc" #-} import Foreign.C.Types (CInt(..), CSize(..)) {-# LINE 200 "Network/Socket.hsc" #-} import Foreign.Marshal.Alloc ( alloca, allocaBytes ) import Foreign.Marshal.Array ( peekArray ) import Foreign.Marshal.Utils ( maybeWith, with ) import System.IO import Control.Monad (liftM, when) import Data.Ratio ((%)) import qualified Control.Exception as E import Control.Concurrent.MVar import Data.Typeable import System.IO.Error {-# LINE 214 "Network/Socket.hsc" #-} import GHC.Conc (threadWaitRead, threadWaitWrite) #if MIN_VERSION_base(4,3,1) import GHC.Conc (closeFdWith) #endif {-# LINE 222 "Network/Socket.hsc" #-} {-# LINE 223 "Network/Socket.hsc" #-} import qualified GHC.IO.Device import GHC.IO.Handle.FD import GHC.IO.Exception import GHC.IO {-# LINE 231 "Network/Socket.hsc" #-} import qualified System.Posix.Internals {-# LINE 235 "Network/Socket.hsc" #-} {-# LINE 237 "Network/Socket.hsc" #-} import GHC.IO.FD {-# LINE 239 "Network/Socket.hsc" #-} import Network.Socket.Internal -- | Either a host name e.g., @\"haskell.org\"@ or a numeric host -- address string consisting of a dotted decimal IPv4 address or an -- IPv6 address e.g., @\"192.168.0.1\"@. type HostName = String type ServiceName = String -- ---------------------------------------------------------------------------- -- On Windows, our sockets are not put in non-blocking mode (non-blocking -- is not supported for regular file descriptors on Windows, and it would -- be a pain to support it only for sockets). So there are two cases: -- -- - the threaded RTS uses safe calls for socket operations to get -- non-blocking I/O, just like the rest of the I/O library -- -- - with the non-threaded RTS, only some operations on sockets will be -- non-blocking. Reads and writes go through the normal async I/O -- system. accept() uses asyncDoProc so is non-blocking. A handful -- of others (recvFrom, sendFd, recvFd) will block all threads - if this -- is a problem, -threaded is the workaround. -- #if defined(mingw32_HOST_OS) #define SAFE_ON_WIN safe #else #define SAFE_ON_WIN unsafe #endif ----------------------------------------------------------------------------- -- Socket types -- There are a few possible ways to do this. The first is convert the -- structs used in the C library into an equivalent Haskell type. An -- other possible implementation is to keep all the internals in the C -- code and use an Int## and a status flag. The second method is used -- here since a lot of the C structures are not required to be -- manipulated. -- Originally the status was non-mutable so we had to return a new -- socket each time we changed the status. This version now uses -- mutable variables to avoid the need to do this. The result is a -- cleaner interface and better security since the application -- programmer now can't circumvent the status information to perform -- invalid operations on sockets. data SocketStatus -- Returned Status Function called = NotConnected -- socket | Bound -- bind | Listening -- listen | Connected -- connect/accept | ConvertedToHandle -- is now a Handle, don't touch | Closed -- close deriving (Eq, Show, Typeable) data Socket = MkSocket CInt -- File Descriptor Family SocketType ProtocolNumber -- Protocol Number (MVar SocketStatus) -- Status Flag deriving Typeable {-# LINE 309 "Network/Socket.hsc" #-} mkSocket :: CInt -> Family -> SocketType -> ProtocolNumber -> SocketStatus -> IO Socket mkSocket fd fam sType pNum stat = do mStat <- newMVar stat return (MkSocket fd fam sType pNum mStat) instance Eq Socket where (MkSocket _ _ _ _ m1) == (MkSocket _ _ _ _ m2) = m1 == m2 instance Show Socket where showsPrec _n (MkSocket fd _ _ _ _) = showString "<socket: " . shows fd . showString ">" fdSocket :: Socket -> CInt fdSocket (MkSocket fd _ _ _ _) = fd type ProtocolNumber = CInt -- | This is the default protocol for a given service. defaultProtocol :: ProtocolNumber defaultProtocol = 0 ---------------------------------------------------------------------------- -- Port Numbers instance Show PortNumber where showsPrec p pn = showsPrec p (portNumberToInt pn) intToPortNumber :: Int -> PortNumber intToPortNumber v = PortNum (htons (fromIntegral v)) portNumberToInt :: PortNumber -> Int portNumberToInt (PortNum po) = fromIntegral (ntohs po) foreign import CALLCONV unsafe "ntohs" ntohs :: Word16 -> Word16 foreign import CALLCONV unsafe "htons" htons :: Word16 -> Word16 --foreign import CALLCONV unsafe "ntohl" ntohl :: Word32 -> Word32 foreign import CALLCONV unsafe "htonl" htonl :: Word32 -> Word32 instance Enum PortNumber where toEnum = intToPortNumber fromEnum = portNumberToInt instance Num PortNumber where fromInteger i = intToPortNumber (fromInteger i) -- for completeness. (+) x y = intToPortNumber (portNumberToInt x + portNumberToInt y) (-) x y = intToPortNumber (portNumberToInt x - portNumberToInt y) negate x = intToPortNumber (-portNumberToInt x) (*) x y = intToPortNumber (portNumberToInt x * portNumberToInt y) abs n = intToPortNumber (abs (portNumberToInt n)) signum n = intToPortNumber (signum (portNumberToInt n)) instance Real PortNumber where toRational x = toInteger x % 1 instance Integral PortNumber where quotRem a b = let (c,d) = quotRem (portNumberToInt a) (portNumberToInt b) in (intToPortNumber c, intToPortNumber d) toInteger a = toInteger (portNumberToInt a) instance Storable PortNumber where sizeOf _ = sizeOf (undefined :: Word16) alignment _ = alignment (undefined :: Word16) poke p (PortNum po) = poke (castPtr p) po peek p = PortNum `liftM` peek (castPtr p) ----------------------------------------------------------------------------- -- SockAddr instance Show SockAddr where {-# LINE 387 "Network/Socket.hsc" #-} showsPrec _ (SockAddrUnix str) = showString str {-# LINE 389 "Network/Socket.hsc" #-} showsPrec _ (SockAddrInet port ha) = showString (unsafePerformIO (inet_ntoa ha)) . showString ":" . shows port {-# LINE 394 "Network/Socket.hsc" #-} showsPrec _ addr@(SockAddrInet6 port _ _ _) = showChar '[' . showString (unsafePerformIO $ fst `liftM` getNameInfo [NI_NUMERICHOST] True False addr >>= maybe (fail "showsPrec: impossible internal error") return) . showString "]:" . shows port {-# LINE 402 "Network/Socket.hsc" #-} ----------------------------------------------------------------------------- -- Connection Functions -- In the following connection and binding primitives. The names of -- the equivalent C functions have been preserved where possible. It -- should be noted that some of these names used in the C library, -- \tr{bind} in particular, have a different meaning to many Haskell -- programmers and have thus been renamed by appending the prefix -- Socket. -- | Create a new socket using the given address family, socket type -- and protocol number. The address family is usually 'AF_INET', -- 'AF_INET6', or 'AF_UNIX'. The socket type is usually 'Stream' or -- 'Datagram'. The protocol number is usually 'defaultProtocol'. -- If 'AF_INET6' is used, the 'IPv6Only' socket option is set to 0 -- so that both IPv4 and IPv6 can be handled with one socket. socket :: Family -- Family Name (usually AF_INET) -> SocketType -- Socket Type (usually Stream) -> ProtocolNumber -- Protocol Number (getProtocolByName to find value) -> IO Socket -- Unconnected Socket socket family stype protocol = do c_stype <- packSocketTypeOrThrow "socket" stype fd <- throwSocketErrorIfMinus1Retry "socket" $ c_socket (packFamily family) c_stype protocol {-# LINE 428 "Network/Socket.hsc" #-} {-# LINE 431 "Network/Socket.hsc" #-} System.Posix.Internals.setNonBlockingFD fd True {-# LINE 433 "Network/Socket.hsc" #-} {-# LINE 434 "Network/Socket.hsc" #-} socket_status <- newMVar NotConnected let sock = MkSocket fd family stype protocol socket_status {-# LINE 437 "Network/Socket.hsc" #-} {-# LINE 443 "Network/Socket.hsc" #-} when (family == AF_INET6) $ setSocketOption sock IPv6Only 0 {-# LINE 445 "Network/Socket.hsc" #-} {-# LINE 446 "Network/Socket.hsc" #-} return sock -- | Build a pair of connected socket objects using the given address -- family, socket type, and protocol number. Address family, socket -- type, and protocol number are as for the 'socket' function above. -- Availability: Unix. {-# LINE 453 "Network/Socket.hsc" #-} socketPair :: Family -- Family Name (usually AF_INET or AF_INET6) -> SocketType -- Socket Type (usually Stream) -> ProtocolNumber -- Protocol Number -> IO (Socket, Socket) -- unnamed and connected. socketPair family stype protocol = do allocaBytes (2 * sizeOf (1 :: CInt)) $ \ fdArr -> do c_stype <- packSocketTypeOrThrow "socketPair" stype _rc <- throwSocketErrorIfMinus1Retry "socketpair" $ c_socketpair (packFamily family) c_stype protocol fdArr [fd1,fd2] <- peekArray 2 fdArr s1 <- mkNonBlockingSocket fd1 s2 <- mkNonBlockingSocket fd2 return (s1,s2) where mkNonBlockingSocket fd = do {-# LINE 469 "Network/Socket.hsc" #-} {-# LINE 472 "Network/Socket.hsc" #-} System.Posix.Internals.setNonBlockingFD fd True {-# LINE 474 "Network/Socket.hsc" #-} {-# LINE 475 "Network/Socket.hsc" #-} stat <- newMVar Connected return (MkSocket fd family stype protocol stat) foreign import ccall unsafe "socketpair" c_socketpair :: CInt -> CInt -> CInt -> Ptr CInt -> IO CInt {-# LINE 481 "Network/Socket.hsc" #-} ----------------------------------------------------------------------------- -- Binding a socket -- | Bind the socket to an address. The socket must not already be -- bound. The 'Family' passed to @bind@ must be the -- same as that passed to 'socket'. If the special port number -- 'aNY_PORT' is passed then the system assigns the next available -- use port. bind :: Socket -- Unconnected Socket -> SockAddr -- Address to Bind to -> IO () bind (MkSocket s _family _stype _protocol socketStatus) addr = do modifyMVar_ socketStatus $ \ status -> do if status /= NotConnected then ioError (userError ("bind: can't peform bind on socket in status " ++ show status)) else do withSockAddr addr $ \p_addr sz -> do _status <- throwSocketErrorIfMinus1Retry "bind" $ c_bind s p_addr (fromIntegral sz) return Bound ----------------------------------------------------------------------------- -- Connecting a socket -- | Connect to a remote socket at address. connect :: Socket -- Unconnected Socket -> SockAddr -- Socket address stuff -> IO () connect sock@(MkSocket s _family _stype _protocol socketStatus) addr = do modifyMVar_ socketStatus $ \currentStatus -> do if currentStatus /= NotConnected && currentStatus /= Bound then ioError (userError ("connect: can't peform connect on socket in status " ++ show currentStatus)) else do withSockAddr addr $ \p_addr sz -> do let connectLoop = do r <- c_connect s p_addr (fromIntegral sz) if r == -1 then do {-# LINE 525 "Network/Socket.hsc" #-} err <- getErrno case () of _ | err == eINTR -> connectLoop _ | err == eINPROGRESS -> connectBlocked -- _ | err == eAGAIN -> connectBlocked _otherwise -> throwSocketError "connect" {-# LINE 542 "Network/Socket.hsc" #-} else return r connectBlocked = do {-# LINE 546 "Network/Socket.hsc" #-} threadWaitWrite (fromIntegral s) {-# LINE 548 "Network/Socket.hsc" #-} err <- getSocketOption sock SoError if (err == 0) then return 0 else do ioError (errnoToIOError "connect" (Errno (fromIntegral err)) Nothing Nothing) connectLoop return Connected ----------------------------------------------------------------------------- -- Listen -- | Listen for connections made to the socket. The second argument -- specifies the maximum number of queued connections and should be at -- least 1; the maximum value is system-dependent (usually 5). listen :: Socket -- Connected & Bound Socket -> Int -- Queue Length -> IO () listen (MkSocket s _family _stype _protocol socketStatus) backlog = do modifyMVar_ socketStatus $ \ status -> do if status /= Bound then ioError (userError ("listen: can't peform listen on socket in status " ++ show status)) else do throwSocketErrorIfMinus1Retry "listen" (c_listen s (fromIntegral backlog)) return Listening ----------------------------------------------------------------------------- -- Accept -- -- A call to `accept' only returns when data is available on the given -- socket, unless the socket has been set to non-blocking. It will -- return a new socket which should be used to read the incoming data and -- should then be closed. Using the socket returned by `accept' allows -- incoming requests to be queued on the original socket. -- | Accept a connection. The socket must be bound to an address and -- listening for connections. The return value is a pair @(conn, -- address)@ where @conn@ is a new socket object usable to send and -- receive data on the connection, and @address@ is the address bound -- to the socket on the other end of the connection. accept :: Socket -- Queue Socket -> IO (Socket, -- Readable Socket SockAddr) -- Peer details accept sock@(MkSocket s family stype protocol status) = do currentStatus <- readMVar status okay <- isAcceptable sock if not okay then ioError (userError ("accept: can't perform accept on socket (" ++ (show (family,stype,protocol)) ++") in status " ++ show currentStatus)) else do let sz = sizeOfSockAddrByFamily family allocaBytes sz $ \ sockaddr -> do {-# LINE 620 "Network/Socket.hsc" #-} with (fromIntegral sz) $ \ ptr_len -> do new_sock <- {-# LINE 623 "Network/Socket.hsc" #-} throwSocketErrorIfMinus1RetryMayBlock "accept" (threadWaitRead (fromIntegral s)) (c_accept4 s sockaddr ptr_len (2048)) {-# LINE 626 "Network/Socket.hsc" #-} {-# LINE 640 "Network/Socket.hsc" #-} {-# LINE 641 "Network/Socket.hsc" #-} addr <- peekSockAddr sockaddr new_status <- newMVar Connected return ((MkSocket new_sock family stype protocol new_status), addr) {-# LINE 655 "Network/Socket.hsc" #-} ----------------------------------------------------------------------------- -- ** Sending and reciving data -- $sendrecv -- -- Do not use the @send@ and @recv@ functions defined in this module -- in new code, as they incorrectly represent binary data as a Unicode -- string. As a result, these functions are inefficient and may lead -- to bugs in the program. Instead use the @send@ and @recv@ -- functions defined in the 'Network.Socket.ByteString' module. ----------------------------------------------------------------------------- -- sendTo & recvFrom -- | Send data to the socket. The recipient can be specified -- explicitly, so the socket need not be in a connected state. -- Returns the number of bytes sent. Applications are responsible for -- ensuring that all data has been sent. -- -- NOTE: blocking on Windows unless you compile with -threaded (see -- GHC ticket #1129) sendTo :: Socket -- (possibly) bound/connected Socket -> String -- Data to send -> SockAddr -> IO Int -- Number of Bytes sent sendTo sock xs addr = do withCString xs $ \str -> do sendBufTo sock str (length xs) addr -- | Send data to the socket. The recipient can be specified -- explicitly, so the socket need not be in a connected state. -- Returns the number of bytes sent. Applications are responsible for -- ensuring that all data has been sent. sendBufTo :: Socket -- (possibly) bound/connected Socket -> Ptr a -> Int -- Data to send -> SockAddr -> IO Int -- Number of Bytes sent sendBufTo (MkSocket s _family _stype _protocol _status) ptr nbytes addr = do withSockAddr addr $ \p_addr sz -> do liftM fromIntegral $ {-# LINE 697 "Network/Socket.hsc" #-} throwSocketErrorIfMinus1RetryMayBlock "sendTo" (threadWaitWrite (fromIntegral s)) $ {-# LINE 700 "Network/Socket.hsc" #-} c_sendto s ptr (fromIntegral $ nbytes) 0{-flags-} p_addr (fromIntegral sz) -- | Receive data from the socket. The socket need not be in a -- connected state. Returns @(bytes, nbytes, address)@ where @bytes@ -- is a @String@ of length @nbytes@ representing the data received and -- @address@ is a 'SockAddr' representing the address of the sending -- socket. -- -- NOTE: blocking on Windows unless you compile with -threaded (see -- GHC ticket #1129) recvFrom :: Socket -> Int -> IO (String, Int, SockAddr) recvFrom sock nbytes = allocaBytes nbytes $ \ptr -> do (len, sockaddr) <- recvBufFrom sock ptr nbytes str <- peekCStringLen (ptr, len) return (str, len, sockaddr) -- | Receive data from the socket, writing it into buffer instead of -- creating a new string. The socket need not be in a connected -- state. Returns @(nbytes, address)@ where @nbytes@ is the number of -- bytes received and @address@ is a 'SockAddr' representing the -- address of the sending socket. -- -- NOTE: blocking on Windows unless you compile with -threaded (see -- GHC ticket #1129) recvBufFrom :: Socket -> Ptr a -> Int -> IO (Int, SockAddr) recvBufFrom sock@(MkSocket s family _stype _protocol _status) ptr nbytes | nbytes <= 0 = ioError (mkInvalidRecvArgError "Network.Socket.recvFrom") | otherwise = withNewSockAddr family $ \ptr_addr sz -> do alloca $ \ptr_len -> do poke ptr_len (fromIntegral sz) len <- {-# LINE 735 "Network/Socket.hsc" #-} throwSocketErrorIfMinus1RetryMayBlock "recvFrom" (threadWaitRead (fromIntegral s)) $ {-# LINE 738 "Network/Socket.hsc" #-} c_recvfrom s ptr (fromIntegral nbytes) 0{-flags-} ptr_addr ptr_len let len' = fromIntegral len if len' == 0 then ioError (mkEOFError "Network.Socket.recvFrom") else do flg <- isConnected sock -- For at least one implementation (WinSock 2), recvfrom() ignores -- filling in the sockaddr for connected TCP sockets. Cope with -- this by using getPeerName instead. sockaddr <- if flg then getPeerName sock else peekSockAddr ptr_addr return (len', sockaddr) ----------------------------------------------------------------------------- -- send & recv -- | Send data to the socket. The socket must be connected to a remote -- socket. Returns the number of bytes sent. Applications are -- responsible for ensuring that all data has been sent. send :: Socket -- Bound/Connected Socket -> String -- Data to send -> IO Int -- Number of Bytes sent send sock@(MkSocket s _family _stype _protocol _status) xs = do let len = length xs withCString xs $ \str -> do liftM fromIntegral $ {-# LINE 787 "Network/Socket.hsc" #-} {-# LINE 788 "Network/Socket.hsc" #-} throwSocketErrorIfMinus1RetryMayBlock "send" (threadWaitWrite (fromIntegral s)) $ {-# LINE 791 "Network/Socket.hsc" #-} c_send s str (fromIntegral len) 0{-flags-} {-# LINE 793 "Network/Socket.hsc" #-} -- | Receive data from the socket. The socket must be in a connected -- state. This function may return fewer bytes than specified. If the -- message is longer than the specified length, it may be discarded -- depending on the type of socket. This function may block until a -- message arrives. -- -- Considering hardware and network realities, the maximum number of -- bytes to receive should be a small power of 2, e.g., 4096. -- -- For TCP sockets, a zero length return value means the peer has -- closed its half side of the connection. recv :: Socket -> Int -> IO String recv sock l = recvLen sock l >>= \ (s,_) -> return s recvLen :: Socket -> Int -> IO (String, Int) recvLen sock@(MkSocket s _family _stype _protocol _status) nbytes | nbytes <= 0 = ioError (mkInvalidRecvArgError "Network.Socket.recv") | otherwise = do allocaBytes nbytes $ \ptr -> do len <- {-# LINE 823 "Network/Socket.hsc" #-} {-# LINE 824 "Network/Socket.hsc" #-} throwSocketErrorIfMinus1RetryMayBlock "recv" (threadWaitRead (fromIntegral s)) $ {-# LINE 827 "Network/Socket.hsc" #-} c_recv s ptr (fromIntegral nbytes) 0{-flags-} {-# LINE 829 "Network/Socket.hsc" #-} let len' = fromIntegral len if len' == 0 then ioError (mkEOFError "Network.Socket.recv") else do s' <- peekCStringLen (castPtr ptr,len') return (s', len') -- --------------------------------------------------------------------------- -- socketPort -- -- The port number the given socket is currently connected to can be -- determined by calling $port$, is generally only useful when bind -- was given $aNY\_PORT$. socketPort :: Socket -- Connected & Bound Socket -> IO PortNumber -- Port Number of Socket socketPort sock@(MkSocket _ AF_INET _ _ _) = do (SockAddrInet port _) <- getSocketName sock return port {-# LINE 849 "Network/Socket.hsc" #-} socketPort sock@(MkSocket _ AF_INET6 _ _ _) = do (SockAddrInet6 port _ _ _) <- getSocketName sock return port {-# LINE 853 "Network/Socket.hsc" #-} socketPort (MkSocket _ family _ _ _) = ioError (userError ("socketPort: not supported for Family " ++ show family)) -- --------------------------------------------------------------------------- -- getPeerName -- Calling $getPeerName$ returns the address details of the machine, -- other than the local one, which is connected to the socket. This is -- used in programs such as FTP to determine where to send the -- returning data. The corresponding call to get the details of the -- local machine is $getSocketName$. getPeerName :: Socket -> IO SockAddr getPeerName (MkSocket s family _ _ _) = do withNewSockAddr family $ \ptr sz -> do with (fromIntegral sz) $ \int_star -> do throwSocketErrorIfMinus1Retry "getPeerName" $ c_getpeername s ptr int_star _sz <- peek int_star peekSockAddr ptr getSocketName :: Socket -> IO SockAddr getSocketName (MkSocket s family _ _ _) = do withNewSockAddr family $ \ptr sz -> do with (fromIntegral sz) $ \int_star -> do throwSocketErrorIfMinus1Retry "getSocketName" $ c_getsockname s ptr int_star peekSockAddr ptr ----------------------------------------------------------------------------- -- Socket Properties -- | Socket options for use with 'setSocketOption' and 'getSocketOption'. -- -- The existence of a constructor does not imply that the relevant option -- is supported on your system: see 'isSupportedSocketOption' data SocketOption = Debug -- ^ SO_DEBUG | ReuseAddr -- ^ SO_REUSEADDR | Type -- ^ SO_TYPE | SoError -- ^ SO_ERROR | DontRoute -- ^ SO_DONTROUTE | Broadcast -- ^ SO_BROADCAST | SendBuffer -- ^ SO_SNDBUF | RecvBuffer -- ^ SO_RCVBUF | KeepAlive -- ^ SO_KEEPALIVE | OOBInline -- ^ SO_OOBINLINE | TimeToLive -- ^ IP_TTL | MaxSegment -- ^ TCP_MAXSEG | NoDelay -- ^ TCP_NODELAY | Cork -- ^ TCP_CORK | Linger -- ^ SO_LINGER | ReusePort -- ^ SO_REUSEPORT | RecvLowWater -- ^ SO_RCVLOWAT | SendLowWater -- ^ SO_SNDLOWAT | RecvTimeOut -- ^ SO_RCVTIMEO | SendTimeOut -- ^ SO_SNDTIMEO | UseLoopBack -- ^ SO_USELOOPBACK | IPv6Only -- ^ IPV6_V6ONLY deriving (Show, Typeable) -- | Does the 'SocketOption' exist on this system? isSupportedSocketOption :: SocketOption -> Bool isSupportedSocketOption = isJust . packSocketOption -- | For a socket option, return Just (level, value) where level is the -- corresponding C option level constant (e.g. SOL_SOCKET) and value is -- the option constant itself (e.g. SO_DEBUG) -- If either constant does not exist, return Nothing. packSocketOption :: SocketOption -> Maybe (CInt, CInt) packSocketOption so = -- The Just here is a hack to disable GHC's overlapping pattern detection: -- the problem is if all constants are present, the fallback pattern is -- redundant, but if they aren't then it isn't. Hence we introduce an -- extra pattern (Nothing) that can't possibly happen, so that the -- fallback is always (in principle) necessary. -- I feel a little bad for including this, but such are the sacrifices we -- make while working with CPP - excluding the fallback pattern correctly -- would be a serious nuisance. -- (NB: comments elsewhere in this file refer to this one) case Just so of {-# LINE 934 "Network/Socket.hsc" #-} {-# LINE 935 "Network/Socket.hsc" #-} Just Debug -> Just ((1), (1)) {-# LINE 936 "Network/Socket.hsc" #-} {-# LINE 937 "Network/Socket.hsc" #-} {-# LINE 938 "Network/Socket.hsc" #-} Just ReuseAddr -> Just ((1), (2)) {-# LINE 939 "Network/Socket.hsc" #-} {-# LINE 940 "Network/Socket.hsc" #-} {-# LINE 941 "Network/Socket.hsc" #-} Just Type -> Just ((1), (3)) {-# LINE 942 "Network/Socket.hsc" #-} {-# LINE 943 "Network/Socket.hsc" #-} {-# LINE 944 "Network/Socket.hsc" #-} Just SoError -> Just ((1), (4)) {-# LINE 945 "Network/Socket.hsc" #-} {-# LINE 946 "Network/Socket.hsc" #-} {-# LINE 947 "Network/Socket.hsc" #-} Just DontRoute -> Just ((1), (5)) {-# LINE 948 "Network/Socket.hsc" #-} {-# LINE 949 "Network/Socket.hsc" #-} {-# LINE 950 "Network/Socket.hsc" #-} Just Broadcast -> Just ((1), (6)) {-# LINE 951 "Network/Socket.hsc" #-} {-# LINE 952 "Network/Socket.hsc" #-} {-# LINE 953 "Network/Socket.hsc" #-} Just SendBuffer -> Just ((1), (7)) {-# LINE 954 "Network/Socket.hsc" #-} {-# LINE 955 "Network/Socket.hsc" #-} {-# LINE 956 "Network/Socket.hsc" #-} Just RecvBuffer -> Just ((1), (8)) {-# LINE 957 "Network/Socket.hsc" #-} {-# LINE 958 "Network/Socket.hsc" #-} {-# LINE 959 "Network/Socket.hsc" #-} Just KeepAlive -> Just ((1), (9)) {-# LINE 960 "Network/Socket.hsc" #-} {-# LINE 961 "Network/Socket.hsc" #-} {-# LINE 962 "Network/Socket.hsc" #-} Just OOBInline -> Just ((1), (10)) {-# LINE 963 "Network/Socket.hsc" #-} {-# LINE 964 "Network/Socket.hsc" #-} {-# LINE 965 "Network/Socket.hsc" #-} Just Linger -> Just ((1), (13)) {-# LINE 966 "Network/Socket.hsc" #-} {-# LINE 967 "Network/Socket.hsc" #-} {-# LINE 970 "Network/Socket.hsc" #-} {-# LINE 971 "Network/Socket.hsc" #-} Just RecvLowWater -> Just ((1), (18)) {-# LINE 972 "Network/Socket.hsc" #-} {-# LINE 973 "Network/Socket.hsc" #-} {-# LINE 974 "Network/Socket.hsc" #-} Just SendLowWater -> Just ((1), (19)) {-# LINE 975 "Network/Socket.hsc" #-} {-# LINE 976 "Network/Socket.hsc" #-} {-# LINE 977 "Network/Socket.hsc" #-} Just RecvTimeOut -> Just ((1), (20)) {-# LINE 978 "Network/Socket.hsc" #-} {-# LINE 979 "Network/Socket.hsc" #-} {-# LINE 980 "Network/Socket.hsc" #-} Just SendTimeOut -> Just ((1), (21)) {-# LINE 981 "Network/Socket.hsc" #-} {-# LINE 982 "Network/Socket.hsc" #-} {-# LINE 985 "Network/Socket.hsc" #-} {-# LINE 986 "Network/Socket.hsc" #-} {-# LINE 987 "Network/Socket.hsc" #-} {-# LINE 988 "Network/Socket.hsc" #-} Just TimeToLive -> Just ((0), (2)) {-# LINE 989 "Network/Socket.hsc" #-} {-# LINE 990 "Network/Socket.hsc" #-} {-# LINE 991 "Network/Socket.hsc" #-} {-# LINE 992 "Network/Socket.hsc" #-} {-# LINE 993 "Network/Socket.hsc" #-} Just MaxSegment -> Just ((6), (2)) {-# LINE 994 "Network/Socket.hsc" #-} {-# LINE 995 "Network/Socket.hsc" #-} {-# LINE 996 "Network/Socket.hsc" #-} Just NoDelay -> Just ((6), (1)) {-# LINE 997 "Network/Socket.hsc" #-} {-# LINE 998 "Network/Socket.hsc" #-} {-# LINE 999 "Network/Socket.hsc" #-} Just Cork -> Just ((6), (3)) {-# LINE 1000 "Network/Socket.hsc" #-} {-# LINE 1001 "Network/Socket.hsc" #-} {-# LINE 1002 "Network/Socket.hsc" #-} {-# LINE 1003 "Network/Socket.hsc" #-} {-# LINE 1004 "Network/Socket.hsc" #-} Just IPv6Only -> Just ((41), (26)) {-# LINE 1005 "Network/Socket.hsc" #-} {-# LINE 1006 "Network/Socket.hsc" #-} {-# LINE 1007 "Network/Socket.hsc" #-} _ -> Nothing -- | Return the option level and option value if they exist, -- otherwise throw an error that begins "Network.Socket." ++ the String -- parameter packSocketOption' :: String -> SocketOption -> IO (CInt, CInt) packSocketOption' caller so = maybe err return (packSocketOption so) where err = ioError . userError . concat $ ["Network.Socket.", caller, ": socket option ", show so, " unsupported on this system"] -- | Set a socket option that expects an Int value. -- There is currently no API to set e.g. the timeval socket options setSocketOption :: Socket -> SocketOption -- Option Name -> Int -- Option Value -> IO () setSocketOption (MkSocket s _ _ _ _) so v = do (level, opt) <- packSocketOption' "setSocketOption" so with (fromIntegral v) $ \ptr_v -> do throwErrnoIfMinus1_ "setSocketOption" $ c_setsockopt s level opt ptr_v (fromIntegral (sizeOf (undefined :: CInt))) return () -- | Get a socket option that gives an Int value. -- There is currently no API to get e.g. the timeval socket options getSocketOption :: Socket -> SocketOption -- Option Name -> IO Int -- Option Value getSocketOption (MkSocket s _ _ _ _) so = do (level, opt) <- packSocketOption' "getSocketOption" so alloca $ \ptr_v -> with (fromIntegral (sizeOf (undefined :: CInt))) $ \ptr_sz -> do throwErrnoIfMinus1 "getSocketOption" $ c_getsockopt s level opt ptr_v ptr_sz fromIntegral `liftM` peek ptr_v {-# LINE 1048 "Network/Socket.hsc" #-} -- | Returns the processID, userID and groupID of the socket's peer. -- -- Only available on platforms that support SO_PEERCRED on domain sockets. getPeerCred :: Socket -> IO (CUInt, CUInt, CUInt) getPeerCred sock = do let fd = fdSocket sock let sz = (fromIntegral (12)) {-# LINE 1055 "Network/Socket.hsc" #-} with sz $ \ ptr_cr -> alloca $ \ ptr_sz -> do poke ptr_sz sz throwErrnoIfMinus1 "getPeerCred" $ c_getsockopt fd (1) (17) ptr_cr ptr_sz {-# LINE 1060 "Network/Socket.hsc" #-} pid <- ((\hsc_ptr -> peekByteOff hsc_ptr 0)) ptr_cr {-# LINE 1061 "Network/Socket.hsc" #-} uid <- ((\hsc_ptr -> peekByteOff hsc_ptr 4)) ptr_cr {-# LINE 1062 "Network/Socket.hsc" #-} gid <- ((\hsc_ptr -> peekByteOff hsc_ptr 8)) ptr_cr {-# LINE 1063 "Network/Socket.hsc" #-} return (pid, uid, gid) {-# LINE 1065 "Network/Socket.hsc" #-} #if !(MIN_VERSION_base(4,3,1)) closeFdWith closer fd = closer fd #endif {-# LINE 1071 "Network/Socket.hsc" #-} -- sending/receiving ancillary socket data; low-level mechanism -- for transmitting file descriptors, mainly. sendFd :: Socket -> CInt -> IO () sendFd sock outfd = do let fd = fdSocket sock {-# LINE 1077 "Network/Socket.hsc" #-} throwSocketErrorIfMinus1RetryMayBlock "sendFd" (threadWaitWrite (fromIntegral fd)) $ c_sendFd fd outfd {-# LINE 1083 "Network/Socket.hsc" #-} -- Note: If Winsock supported FD-passing, thi would have been -- incorrect (since socket FDs need to be closed via closesocket().) closeFd outfd recvFd :: Socket -> IO CInt recvFd sock = do let fd = fdSocket sock theFd <- {-# LINE 1092 "Network/Socket.hsc" #-} throwSocketErrorIfMinus1RetryMayBlock "recvFd" (threadWaitRead (fromIntegral fd)) $ {-# LINE 1095 "Network/Socket.hsc" #-} c_recvFd fd return theFd foreign import ccall SAFE_ON_WIN "sendFd" c_sendFd :: CInt -> CInt -> IO CInt foreign import ccall SAFE_ON_WIN "recvFd" c_recvFd :: CInt -> IO CInt {-# LINE 1102 "Network/Socket.hsc" #-} -- --------------------------------------------------------------------------- -- OS Dependent Definitions packFamily :: Family -> CInt packFamily f = case packFamily' f of Just fam -> fam Nothing -> error $ "Network.Socket.packFamily: unsupported address family: " ++ show f -- | Does the AF_ constant corresponding to the given family exist on this -- system? isSupportedFamily :: Family -> Bool isSupportedFamily = isJust . packFamily' packFamily' :: Family -> Maybe CInt packFamily' f = case Just f of -- the Just above is to disable GHC's overlapping pattern -- detection: see comments for packSocketOption Just AF_UNSPEC -> Just 0 {-# LINE 1123 "Network/Socket.hsc" #-} {-# LINE 1124 "Network/Socket.hsc" #-} Just AF_UNIX -> Just 1 {-# LINE 1125 "Network/Socket.hsc" #-} {-# LINE 1126 "Network/Socket.hsc" #-} {-# LINE 1127 "Network/Socket.hsc" #-} Just AF_INET -> Just 2 {-# LINE 1128 "Network/Socket.hsc" #-} {-# LINE 1129 "Network/Socket.hsc" #-} {-# LINE 1130 "Network/Socket.hsc" #-} Just AF_INET6 -> Just 10 {-# LINE 1131 "Network/Socket.hsc" #-} {-# LINE 1132 "Network/Socket.hsc" #-} {-# LINE 1135 "Network/Socket.hsc" #-} {-# LINE 1138 "Network/Socket.hsc" #-} {-# LINE 1141 "Network/Socket.hsc" #-} {-# LINE 1144 "Network/Socket.hsc" #-} {-# LINE 1147 "Network/Socket.hsc" #-} {-# LINE 1150 "Network/Socket.hsc" #-} {-# LINE 1153 "Network/Socket.hsc" #-} {-# LINE 1156 "Network/Socket.hsc" #-} {-# LINE 1157 "Network/Socket.hsc" #-} Just AF_SNA -> Just 22 {-# LINE 1158 "Network/Socket.hsc" #-} {-# LINE 1159 "Network/Socket.hsc" #-} {-# LINE 1160 "Network/Socket.hsc" #-} Just AF_DECnet -> Just 12 {-# LINE 1161 "Network/Socket.hsc" #-} {-# LINE 1162 "Network/Socket.hsc" #-} {-# LINE 1165 "Network/Socket.hsc" #-} {-# LINE 1168 "Network/Socket.hsc" #-} {-# LINE 1171 "Network/Socket.hsc" #-} {-# LINE 1172 "Network/Socket.hsc" #-} Just AF_APPLETALK -> Just 5 {-# LINE 1173 "Network/Socket.hsc" #-} {-# LINE 1174 "Network/Socket.hsc" #-} {-# LINE 1175 "Network/Socket.hsc" #-} Just AF_ROUTE -> Just 16 {-# LINE 1176 "Network/Socket.hsc" #-} {-# LINE 1177 "Network/Socket.hsc" #-} {-# LINE 1180 "Network/Socket.hsc" #-} {-# LINE 1183 "Network/Socket.hsc" #-} {-# LINE 1186 "Network/Socket.hsc" #-} {-# LINE 1189 "Network/Socket.hsc" #-} {-# LINE 1192 "Network/Socket.hsc" #-} {-# LINE 1195 "Network/Socket.hsc" #-} {-# LINE 1196 "Network/Socket.hsc" #-} Just AF_X25 -> Just 9 {-# LINE 1197 "Network/Socket.hsc" #-} {-# LINE 1198 "Network/Socket.hsc" #-} {-# LINE 1199 "Network/Socket.hsc" #-} Just AF_AX25 -> Just 3 {-# LINE 1200 "Network/Socket.hsc" #-} {-# LINE 1201 "Network/Socket.hsc" #-} {-# LINE 1204 "Network/Socket.hsc" #-} {-# LINE 1207 "Network/Socket.hsc" #-} {-# LINE 1208 "Network/Socket.hsc" #-} Just AF_IPX -> Just 4 {-# LINE 1209 "Network/Socket.hsc" #-} {-# LINE 1210 "Network/Socket.hsc" #-} {-# LINE 1213 "Network/Socket.hsc" #-} {-# LINE 1216 "Network/Socket.hsc" #-} {-# LINE 1219 "Network/Socket.hsc" #-} {-# LINE 1222 "Network/Socket.hsc" #-} {-# LINE 1225 "Network/Socket.hsc" #-} {-# LINE 1228 "Network/Socket.hsc" #-} {-# LINE 1231 "Network/Socket.hsc" #-} {-# LINE 1234 "Network/Socket.hsc" #-} {-# LINE 1237 "Network/Socket.hsc" #-} {-# LINE 1240 "Network/Socket.hsc" #-} {-# LINE 1243 "Network/Socket.hsc" #-} {-# LINE 1246 "Network/Socket.hsc" #-} {-# LINE 1247 "Network/Socket.hsc" #-} Just AF_ISDN -> Just 34 {-# LINE 1248 "Network/Socket.hsc" #-} {-# LINE 1249 "Network/Socket.hsc" #-} {-# LINE 1252 "Network/Socket.hsc" #-} {-# LINE 1255 "Network/Socket.hsc" #-} {-# LINE 1258 "Network/Socket.hsc" #-} {-# LINE 1261 "Network/Socket.hsc" #-} {-# LINE 1264 "Network/Socket.hsc" #-} {-# LINE 1267 "Network/Socket.hsc" #-} {-# LINE 1270 "Network/Socket.hsc" #-} {-# LINE 1273 "Network/Socket.hsc" #-} {-# LINE 1274 "Network/Socket.hsc" #-} Just AF_NETROM -> Just 6 {-# LINE 1275 "Network/Socket.hsc" #-} {-# LINE 1276 "Network/Socket.hsc" #-} {-# LINE 1277 "Network/Socket.hsc" #-} Just AF_BRIDGE -> Just 7 {-# LINE 1278 "Network/Socket.hsc" #-} {-# LINE 1279 "Network/Socket.hsc" #-} {-# LINE 1280 "Network/Socket.hsc" #-} Just AF_ATMPVC -> Just 8 {-# LINE 1281 "Network/Socket.hsc" #-} {-# LINE 1282 "Network/Socket.hsc" #-} {-# LINE 1283 "Network/Socket.hsc" #-} Just AF_ROSE -> Just 11 {-# LINE 1284 "Network/Socket.hsc" #-} {-# LINE 1285 "Network/Socket.hsc" #-} {-# LINE 1286 "Network/Socket.hsc" #-} Just AF_NETBEUI -> Just 13 {-# LINE 1287 "Network/Socket.hsc" #-} {-# LINE 1288 "Network/Socket.hsc" #-} {-# LINE 1289 "Network/Socket.hsc" #-} Just AF_SECURITY -> Just 14 {-# LINE 1290 "Network/Socket.hsc" #-} {-# LINE 1291 "Network/Socket.hsc" #-} {-# LINE 1292 "Network/Socket.hsc" #-} Just AF_PACKET -> Just 17 {-# LINE 1293 "Network/Socket.hsc" #-} {-# LINE 1294 "Network/Socket.hsc" #-} {-# LINE 1295 "Network/Socket.hsc" #-} Just AF_ASH -> Just 18 {-# LINE 1296 "Network/Socket.hsc" #-} {-# LINE 1297 "Network/Socket.hsc" #-} {-# LINE 1298 "Network/Socket.hsc" #-} Just AF_ECONET -> Just 19 {-# LINE 1299 "Network/Socket.hsc" #-} {-# LINE 1300 "Network/Socket.hsc" #-} {-# LINE 1301 "Network/Socket.hsc" #-} Just AF_ATMSVC -> Just 20 {-# LINE 1302 "Network/Socket.hsc" #-} {-# LINE 1303 "Network/Socket.hsc" #-} {-# LINE 1304 "Network/Socket.hsc" #-} Just AF_IRDA -> Just 23 {-# LINE 1305 "Network/Socket.hsc" #-} {-# LINE 1306 "Network/Socket.hsc" #-} {-# LINE 1307 "Network/Socket.hsc" #-} Just AF_PPPOX -> Just 24 {-# LINE 1308 "Network/Socket.hsc" #-} {-# LINE 1309 "Network/Socket.hsc" #-} {-# LINE 1310 "Network/Socket.hsc" #-} Just AF_WANPIPE -> Just 25 {-# LINE 1311 "Network/Socket.hsc" #-} {-# LINE 1312 "Network/Socket.hsc" #-} {-# LINE 1313 "Network/Socket.hsc" #-} Just AF_BLUETOOTH -> Just 31 {-# LINE 1314 "Network/Socket.hsc" #-} {-# LINE 1315 "Network/Socket.hsc" #-} _ -> Nothing --------- ---------- unpackFamily :: CInt -> Family unpackFamily f = case f of (0) -> AF_UNSPEC {-# LINE 1322 "Network/Socket.hsc" #-} {-# LINE 1323 "Network/Socket.hsc" #-} (1) -> AF_UNIX {-# LINE 1324 "Network/Socket.hsc" #-} {-# LINE 1325 "Network/Socket.hsc" #-} {-# LINE 1326 "Network/Socket.hsc" #-} (2) -> AF_INET {-# LINE 1327 "Network/Socket.hsc" #-} {-# LINE 1328 "Network/Socket.hsc" #-} {-# LINE 1329 "Network/Socket.hsc" #-} (10) -> AF_INET6 {-# LINE 1330 "Network/Socket.hsc" #-} {-# LINE 1331 "Network/Socket.hsc" #-} {-# LINE 1334 "Network/Socket.hsc" #-} {-# LINE 1337 "Network/Socket.hsc" #-} {-# LINE 1340 "Network/Socket.hsc" #-} {-# LINE 1343 "Network/Socket.hsc" #-} {-# LINE 1346 "Network/Socket.hsc" #-} {-# LINE 1349 "Network/Socket.hsc" #-} {-# LINE 1352 "Network/Socket.hsc" #-} {-# LINE 1355 "Network/Socket.hsc" #-} {-# LINE 1356 "Network/Socket.hsc" #-} (22) -> AF_SNA {-# LINE 1357 "Network/Socket.hsc" #-} {-# LINE 1358 "Network/Socket.hsc" #-} {-# LINE 1359 "Network/Socket.hsc" #-} (12) -> AF_DECnet {-# LINE 1360 "Network/Socket.hsc" #-} {-# LINE 1361 "Network/Socket.hsc" #-} {-# LINE 1364 "Network/Socket.hsc" #-} {-# LINE 1367 "Network/Socket.hsc" #-} {-# LINE 1370 "Network/Socket.hsc" #-} {-# LINE 1371 "Network/Socket.hsc" #-} (5) -> AF_APPLETALK {-# LINE 1372 "Network/Socket.hsc" #-} {-# LINE 1373 "Network/Socket.hsc" #-} {-# LINE 1374 "Network/Socket.hsc" #-} (16) -> AF_ROUTE {-# LINE 1375 "Network/Socket.hsc" #-} {-# LINE 1376 "Network/Socket.hsc" #-} {-# LINE 1379 "Network/Socket.hsc" #-} {-# LINE 1382 "Network/Socket.hsc" #-} {-# LINE 1385 "Network/Socket.hsc" #-} {-# LINE 1388 "Network/Socket.hsc" #-} {-# LINE 1393 "Network/Socket.hsc" #-} {-# LINE 1396 "Network/Socket.hsc" #-} {-# LINE 1397 "Network/Socket.hsc" #-} (9) -> AF_X25 {-# LINE 1398 "Network/Socket.hsc" #-} {-# LINE 1399 "Network/Socket.hsc" #-} {-# LINE 1400 "Network/Socket.hsc" #-} (3) -> AF_AX25 {-# LINE 1401 "Network/Socket.hsc" #-} {-# LINE 1402 "Network/Socket.hsc" #-} {-# LINE 1405 "Network/Socket.hsc" #-} {-# LINE 1408 "Network/Socket.hsc" #-} {-# LINE 1409 "Network/Socket.hsc" #-} (4) -> AF_IPX {-# LINE 1410 "Network/Socket.hsc" #-} {-# LINE 1411 "Network/Socket.hsc" #-} {-# LINE 1414 "Network/Socket.hsc" #-} {-# LINE 1417 "Network/Socket.hsc" #-} {-# LINE 1420 "Network/Socket.hsc" #-} {-# LINE 1423 "Network/Socket.hsc" #-} {-# LINE 1426 "Network/Socket.hsc" #-} {-# LINE 1429 "Network/Socket.hsc" #-} {-# LINE 1432 "Network/Socket.hsc" #-} {-# LINE 1435 "Network/Socket.hsc" #-} {-# LINE 1438 "Network/Socket.hsc" #-} {-# LINE 1441 "Network/Socket.hsc" #-} {-# LINE 1444 "Network/Socket.hsc" #-} {-# LINE 1447 "Network/Socket.hsc" #-} {-# LINE 1448 "Network/Socket.hsc" #-} (34) -> AF_ISDN {-# LINE 1449 "Network/Socket.hsc" #-} {-# LINE 1450 "Network/Socket.hsc" #-} {-# LINE 1453 "Network/Socket.hsc" #-} {-# LINE 1456 "Network/Socket.hsc" #-} {-# LINE 1459 "Network/Socket.hsc" #-} {-# LINE 1462 "Network/Socket.hsc" #-} {-# LINE 1465 "Network/Socket.hsc" #-} {-# LINE 1468 "Network/Socket.hsc" #-} {-# LINE 1471 "Network/Socket.hsc" #-} {-# LINE 1474 "Network/Socket.hsc" #-} {-# LINE 1475 "Network/Socket.hsc" #-} (6) -> AF_NETROM {-# LINE 1476 "Network/Socket.hsc" #-} {-# LINE 1477 "Network/Socket.hsc" #-} {-# LINE 1478 "Network/Socket.hsc" #-} (7) -> AF_BRIDGE {-# LINE 1479 "Network/Socket.hsc" #-} {-# LINE 1480 "Network/Socket.hsc" #-} {-# LINE 1481 "Network/Socket.hsc" #-} (8) -> AF_ATMPVC {-# LINE 1482 "Network/Socket.hsc" #-} {-# LINE 1483 "Network/Socket.hsc" #-} {-# LINE 1484 "Network/Socket.hsc" #-} (11) -> AF_ROSE {-# LINE 1485 "Network/Socket.hsc" #-} {-# LINE 1486 "Network/Socket.hsc" #-} {-# LINE 1487 "Network/Socket.hsc" #-} (13) -> AF_NETBEUI {-# LINE 1488 "Network/Socket.hsc" #-} {-# LINE 1489 "Network/Socket.hsc" #-} {-# LINE 1490 "Network/Socket.hsc" #-} (14) -> AF_SECURITY {-# LINE 1491 "Network/Socket.hsc" #-} {-# LINE 1492 "Network/Socket.hsc" #-} {-# LINE 1493 "Network/Socket.hsc" #-} (17) -> AF_PACKET {-# LINE 1494 "Network/Socket.hsc" #-} {-# LINE 1495 "Network/Socket.hsc" #-} {-# LINE 1496 "Network/Socket.hsc" #-} (18) -> AF_ASH {-# LINE 1497 "Network/Socket.hsc" #-} {-# LINE 1498 "Network/Socket.hsc" #-} {-# LINE 1499 "Network/Socket.hsc" #-} (19) -> AF_ECONET {-# LINE 1500 "Network/Socket.hsc" #-} {-# LINE 1501 "Network/Socket.hsc" #-} {-# LINE 1502 "Network/Socket.hsc" #-} (20) -> AF_ATMSVC {-# LINE 1503 "Network/Socket.hsc" #-} {-# LINE 1504 "Network/Socket.hsc" #-} {-# LINE 1505 "Network/Socket.hsc" #-} (23) -> AF_IRDA {-# LINE 1506 "Network/Socket.hsc" #-} {-# LINE 1507 "Network/Socket.hsc" #-} {-# LINE 1508 "Network/Socket.hsc" #-} (24) -> AF_PPPOX {-# LINE 1509 "Network/Socket.hsc" #-} {-# LINE 1510 "Network/Socket.hsc" #-} {-# LINE 1511 "Network/Socket.hsc" #-} (25) -> AF_WANPIPE {-# LINE 1512 "Network/Socket.hsc" #-} {-# LINE 1513 "Network/Socket.hsc" #-} {-# LINE 1514 "Network/Socket.hsc" #-} (31) -> AF_BLUETOOTH {-# LINE 1515 "Network/Socket.hsc" #-} {-# LINE 1516 "Network/Socket.hsc" #-} unknown -> error ("Network.Socket.unpackFamily: unknown address " ++ "family " ++ show unknown) -- Socket Types. -- | Socket Types. -- -- The existence of a constructor does not necessarily imply that that -- socket type is supported on your system: see 'isSupportedSocketType'. data SocketType = NoSocketType -- ^ 0, used in getAddrInfo hints, for example | Stream -- ^ SOCK_STREAM | Datagram -- ^ SOCK_DGRAM | Raw -- ^ SOCK_RAW | RDM -- ^ SOCK_RDM | SeqPacket -- ^ SOCK_SEQPACKET deriving (Eq, Ord, Read, Show, Typeable) -- | Does the SOCK_ constant corresponding to the given SocketType exist on -- this system? isSupportedSocketType :: SocketType -> Bool isSupportedSocketType = isJust . packSocketType' -- | Find the SOCK_ constant corresponding to the SocketType value. packSocketType' :: SocketType -> Maybe CInt packSocketType' stype = case Just stype of -- the Just above is to disable GHC's overlapping pattern -- detection: see comments for packSocketOption Just NoSocketType -> Just 0 {-# LINE 1546 "Network/Socket.hsc" #-} Just Stream -> Just 1 {-# LINE 1547 "Network/Socket.hsc" #-} {-# LINE 1548 "Network/Socket.hsc" #-} {-# LINE 1549 "Network/Socket.hsc" #-} Just Datagram -> Just 2 {-# LINE 1550 "Network/Socket.hsc" #-} {-# LINE 1551 "Network/Socket.hsc" #-} {-# LINE 1552 "Network/Socket.hsc" #-} Just Raw -> Just 3 {-# LINE 1553 "Network/Socket.hsc" #-} {-# LINE 1554 "Network/Socket.hsc" #-} {-# LINE 1555 "Network/Socket.hsc" #-} Just RDM -> Just 4 {-# LINE 1556 "Network/Socket.hsc" #-} {-# LINE 1557 "Network/Socket.hsc" #-} {-# LINE 1558 "Network/Socket.hsc" #-} Just SeqPacket -> Just 5 {-# LINE 1559 "Network/Socket.hsc" #-} {-# LINE 1560 "Network/Socket.hsc" #-} _ -> Nothing packSocketType :: SocketType -> CInt packSocketType stype = fromMaybe (error errMsg) (packSocketType' stype) where errMsg = concat ["Network.Socket.packSocketType: ", "socket type ", show stype, " unsupported on this system"] -- | Try packSocketType' on the SocketType, if it fails throw an error with -- message starting "Network.Socket." ++ the String parameter packSocketTypeOrThrow :: String -> SocketType -> IO CInt packSocketTypeOrThrow caller stype = maybe err return (packSocketType' stype) where err = ioError . userError . concat $ ["Network.Socket.", caller, ": ", "socket type ", show stype, " unsupported on this system"] unpackSocketType:: CInt -> Maybe SocketType unpackSocketType t = case t of 0 -> Just NoSocketType {-# LINE 1581 "Network/Socket.hsc" #-} (1) -> Just Stream {-# LINE 1582 "Network/Socket.hsc" #-} {-# LINE 1583 "Network/Socket.hsc" #-} {-# LINE 1584 "Network/Socket.hsc" #-} (2) -> Just Datagram {-# LINE 1585 "Network/Socket.hsc" #-} {-# LINE 1586 "Network/Socket.hsc" #-} {-# LINE 1587 "Network/Socket.hsc" #-} (3) -> Just Raw {-# LINE 1588 "Network/Socket.hsc" #-} {-# LINE 1589 "Network/Socket.hsc" #-} {-# LINE 1590 "Network/Socket.hsc" #-} (4) -> Just RDM {-# LINE 1591 "Network/Socket.hsc" #-} {-# LINE 1592 "Network/Socket.hsc" #-} {-# LINE 1593 "Network/Socket.hsc" #-} (5) -> Just SeqPacket {-# LINE 1594 "Network/Socket.hsc" #-} {-# LINE 1595 "Network/Socket.hsc" #-} _ -> Nothing -- | Try unpackSocketType on the CInt, if it fails throw an error with -- message starting "Network.Socket." ++ the String parameter unpackSocketType' :: String -> CInt -> IO SocketType unpackSocketType' caller ty = maybe err return (unpackSocketType ty) where err = ioError . userError . concat $ ["Network.Socket.", caller, ": ", "socket type ", show ty, " unsupported on this system"] -- --------------------------------------------------------------------------- -- Utility Functions aNY_PORT :: PortNumber aNY_PORT = 0 -- | The IPv4 wild card address. iNADDR_ANY :: HostAddress iNADDR_ANY = htonl (0) {-# LINE 1616 "Network/Socket.hsc" #-} {-# LINE 1618 "Network/Socket.hsc" #-} -- | The IPv6 wild card address. iN6ADDR_ANY :: HostAddress6 iN6ADDR_ANY = (0, 0, 0, 0) {-# LINE 1623 "Network/Socket.hsc" #-} sOMAXCONN :: Int sOMAXCONN = 128 {-# LINE 1626 "Network/Socket.hsc" #-} sOL_SOCKET :: Int sOL_SOCKET = 1 {-# LINE 1629 "Network/Socket.hsc" #-} {-# LINE 1631 "Network/Socket.hsc" #-} sCM_RIGHTS :: Int sCM_RIGHTS = 1 {-# LINE 1633 "Network/Socket.hsc" #-} {-# LINE 1634 "Network/Socket.hsc" #-} maxListenQueue :: Int maxListenQueue = sOMAXCONN -- ----------------------------------------------------------------------------- data ShutdownCmd = ShutdownReceive | ShutdownSend | ShutdownBoth deriving Typeable sdownCmdToInt :: ShutdownCmd -> CInt sdownCmdToInt ShutdownReceive = 0 sdownCmdToInt ShutdownSend = 1 sdownCmdToInt ShutdownBoth = 2 -- | Shut down one or both halves of the connection, depending on the -- second argument to the function. If the second argument is -- 'ShutdownReceive', further receives are disallowed. If it is -- 'ShutdownSend', further sends are disallowed. If it is -- 'ShutdownBoth', further sends and receives are disallowed. shutdown :: Socket -> ShutdownCmd -> IO () shutdown (MkSocket s _ _ _ _) stype = do throwSocketErrorIfMinus1Retry "shutdown" (c_shutdown s (sdownCmdToInt stype)) return () -- ----------------------------------------------------------------------------- -- | Close the socket. All future operations on the socket object -- will fail. The remote end will receive no more data (after queued -- data is flushed). close :: Socket -> IO () close (MkSocket s _ _ _ socketStatus) = do modifyMVar_ socketStatus $ \ status -> case status of ConvertedToHandle -> ioError (userError ("close: converted to a Handle, use hClose instead")) Closed -> return status _ -> closeFdWith (closeFd . fromIntegral) (fromIntegral s) >> return Closed -- ----------------------------------------------------------------------------- isConnected :: Socket -> IO Bool isConnected (MkSocket _ _ _ _ status) = do value <- readMVar status return (value == Connected) -- ----------------------------------------------------------------------------- -- Socket Predicates isBound :: Socket -> IO Bool isBound (MkSocket _ _ _ _ status) = do value <- readMVar status return (value == Bound) isListening :: Socket -> IO Bool isListening (MkSocket _ _ _ _ status) = do value <- readMVar status return (value == Listening) isReadable :: Socket -> IO Bool isReadable (MkSocket _ _ _ _ status) = do value <- readMVar status return (value == Listening || value == Connected) isWritable :: Socket -> IO Bool isWritable = isReadable -- sort of. isAcceptable :: Socket -> IO Bool {-# LINE 1706 "Network/Socket.hsc" #-} isAcceptable (MkSocket _ AF_UNIX x _ status) | x == Stream || x == SeqPacket = do value <- readMVar status return (value == Connected || value == Bound || value == Listening) isAcceptable (MkSocket _ AF_UNIX _ _ _) = return False {-# LINE 1712 "Network/Socket.hsc" #-} isAcceptable (MkSocket _ _ _ _ status) = do value <- readMVar status return (value == Connected || value == Listening) -- ----------------------------------------------------------------------------- -- Internet address manipulation routines: inet_addr :: String -> IO HostAddress inet_addr ipstr = do withCString ipstr $ \str -> do had <- c_inet_addr str if had == -1 then ioError (userError ("inet_addr: Malformed address: " ++ ipstr)) else return had -- network byte order inet_ntoa :: HostAddress -> IO String inet_ntoa haddr = do pstr <- c_inet_ntoa haddr peekCString pstr -- | Turns a Socket into an 'Handle'. By default, the new handle is -- unbuffered. Use 'System.IO.hSetBuffering' to change the buffering. -- -- Note that since a 'Handle' is automatically closed by a finalizer -- when it is no longer referenced, you should avoid doing any more -- operations on the 'Socket' after calling 'socketToHandle'. To -- close the 'Socket' after 'socketToHandle', call 'System.IO.hClose' -- on the 'Handle'. {-# LINE 1742 "Network/Socket.hsc" #-} socketToHandle :: Socket -> IOMode -> IO Handle socketToHandle s@(MkSocket fd _ _ _ socketStatus) mode = do modifyMVar socketStatus $ \ status -> if status == ConvertedToHandle then ioError (userError ("socketToHandle: already a Handle")) else do {-# LINE 1749 "Network/Socket.hsc" #-} h <- fdToHandle' (fromIntegral fd) (Just GHC.IO.Device.Stream) True (show s) mode True{-bin-} {-# LINE 1757 "Network/Socket.hsc" #-} hSetBuffering h NoBuffering return (ConvertedToHandle, h) {-# LINE 1763 "Network/Socket.hsc" #-} -- | Pack a list of values into a bitmask. The possible mappings from -- value to bit-to-set are given as the first argument. We assume -- that each value can cause exactly one bit to be set; unpackBits will -- break if this property is not true. packBits :: (Eq a, Num b, Bits b) => [(a, b)] -> [a] -> b packBits mapping xs = foldl' pack 0 mapping where pack acc (k, v) | k `elem` xs = acc .|. v | otherwise = acc -- | Unpack a bitmask into a list of values. unpackBits :: (Num b, Bits b) => [(a, b)] -> b -> [a] -- Be permissive and ignore unknown bit values. At least on OS X, -- getaddrinfo returns an ai_flags field with bits set that have no -- entry in <netdb.h>. unpackBits [] _ = [] unpackBits ((k,v):xs) r | r .&. v /= 0 = k : unpackBits xs (r .&. complement v) | otherwise = unpackBits xs r ----------------------------------------------------------------------------- -- Address and service lookups {-# LINE 1791 "Network/Socket.hsc" #-} -- | Flags that control the querying behaviour of 'getAddrInfo'. data AddrInfoFlag = AI_ADDRCONFIG | AI_ALL | AI_CANONNAME | AI_NUMERICHOST | AI_NUMERICSERV | AI_PASSIVE | AI_V4MAPPED deriving (Eq, Read, Show, Typeable) aiFlagMapping :: [(AddrInfoFlag, CInt)] aiFlagMapping = [ {-# LINE 1808 "Network/Socket.hsc" #-} (AI_ADDRCONFIG, 32), {-# LINE 1809 "Network/Socket.hsc" #-} {-# LINE 1812 "Network/Socket.hsc" #-} {-# LINE 1813 "Network/Socket.hsc" #-} (AI_ALL, 16), {-# LINE 1814 "Network/Socket.hsc" #-} {-# LINE 1817 "Network/Socket.hsc" #-} (AI_CANONNAME, 2), {-# LINE 1818 "Network/Socket.hsc" #-} (AI_NUMERICHOST, 4), {-# LINE 1819 "Network/Socket.hsc" #-} {-# LINE 1820 "Network/Socket.hsc" #-} (AI_NUMERICSERV, 1024), {-# LINE 1821 "Network/Socket.hsc" #-} {-# LINE 1824 "Network/Socket.hsc" #-} (AI_PASSIVE, 1), {-# LINE 1825 "Network/Socket.hsc" #-} {-# LINE 1826 "Network/Socket.hsc" #-} (AI_V4MAPPED, 8) {-# LINE 1827 "Network/Socket.hsc" #-} {-# LINE 1830 "Network/Socket.hsc" #-} ] -- | Indicate whether the given 'AddrInfoFlag' will have any effect on -- this system. addrInfoFlagImplemented :: AddrInfoFlag -> Bool addrInfoFlagImplemented f = packBits aiFlagMapping [f] /= 0 data AddrInfo = AddrInfo { addrFlags :: [AddrInfoFlag], addrFamily :: Family, addrSocketType :: SocketType, addrProtocol :: ProtocolNumber, addrAddress :: SockAddr, addrCanonName :: Maybe String } deriving (Eq, Show, Typeable) instance Storable AddrInfo where sizeOf _ = 32 {-# LINE 1850 "Network/Socket.hsc" #-} alignment _ = alignment (undefined :: CInt) peek p = do ai_flags <- ((\hsc_ptr -> peekByteOff hsc_ptr 0)) p {-# LINE 1854 "Network/Socket.hsc" #-} ai_family <- ((\hsc_ptr -> peekByteOff hsc_ptr 4)) p {-# LINE 1855 "Network/Socket.hsc" #-} ai_socktype <- ((\hsc_ptr -> peekByteOff hsc_ptr 8)) p {-# LINE 1856 "Network/Socket.hsc" #-} ai_protocol <- ((\hsc_ptr -> peekByteOff hsc_ptr 12)) p {-# LINE 1857 "Network/Socket.hsc" #-} ai_addr <- ((\hsc_ptr -> peekByteOff hsc_ptr 20)) p >>= peekSockAddr {-# LINE 1858 "Network/Socket.hsc" #-} ai_canonname_ptr <- ((\hsc_ptr -> peekByteOff hsc_ptr 24)) p {-# LINE 1859 "Network/Socket.hsc" #-} ai_canonname <- if ai_canonname_ptr == nullPtr then return Nothing else liftM Just $ peekCString ai_canonname_ptr socktype <- unpackSocketType' "AddrInfo.peek" ai_socktype return (AddrInfo { addrFlags = unpackBits aiFlagMapping ai_flags, addrFamily = unpackFamily ai_family, addrSocketType = socktype, addrProtocol = ai_protocol, addrAddress = ai_addr, addrCanonName = ai_canonname }) poke p (AddrInfo flags family socketType protocol _ _) = do c_stype <- packSocketTypeOrThrow "AddrInfo.poke" socketType ((\hsc_ptr -> pokeByteOff hsc_ptr 0)) p (packBits aiFlagMapping flags) {-# LINE 1879 "Network/Socket.hsc" #-} ((\hsc_ptr -> pokeByteOff hsc_ptr 4)) p (packFamily family) {-# LINE 1880 "Network/Socket.hsc" #-} ((\hsc_ptr -> pokeByteOff hsc_ptr 8)) p c_stype {-# LINE 1881 "Network/Socket.hsc" #-} ((\hsc_ptr -> pokeByteOff hsc_ptr 12)) p protocol {-# LINE 1882 "Network/Socket.hsc" #-} -- stuff below is probably not needed, but let's zero it for safety ((\hsc_ptr -> pokeByteOff hsc_ptr 16)) p (0::CSize) {-# LINE 1886 "Network/Socket.hsc" #-} ((\hsc_ptr -> pokeByteOff hsc_ptr 20)) p nullPtr {-# LINE 1887 "Network/Socket.hsc" #-} ((\hsc_ptr -> pokeByteOff hsc_ptr 24)) p nullPtr {-# LINE 1888 "Network/Socket.hsc" #-} ((\hsc_ptr -> pokeByteOff hsc_ptr 28)) p nullPtr {-# LINE 1889 "Network/Socket.hsc" #-} data NameInfoFlag = NI_DGRAM | NI_NAMEREQD | NI_NOFQDN | NI_NUMERICHOST | NI_NUMERICSERV deriving (Eq, Read, Show, Typeable) niFlagMapping :: [(NameInfoFlag, CInt)] niFlagMapping = [(NI_DGRAM, 16), {-# LINE 1901 "Network/Socket.hsc" #-} (NI_NAMEREQD, 8), {-# LINE 1902 "Network/Socket.hsc" #-} (NI_NOFQDN, 4), {-# LINE 1903 "Network/Socket.hsc" #-} (NI_NUMERICHOST, 1), {-# LINE 1904 "Network/Socket.hsc" #-} (NI_NUMERICSERV, 2)] {-# LINE 1905 "Network/Socket.hsc" #-} -- | Default hints for address lookup with 'getAddrInfo'. The values -- of the 'addrAddress' and 'addrCanonName' fields are 'undefined', -- and are never inspected by 'getAddrInfo'. defaultHints :: AddrInfo defaultHints = AddrInfo { addrFlags = [], addrFamily = AF_UNSPEC, addrSocketType = NoSocketType, addrProtocol = defaultProtocol, addrAddress = undefined, addrCanonName = undefined } -- | Resolve a host or service name to one or more addresses. -- The 'AddrInfo' values that this function returns contain 'SockAddr' -- values that you can pass directly to 'connect' or -- 'bind'. -- -- This function is protocol independent. It can return both IPv4 and -- IPv6 address information. -- -- The 'AddrInfo' argument specifies the preferred query behaviour, -- socket options, or protocol. You can override these conveniently -- using Haskell's record update syntax on 'defaultHints', for example -- as follows: -- -- @ -- myHints = defaultHints { addrFlags = [AI_ADDRCONFIG, AI_CANONNAME] } -- @ -- -- Values for 'addrFlags' control query behaviour. The supported -- flags are as follows: -- -- [@AI_PASSIVE@] If no 'HostName' value is provided, the network -- address in each 'SockAddr' -- will be left as a "wild card", i.e. as either 'iNADDR_ANY' -- or 'iN6ADDR_ANY'. This is useful for server applications that -- will accept connections from any client. -- -- [@AI_CANONNAME@] The 'addrCanonName' field of the first returned -- 'AddrInfo' will contain the "canonical name" of the host. -- -- [@AI_NUMERICHOST@] The 'HostName' argument /must/ be a numeric -- address in string form, and network name lookups will not be -- attempted. -- -- /Note/: Although the following flags are required by RFC 3493, they -- may not have an effect on all platforms, because the underlying -- network stack may not support them. To see whether a flag from the -- list below will have any effect, call 'addrInfoFlagImplemented'. -- -- [@AI_NUMERICSERV@] The 'ServiceName' argument /must/ be a port -- number in string form, and service name lookups will not be -- attempted. -- -- [@AI_ADDRCONFIG@] The list of returned 'AddrInfo' values will -- only contain IPv4 addresses if the local system has at least -- one IPv4 interface configured, and likewise for IPv6. -- -- [@AI_V4MAPPED@] If an IPv6 lookup is performed, and no IPv6 -- addresses are found, IPv6-mapped IPv4 addresses will be -- returned. -- -- [@AI_ALL@] If 'AI_ALL' is specified, return all matching IPv6 and -- IPv4 addresses. Otherwise, this flag has no effect. -- -- You must provide a 'Just' value for at least one of the 'HostName' -- or 'ServiceName' arguments. 'HostName' can be either a numeric -- network address (dotted quad for IPv4, colon-separated hex for -- IPv6) or a hostname. In the latter case, its addresses will be -- looked up unless 'AI_NUMERICHOST' is specified as a hint. If you -- do not provide a 'HostName' value /and/ do not set 'AI_PASSIVE' as -- a hint, network addresses in the result will contain the address of -- the loopback interface. -- -- If the query fails, this function throws an IO exception instead of -- returning an empty list. Otherwise, it returns a non-empty list -- of 'AddrInfo' values. -- -- There are several reasons why a query might result in several -- values. For example, the queried-for host could be multihomed, or -- the service might be available via several protocols. -- -- Note: the order of arguments is slightly different to that defined -- for @getaddrinfo@ in RFC 2553. The 'AddrInfo' parameter comes first -- to make partial application easier. -- -- Example: -- @ -- let hints = defaultHints { addrFlags = [AI_ADDRCONFIG, AI_CANONNAME] } -- addrs <- getAddrInfo (Just hints) (Just "www.haskell.org") (Just "http") -- let addr = head addrs -- sock <- socket (addrFamily addr) (addrSocketType addr) (addrProtocol addr) -- connect sock (addrAddress addr) -- @ getAddrInfo :: Maybe AddrInfo -- ^ preferred socket type or protocol -> Maybe HostName -- ^ host name to look up -> Maybe ServiceName -- ^ service name to look up -> IO [AddrInfo] -- ^ resolved addresses, with "best" first getAddrInfo hints node service = maybeWith withCString node $ \c_node -> maybeWith withCString service $ \c_service -> maybeWith with hints $ \c_hints -> alloca $ \ptr_ptr_addrs -> do ret <- c_getaddrinfo c_node c_service c_hints ptr_ptr_addrs case ret of 0 -> do ptr_addrs <- peek ptr_ptr_addrs ais <- followAddrInfo ptr_addrs c_freeaddrinfo ptr_addrs return ais _ -> do err <- gai_strerror ret ioError (ioeSetErrorString (mkIOError NoSuchThing "getAddrInfo" Nothing Nothing) err) followAddrInfo :: Ptr AddrInfo -> IO [AddrInfo] followAddrInfo ptr_ai | ptr_ai == nullPtr = return [] | otherwise = do a <- peek ptr_ai as <- ((\hsc_ptr -> peekByteOff hsc_ptr 28)) ptr_ai >>= followAddrInfo {-# LINE 2031 "Network/Socket.hsc" #-} return (a:as) foreign import ccall safe "hsnet_getaddrinfo" c_getaddrinfo :: CString -> CString -> Ptr AddrInfo -> Ptr (Ptr AddrInfo) -> IO CInt foreign import ccall safe "hsnet_freeaddrinfo" c_freeaddrinfo :: Ptr AddrInfo -> IO () gai_strerror :: CInt -> IO String {-# LINE 2043 "Network/Socket.hsc" #-} gai_strerror n = c_gai_strerror n >>= peekCString foreign import ccall safe "gai_strerror" c_gai_strerror :: CInt -> IO CString {-# LINE 2050 "Network/Socket.hsc" #-} withCStringIf :: Bool -> Int -> (CSize -> CString -> IO a) -> IO a withCStringIf False _ f = f 0 nullPtr withCStringIf True n f = allocaBytes n (f (fromIntegral n)) -- | Resolve an address to a host or service name. -- This function is protocol independent. -- -- The list of 'NameInfoFlag' values controls query behaviour. The -- supported flags are as follows: -- -- [@NI_NOFQDN@] If a host is local, return only the -- hostname part of the FQDN. -- -- [@NI_NUMERICHOST@] The name of the host is not -- looked up. Instead, a numeric representation of the host's -- address is returned. For an IPv4 address, this will be a -- dotted-quad string. For IPv6, it will be colon-separated -- hexadecimal. -- -- [@NI_NUMERICSERV@] The name of the service is not -- looked up. Instead, a numeric representation of the -- service is returned. -- -- [@NI_NAMEREQD@] If the hostname cannot be looked up, an IO error -- is thrown. -- -- [@NI_DGRAM@] Resolve a datagram-based service name. This is -- required only for the few protocols that have different port -- numbers for their datagram-based versions than for their -- stream-based versions. -- -- Hostname and service name lookups can be expensive. You can -- specify which lookups to perform via the two 'Bool' arguments. If -- one of these is 'False', the corresponding value in the returned -- tuple will be 'Nothing', and no lookup will be performed. -- -- If a host or service's name cannot be looked up, then the numeric -- form of the address or service will be returned. -- -- If the query fails, this function throws an IO exception. -- -- Example: -- @ -- (hostName, _) <- getNameInfo [] True False myAddress -- @ getNameInfo :: [NameInfoFlag] -- ^ flags to control lookup behaviour -> Bool -- ^ whether to look up a hostname -> Bool -- ^ whether to look up a service name -> SockAddr -- ^ the address to look up -> IO (Maybe HostName, Maybe ServiceName) getNameInfo flags doHost doService addr = withCStringIf doHost (1025) $ \c_hostlen c_host -> {-# LINE 2105 "Network/Socket.hsc" #-} withCStringIf doService (32) $ \c_servlen c_serv -> do {-# LINE 2106 "Network/Socket.hsc" #-} withSockAddr addr $ \ptr_addr sz -> do ret <- c_getnameinfo ptr_addr (fromIntegral sz) c_host c_hostlen c_serv c_servlen (packBits niFlagMapping flags) case ret of 0 -> do let peekIf doIf c_val = if doIf then liftM Just $ peekCString c_val else return Nothing host <- peekIf doHost c_host serv <- peekIf doService c_serv return (host, serv) _ -> do err <- gai_strerror ret ioError (ioeSetErrorString (mkIOError NoSuchThing "getNameInfo" Nothing Nothing) err) foreign import ccall safe "hsnet_getnameinfo" c_getnameinfo :: Ptr SockAddr -> CInt{-CSockLen???-} -> CString -> CSize -> CString -> CSize -> CInt -> IO CInt {-# LINE 2126 "Network/Socket.hsc" #-} mkInvalidRecvArgError :: String -> IOError mkInvalidRecvArgError loc = ioeSetErrorString (mkIOError {-# LINE 2130 "Network/Socket.hsc" #-} InvalidArgument {-# LINE 2134 "Network/Socket.hsc" #-} loc Nothing Nothing) "non-positive length" mkEOFError :: String -> IOError mkEOFError loc = ioeSetErrorString (mkIOError EOF loc Nothing Nothing) "end of file" -- --------------------------------------------------------------------------- -- foreign imports from the C library foreign import ccall unsafe "my_inet_ntoa" c_inet_ntoa :: HostAddress -> IO (Ptr CChar) foreign import CALLCONV unsafe "inet_addr" c_inet_addr :: Ptr CChar -> IO HostAddress foreign import CALLCONV unsafe "shutdown" c_shutdown :: CInt -> CInt -> IO CInt closeFd :: CInt -> IO () closeFd fd = throwErrnoIfMinus1Retry_ "Network.Socket.close" $ c_close fd {-# LINE 2155 "Network/Socket.hsc" #-} foreign import ccall unsafe "close" c_close :: CInt -> IO CInt {-# LINE 2161 "Network/Socket.hsc" #-} foreign import CALLCONV unsafe "socket" c_socket :: CInt -> CInt -> CInt -> IO CInt foreign import CALLCONV unsafe "bind" c_bind :: CInt -> Ptr SockAddr -> CInt{-CSockLen???-} -> IO CInt foreign import CALLCONV unsafe "connect" c_connect :: CInt -> Ptr SockAddr -> CInt{-CSockLen???-} -> IO CInt foreign import CALLCONV unsafe "accept" c_accept :: CInt -> Ptr SockAddr -> Ptr CInt{-CSockLen???-} -> IO CInt {-# LINE 2171 "Network/Socket.hsc" #-} foreign import CALLCONV unsafe "accept4" c_accept4 :: CInt -> Ptr SockAddr -> Ptr CInt{-CSockLen???-} -> CInt -> IO CInt {-# LINE 2174 "Network/Socket.hsc" #-} foreign import CALLCONV unsafe "listen" c_listen :: CInt -> CInt -> IO CInt {-# LINE 2183 "Network/Socket.hsc" #-} foreign import CALLCONV unsafe "send" c_send :: CInt -> Ptr a -> CSize -> CInt -> IO CInt foreign import CALLCONV SAFE_ON_WIN "sendto" c_sendto :: CInt -> Ptr a -> CSize -> CInt -> Ptr SockAddr -> CInt -> IO CInt foreign import CALLCONV unsafe "recv" c_recv :: CInt -> Ptr CChar -> CSize -> CInt -> IO CInt foreign import CALLCONV SAFE_ON_WIN "recvfrom" c_recvfrom :: CInt -> Ptr a -> CSize -> CInt -> Ptr SockAddr -> Ptr CInt -> IO CInt foreign import CALLCONV unsafe "getpeername" c_getpeername :: CInt -> Ptr SockAddr -> Ptr CInt -> IO CInt foreign import CALLCONV unsafe "getsockname" c_getsockname :: CInt -> Ptr SockAddr -> Ptr CInt -> IO CInt foreign import CALLCONV unsafe "getsockopt" c_getsockopt :: CInt -> CInt -> CInt -> Ptr CInt -> Ptr CInt -> IO CInt foreign import CALLCONV unsafe "setsockopt" c_setsockopt :: CInt -> CInt -> CInt -> Ptr CInt -> CInt -> IO CInt -- --------------------------------------------------------------------------- -- * Deprecated aliases -- $deprecated-aliases -- -- These aliases are deprecated and should not be used in new code. -- They will be removed in some future version of the package. -- | Deprecated alias for 'bind'. bindSocket :: Socket -- Unconnected Socket -> SockAddr -- Address to Bind to -> IO () bindSocket = bind -- | Deprecated alias for 'close'. sClose :: Socket -> IO () sClose = close -- | Deprecated alias for 'isConnected'. sIsConnected :: Socket -> IO Bool sIsConnected = isConnected -- | Deprecated alias for 'isBound'. sIsBound :: Socket -> IO Bool sIsBound = isBound -- | Deprecated alias for 'isListening'. sIsListening :: Socket -> IO Bool sIsListening = isListening -- | Deprecated alias for 'isReadable'. sIsReadable :: Socket -> IO Bool sIsReadable = isReadable -- | Deprecated alias for 'isWritable'. sIsWritable :: Socket -> IO Bool sIsWritable = isWritable