Copyright	(c) Winterland 2018
License	BSD
Maintainer	drkoster@qq.com
Stability	experimental
Portability	non-portable
Safe Haskell	None
Language	Haskell2010

Std.IO.SockAddr

Contents

name to address
- IPv4 address
- IPv6 address
port numbber
family, type, protocol

Description

This module provides necessary types and constant for low level socket operation.

Synopsis

data SockAddr
- = SockAddrInet !PortNumber !InetAddr
- | SockAddrInet6 !PortNumber !FlowInfo !Inet6Addr !ScopeID
sockAddrFamily :: SockAddr -> SocketFamily
peekSockAddr :: HasCallStack => Ptr SockAddr -> IO SockAddr
withSockAddr :: SockAddr -> (Ptr SockAddr -> IO a) -> IO a
withSockAddrStorage :: (Ptr SockAddr -> Ptr CInt -> IO ()) -> IO SockAddr
data InetAddr
inetAny :: InetAddr
inetBroadcast :: InetAddr
inetNone :: InetAddr
inetLoopback :: InetAddr
inetUnspecificGroup :: InetAddr
inetAllHostsGroup :: InetAddr
inetMaxLocalGroup :: InetAddr
inetAddrToTuple :: InetAddr -> (Word8, Word8, Word8, Word8)
tupleToInetAddr :: (Word8, Word8, Word8, Word8) -> InetAddr
data Inet6Addr
inet6Any :: Inet6Addr
inet6Loopback :: Inet6Addr
inet6AddrToTuple :: Inet6Addr -> (Word16, Word16, Word16, Word16, Word16, Word16, Word16, Word16)
tupleToInet6Addr :: (Word16, Word16, Word16, Word16, Word16, Word16, Word16, Word16) -> Inet6Addr
type FlowInfo = Word32
type ScopeID = Word32
data PortNumber
aNY_PORT :: PortNumber
htons :: Word16 -> Word16
ntohs :: Word16 -> Word16
ntohl :: Word32 -> Word32
htonl :: Word32 -> Word32
newtype SocketFamily = SocketFamily CInt
pattern AF_UNSPEC :: SocketFamily
pattern AF_INET :: SocketFamily
pattern AF_INET6 :: SocketFamily
newtype SocketType = SocketType CInt
pattern SOCK_DGRAM :: SocketType
pattern SOCK_STREAM :: SocketType
pattern SOCK_SEQPACKET :: SocketType
pattern SOCK_RAW :: SocketType
pattern SOCK_RDM :: SocketType
newtype SocketProtocol = SocketProtocol CInt
pattern IPPROTO_TCP :: SocketProtocol
pattern IPPROTO_UDP :: SocketProtocol

name to address

data SockAddr Source #

IPv4 or IPv6 socket address, i.e. the sockaddr_in or sockaddr_in6 struct.

Constructors

SockAddrInet !PortNumber !InetAddr
SockAddrInet6 !PortNumber !FlowInfo !Inet6Addr !ScopeID

Instances

Eq SockAddr Source #
Instance details Defined in Std.IO.SockAddr Methods (==) :: SockAddr -> SockAddr -> Bool # (/=) :: SockAddr -> SockAddr -> Bool #
Ord SockAddr Source #
Instance details Defined in Std.IO.SockAddr Methods compare :: SockAddr -> SockAddr -> Ordering # (<) :: SockAddr -> SockAddr -> Bool # (<=) :: SockAddr -> SockAddr -> Bool # (>) :: SockAddr -> SockAddr -> Bool # (>=) :: SockAddr -> SockAddr -> Bool # max :: SockAddr -> SockAddr -> SockAddr # min :: SockAddr -> SockAddr -> SockAddr #
Show SockAddr Source #
Instance details Defined in Std.IO.SockAddr Methods showsPrec :: Int -> SockAddr -> ShowS # show :: SockAddr -> String # showList :: [SockAddr] -> ShowS #

sockAddrFamily :: SockAddr -> SocketFamily Source #

