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

Z.IO.Network.SocketAddr

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 address manipulating.

Synopsis

data SocketAddr
- = SocketAddrInet !PortNumber !InetAddr
- | SocketAddrInet6 !PortNumber !FlowInfo !Inet6Addr !ScopeID
sockAddrFamily :: SocketAddr -> SocketFamily
peekSocketAddr :: HasCallStack => Ptr SocketAddr -> IO SocketAddr
withSocketAddr :: SocketAddr -> (Ptr SocketAddr -> IO a) -> IO a
sizeOfSocketAddr :: SocketAddr -> CSize
withSocketAddrStorage :: (Ptr SocketAddr -> IO ()) -> IO SocketAddr
sizeOfSocketAddrStorage :: CSize
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
portAny :: 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
pattern SOCK_ANY :: SocketType
newtype ProtocolNumber = ProtocolNumber CInt
pattern IPPROTO_DEFAULT :: ProtocolNumber
pattern IPPROTO_IP :: ProtocolNumber
pattern IPPROTO_TCP :: ProtocolNumber
pattern IPPROTO_UDP :: ProtocolNumber

name to address

data SocketAddr Source #

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

Constructors

SocketAddrInet !PortNumber !InetAddr
SocketAddrInet6 !PortNumber !FlowInfo !Inet6Addr !ScopeID

Instances

Instances details

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

sockAddrFamily :: SocketAddr -> SocketFamily Source #

Show an IPv6 address in the most appropriate notation, based on recommended representation proposed by RFC 5952.

/The implementation is completely compatible with the current implementation of the inet_ntop function in glibc./

peekSocketAddr :: HasCallStack => Ptr SocketAddr -> IO SocketAddr Source #

withSocketAddr :: SocketAddr -> (Ptr SocketAddr -> IO a) -> IO a Source #

sizeOfSocketAddr :: SocketAddr -> CSize Source #

withSocketAddrStorage :: (Ptr SocketAddr -> IO ()) -> IO SocketAddr Source #

sizeOfSocketAddrStorage :: CSize 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

Instances details

Eq InetAddr Source #
Instance details Defined in Z.IO.Network.SocketAddr Methods (==) :: InetAddr -> InetAddr -> Bool # (/=) :: InetAddr -> InetAddr -> Bool #
Ord InetAddr Source #
Instance details Defined in Z.IO.Network.SocketAddr 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 Z.IO.Network.SocketAddr Methods showsPrec :: Int -> InetAddr -> ShowS # show :: InetAddr -> String # showList :: [InetAddr] -> ShowS #
Storable InetAddr Source #
Instance details Defined in Z.IO.Network.SocketAddr 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 InetAddr 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 InetAddr.

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

Instances details

Eq Inet6Addr Source #
Instance details Defined in Z.IO.Network.SocketAddr Methods (==) :: Inet6Addr -> Inet6Addr -> Bool # (/=) :: Inet6Addr -> Inet6Addr -> Bool #
Ord Inet6Addr Source #
Instance details Defined in Z.IO.Network.SocketAddr 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 Z.IO.Network.SocketAddr Methods showsPrec :: Int -> Inet6Addr -> ShowS # show :: Inet6Addr -> String # showList :: [Inet6Addr] -> ShowS #
Storable Inet6Addr Source #
Instance details Defined in Z.IO.Network.SocketAddr 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

Instances details

Enum PortNumber Source #
Instance details Defined in Z.IO.Network.SocketAddr 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 Z.IO.Network.SocketAddr Methods (==) :: PortNumber -> PortNumber -> Bool # (/=) :: PortNumber -> PortNumber -> Bool #
Integral PortNumber Source #
Instance details Defined in Z.IO.Network.SocketAddr 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 Z.IO.Network.SocketAddr 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 Z.IO.Network.SocketAddr 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 Z.IO.Network.SocketAddr Methods readsPrec :: Int -> ReadS PortNumber # readList :: ReadS [PortNumber] # readPrec :: ReadPrec PortNumber # readListPrec :: ReadPrec [PortNumber] #
Real PortNumber Source #
Instance details Defined in Z.IO.Network.SocketAddr Methods toRational :: PortNumber -> Rational #
Show PortNumber Source #
Instance details Defined in Z.IO.Network.SocketAddr Methods showsPrec :: Int -> PortNumber -> ShowS # show :: PortNumber -> String # showList :: [PortNumber] -> ShowS #
Storable PortNumber Source #
Instance details Defined in Z.IO.Network.SocketAddr 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 () #

portAny :: 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

Instances details

Eq SocketFamily Source #
Instance details Defined in Z.IO.Network.SocketAddr Methods (==) :: SocketFamily -> SocketFamily -> Bool # (/=) :: SocketFamily -> SocketFamily -> Bool #
Ord SocketFamily Source #
Instance details Defined in Z.IO.Network.SocketAddr 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 Z.IO.Network.SocketAddr Methods readsPrec :: Int -> ReadS SocketFamily # readList :: ReadS [SocketFamily] # readPrec :: ReadPrec SocketFamily # readListPrec :: ReadPrec [SocketFamily] #
Show SocketFamily Source #
Instance details Defined in Z.IO.Network.SocketAddr Methods showsPrec :: Int -> SocketFamily -> ShowS # show :: SocketFamily -> String # showList :: [SocketFamily] -> ShowS #
Storable SocketFamily Source #
Instance details Defined in Z.IO.Network.SocketAddr 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

Instances details

Eq SocketType Source #
Instance details Defined in Z.IO.Network.SocketAddr Methods (==) :: SocketType -> SocketType -> Bool # (/=) :: SocketType -> SocketType -> Bool #
Ord SocketType Source #
Instance details Defined in Z.IO.Network.SocketAddr 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 Z.IO.Network.SocketAddr Methods readsPrec :: Int -> ReadS SocketType # readList :: ReadS [SocketType] # readPrec :: ReadPrec SocketType # readListPrec :: ReadPrec [SocketType] #
Show SocketType Source #
Instance details Defined in Z.IO.Network.SocketAddr Methods showsPrec :: Int -> SocketType -> ShowS # show :: SocketType -> String # showList :: [SocketType] -> ShowS #
Storable SocketType Source #
Instance details Defined in Z.IO.Network.SocketAddr 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 #

pattern SOCK_ANY :: SocketType Source #

Used in getAddrInfo hints, for any type can be returned by getAddrInfo

newtype ProtocolNumber Source #

Constructors

ProtocolNumber CInt

Instances

Instances details

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

pattern IPPROTO_DEFAULT :: ProtocolNumber Source #

pattern IPPROTO_IP :: ProtocolNumber Source #

pattern IPPROTO_TCP :: ProtocolNumber Source #

pattern IPPROTO_UDP :: ProtocolNumber Source #