peekSockAddr :: HasCallStack => Ptr SockAddr -> IO SockAddr Source #

withSockAddr :: SockAddr -> (Ptr SockAddr -> IO a) -> IO a Source #

withSockAddrStorage :: (Ptr SockAddr -> Ptr CInt -> IO ()) -> IO SockAddr Source #

IPv4 address

data InetAddr Source #

Independent of endianness. For example 127.0.0.1 is stored as (127, 0, 0, 1).

For direct manipulation prefer inetAddrToTuple and tupleToInetAddr.

Instances

Eq InetAddr Source #
Instance details Defined in Std.IO.SockAddr Methods (==) :: InetAddr -> InetAddr -> Bool # (/=) :: InetAddr -> InetAddr -> Bool #
Ord InetAddr Source #
Instance details Defined in Std.IO.SockAddr Methods compare :: InetAddr -> InetAddr -> Ordering # (<) :: InetAddr -> InetAddr -> Bool # (<=) :: InetAddr -> InetAddr -> Bool # (>) :: InetAddr -> InetAddr -> Bool # (>=) :: InetAddr -> InetAddr -> Bool # max :: InetAddr -> InetAddr -> InetAddr # min :: InetAddr -> InetAddr -> InetAddr #
Show InetAddr Source #
Instance details Defined in Std.IO.SockAddr Methods showsPrec :: Int -> InetAddr -> ShowS # show :: InetAddr -> String # showList :: [InetAddr] -> ShowS #
Storable InetAddr Source #
Instance details Defined in Std.IO.SockAddr Methods sizeOf :: InetAddr -> Int # alignment :: InetAddr -> Int # peekElemOff :: Ptr InetAddr -> Int -> IO InetAddr # pokeElemOff :: Ptr InetAddr -> Int -> InetAddr -> IO () # peekByteOff :: Ptr b -> Int -> IO InetAddr # pokeByteOff :: Ptr b -> Int -> InetAddr -> IO () # peek :: Ptr InetAddr -> IO InetAddr # poke :: Ptr InetAddr -> InetAddr -> IO () #

inetAny :: InetAddr Source #

0.0.0.0

inetBroadcast :: InetAddr Source #

255.255.255.255

inetNone :: InetAddr Source #

255.255.255.255

inetLoopback :: InetAddr Source #

127.0.0.1

inetUnspecificGroup :: InetAddr Source #

224.0.0.0

inetAllHostsGroup :: InetAddr Source #

224.0.0.1

inetMaxLocalGroup :: InetAddr Source #

224.0.0.255

inetAddrToTuple :: InetAddr -> (Word8, Word8, Word8, Word8) Source #

Converts HostAddress to representation-independent IPv4 quadruple. For example for 127.0.0.1 the function will return (127, 0, 0, 1) regardless of host endianness.

tupleToInetAddr :: (Word8, Word8, Word8, Word8) -> InetAddr Source #

Converts IPv4 quadruple to HostAddress.

IPv6 address

data Inet6Addr Source #

Independent of endianness. For example ::1 is stored as (0, 0, 0, 1).

For direct manipulation prefer inet6AddrToTuple and tupleToInet6Addr.

Instances

Eq Inet6Addr Source #
Instance details Defined in Std.IO.SockAddr Methods (==) :: Inet6Addr -> Inet6Addr -> Bool # (/=) :: Inet6Addr -> Inet6Addr -> Bool #
Ord Inet6Addr Source #
Instance details Defined in Std.IO.SockAddr Methods compare :: Inet6Addr -> Inet6Addr -> Ordering # (<) :: Inet6Addr -> Inet6Addr -> Bool # (<=) :: Inet6Addr -> Inet6Addr -> Bool # (>) :: Inet6Addr -> Inet6Addr -> Bool # (>=) :: Inet6Addr -> Inet6Addr -> Bool # max :: Inet6Addr -> Inet6Addr -> Inet6Addr # min :: Inet6Addr -> Inet6Addr -> Inet6Addr #
Show Inet6Addr Source #
Instance details Defined in Std.IO.SockAddr Methods showsPrec :: Int -> Inet6Addr -> ShowS # show :: Inet6Addr -> String # showList :: [Inet6Addr] -> ShowS #
Storable Inet6Addr Source #
Instance details Defined in Std.IO.SockAddr Methods sizeOf :: Inet6Addr -> Int # alignment :: Inet6Addr -> Int # peekElemOff :: Ptr Inet6Addr -> Int -> IO Inet6Addr # pokeElemOff :: Ptr Inet6Addr -> Int -> Inet6Addr -> IO () # peekByteOff :: Ptr b -> Int -> IO Inet6Addr # pokeByteOff :: Ptr b -> Int -> Inet6Addr -> IO () # peek :: Ptr Inet6Addr -> IO Inet6Addr # poke :: Ptr Inet6Addr -> Inet6Addr -> IO () #

inet6Any :: Inet6Addr Source #

::

inet6Loopback :: Inet6Addr Source #

::1

inet6AddrToTuple :: Inet6Addr -> (Word16, Word16, Word16, Word16, Word16, Word16, Word16, Word16) Source #

tupleToInet6Addr :: (Word16, Word16, Word16, Word16, Word16, Word16, Word16, Word16) -> Inet6Addr Source #

type FlowInfo = Word32 Source #

type ScopeID = Word32 Source #

port numbber

data PortNumber Source #

Use the Num instance (i.e. use a literal or fromIntegral) to create a PortNumber value with the correct network-byte-ordering.

>>> 1 :: PortNumber
1
>>> read "1" :: PortNumber
1

Instances

Enum PortNumber Source #
Instance details Defined in Std.IO.SockAddr Methods succ :: PortNumber -> PortNumber # pred :: PortNumber -> PortNumber # toEnum :: Int -> PortNumber # fromEnum :: PortNumber -> Int # enumFrom :: PortNumber -> [PortNumber] # enumFromThen :: PortNumber -> PortNumber -> [PortNumber] # enumFromTo :: PortNumber -> PortNumber -> [PortNumber] # enumFromThenTo :: PortNumber -> PortNumber -> PortNumber -> [PortNumber] #
Eq PortNumber Source #
Instance details Defined in Std.IO.SockAddr Methods (==) :: PortNumber -> PortNumber -> Bool # (/=) :: PortNumber -> PortNumber -> Bool #
Integral PortNumber Source #
Instance details Defined in Std.IO.SockAddr Methods quot :: PortNumber -> PortNumber -> PortNumber # rem :: PortNumber -> PortNumber -> PortNumber # div :: PortNumber -> PortNumber -> PortNumber # mod :: PortNumber -> PortNumber -> PortNumber # quotRem :: PortNumber -> PortNumber -> (PortNumber, PortNumber) # divMod :: PortNumber -> PortNumber -> (PortNumber, PortNumber) # toInteger :: PortNumber -> Integer #
Num PortNumber Source #
Instance details Defined in Std.IO.SockAddr Methods (+) :: PortNumber -> PortNumber -> PortNumber # (-) :: PortNumber -> PortNumber -> PortNumber # (*) :: PortNumber -> PortNumber -> PortNumber # negate :: PortNumber -> PortNumber # abs :: PortNumber -> PortNumber # signum :: PortNumber -> PortNumber # fromInteger :: Integer -> PortNumber #
Ord PortNumber Source #
Instance details Defined in Std.IO.SockAddr Methods compare :: PortNumber -> PortNumber -> Ordering # (<) :: PortNumber -> PortNumber -> Bool # (<=) :: PortNumber -> PortNumber -> Bool # (>) :: PortNumber -> PortNumber -> Bool # (>=) :: PortNumber -> PortNumber -> Bool # max :: PortNumber -> PortNumber -> PortNumber # min :: PortNumber -> PortNumber -> PortNumber #
Read PortNumber Source #
Instance details Defined in Std.IO.SockAddr Methods readsPrec :: Int -> ReadS PortNumber # readList :: ReadS [PortNumber] # readPrec :: ReadPrec PortNumber # readListPrec :: ReadPrec [PortNumber] #
Real PortNumber Source #
Instance details Defined in Std.IO.SockAddr Methods toRational :: PortNumber -> Rational #
Show PortNumber Source #
Instance details Defined in Std.IO.SockAddr Methods showsPrec :: Int -> PortNumber -> ShowS # show :: PortNumber -> String # showList :: [PortNumber] -> ShowS #
Storable PortNumber Source #
Instance details Defined in Std.IO.SockAddr Methods sizeOf :: PortNumber -> Int # alignment :: PortNumber -> Int # peekElemOff :: Ptr PortNumber -> Int -> IO PortNumber # pokeElemOff :: Ptr PortNumber -> Int -> PortNumber -> IO () # peekByteOff :: Ptr b -> Int -> IO PortNumber # pokeByteOff :: Ptr b -> Int -> PortNumber -> IO () # peek :: Ptr PortNumber -> IO PortNumber # poke :: Ptr PortNumber -> PortNumber -> IO () #

aNY_PORT :: PortNumber Source #

htons :: Word16 -> Word16 Source #

ntohs :: Word16 -> Word16 Source #

ntohl :: Word32 -> Word32 Source #

htonl :: Word32 -> Word32 Source #

family, type, protocol

newtype SocketFamily Source #

Constructors

SocketFamily CInt

Instances

Eq SocketFamily Source #
Instance details Defined in Std.IO.SockAddr Methods (==) :: SocketFamily -> SocketFamily -> Bool # (/=) :: SocketFamily -> SocketFamily -> Bool #
Ord SocketFamily Source #
Instance details Defined in Std.IO.SockAddr Methods compare :: SocketFamily -> SocketFamily -> Ordering # (<) :: SocketFamily -> SocketFamily -> Bool # (<=) :: SocketFamily -> SocketFamily -> Bool # (>) :: SocketFamily -> SocketFamily -> Bool # (>=) :: SocketFamily -> SocketFamily -> Bool # max :: SocketFamily -> SocketFamily -> SocketFamily # min :: SocketFamily -> SocketFamily -> SocketFamily #
Read SocketFamily Source #
Instance details Defined in Std.IO.SockAddr Methods readsPrec :: Int -> ReadS SocketFamily # readList :: ReadS [SocketFamily] # readPrec :: ReadPrec SocketFamily # readListPrec :: ReadPrec [SocketFamily] #
Show SocketFamily Source #
Instance details Defined in Std.IO.SockAddr Methods showsPrec :: Int -> SocketFamily -> ShowS # show :: SocketFamily -> String # showList :: [SocketFamily] -> ShowS #
Storable SocketFamily Source #
Instance details Defined in Std.IO.SockAddr Methods sizeOf :: SocketFamily -> Int # alignment :: SocketFamily -> Int # peekElemOff :: Ptr SocketFamily -> Int -> IO SocketFamily # pokeElemOff :: Ptr SocketFamily -> Int -> SocketFamily -> IO () # peekByteOff :: Ptr b -> Int -> IO SocketFamily # pokeByteOff :: Ptr b -> Int -> SocketFamily -> IO () # peek :: Ptr SocketFamily -> IO SocketFamily # poke :: Ptr SocketFamily -> SocketFamily -> IO () #

pattern AF_UNSPEC :: SocketFamily Source #

unspecified

pattern AF_INET :: SocketFamily Source #

internetwork: UDP, TCP, etc

pattern AF_INET6 :: SocketFamily Source #

Internet Protocol version 6

newtype SocketType Source #

Constructors

SocketType CInt

Instances

Eq SocketType Source #
Instance details Defined in Std.IO.SockAddr Methods (==) :: SocketType -> SocketType -> Bool # (/=) :: SocketType -> SocketType -> Bool #
Ord SocketType Source #
Instance details Defined in Std.IO.SockAddr Methods compare :: SocketType -> SocketType -> Ordering # (<) :: SocketType -> SocketType -> Bool # (<=) :: SocketType -> SocketType -> Bool # (>) :: SocketType -> SocketType -> Bool # (>=) :: SocketType -> SocketType -> Bool # max :: SocketType -> SocketType -> SocketType # min :: SocketType -> SocketType -> SocketType #
Read SocketType Source #
Instance details Defined in Std.IO.SockAddr Methods readsPrec :: Int -> ReadS SocketType # readList :: ReadS [SocketType] # readPrec :: ReadPrec SocketType # readListPrec :: ReadPrec [SocketType] #
Show SocketType Source #
Instance details Defined in Std.IO.SockAddr Methods showsPrec :: Int -> SocketType -> ShowS # show :: SocketType -> String # showList :: [SocketType] -> ShowS #
Storable SocketType Source #
Instance details Defined in Std.IO.SockAddr Methods sizeOf :: SocketType -> Int # alignment :: SocketType -> Int # peekElemOff :: Ptr SocketType -> Int -> IO SocketType # pokeElemOff :: Ptr SocketType -> Int -> SocketType -> IO () # peekByteOff :: Ptr b -> Int -> IO SocketType # pokeByteOff :: Ptr b -> Int -> SocketType -> IO () # peek :: Ptr SocketType -> IO SocketType # poke :: Ptr SocketType -> SocketType -> IO () #

pattern SOCK_DGRAM :: SocketType Source #

pattern SOCK_STREAM :: SocketType Source #

pattern SOCK_SEQPACKET :: SocketType Source #

pattern SOCK_RAW :: SocketType Source #

pattern SOCK_RDM :: SocketType Source #

newtype SocketProtocol Source #

Constructors

SocketProtocol CInt

Instances

Eq SocketProtocol Source #
Instance details Defined in Std.IO.SockAddr Methods (==) :: SocketProtocol -> SocketProtocol -> Bool # (/=) :: SocketProtocol -> SocketProtocol -> Bool #
Ord SocketProtocol Source #
Instance details Defined in Std.IO.SockAddr Methods compare :: SocketProtocol -> SocketProtocol -> Ordering # (<) :: SocketProtocol -> SocketProtocol -> Bool # (<=) :: SocketProtocol -> SocketProtocol -> Bool # (>) :: SocketProtocol -> SocketProtocol -> Bool # (>=) :: SocketProtocol -> SocketProtocol -> Bool # max :: SocketProtocol -> SocketProtocol -> SocketProtocol # min :: SocketProtocol -> SocketProtocol -> SocketProtocol #
Read SocketProtocol Source #
Instance details Defined in Std.IO.SockAddr Methods readsPrec :: Int -> ReadS SocketProtocol # readList :: ReadS [SocketProtocol] # readPrec :: ReadPrec SocketProtocol # readListPrec :: ReadPrec [SocketProtocol] #
Show SocketProtocol Source #
Instance details Defined in Std.IO.SockAddr Methods showsPrec :: Int -> SocketProtocol -> ShowS # show :: SocketProtocol -> String # showList :: [SocketProtocol] -> ShowS #
Storable SocketProtocol Source #
Instance details Defined in Std.IO.SockAddr Methods sizeOf :: SocketProtocol -> Int # alignment :: SocketProtocol -> Int # peekElemOff :: Ptr SocketProtocol -> Int -> IO SocketProtocol # pokeElemOff :: Ptr SocketProtocol -> Int -> SocketProtocol -> IO () # peekByteOff :: Ptr b -> Int -> IO SocketProtocol # pokeByteOff :: Ptr b -> Int -> SocketProtocol -> IO () # peek :: Ptr SocketProtocol -> IO SocketProtocol # poke :: Ptr SocketProtocol -> SocketProtocol -> IO () #

pattern IPPROTO_TCP :: SocketProtocol Source #

pattern IPPROTO_UDP :: SocketProtocol Source #