Z.IO.Network.SocketAddr

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

name to address

data SocketAddr

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

Constructors

SocketAddrInet !PortNumber !InetAddr

SocketAddrInet6 !PortNumber !FlowInfo !Inet6Addr !ScopeID

Instances

Eq SocketAddr

Defined in Z.IO.Network.SocketAddr

Methods

(==) :: SocketAddr -> SocketAddr -> Bool

(/=) :: SocketAddr -> SocketAddr -> Bool

Ord SocketAddr

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

Defined in Z.IO.Network.SocketAddr

Methods

showsPrec :: Int -> SocketAddr -> ShowS

show :: SocketAddr -> String

showList :: [SocketAddr] -> ShowS

ipv4 :: HasCallStack => CBytes -> PortNumber -> SocketAddr

Convert a string containing an IPv4 addresses to a binary structure

This is partial function, wrong address will throw InvalidArgument exception.

ipv6 :: HasCallStack => CBytes -> PortNumber -> SocketAddr

Convert a string containing an IPv6 addresses to a binary structure

This is partial function, wrong address will throw InvalidArgument exception.

sockAddrFamily :: SocketAddr -> SocketFamily

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

Pass SocketAddr to FFI as pointer.

withSocketAddrUnsafe :: SocketAddr -> (MBA# SocketAddr -> IO a) -> IO a

Pass SocketAddr to FFI as pointer.

USE THIS FUNCTION WITH UNSAFE FFI CALL ONLY.

sizeOfSocketAddr :: SocketAddr -> CSize

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

Allocate space for sockaddr_storage and pass to FFI.

withSocketAddrStorageUnsafe :: (MBA# SocketAddr -> IO ()) -> IO SocketAddr

Allocate space for sockaddr_storage and pass to FFI.

USE THIS FUNCTION WITH UNSAFE FFI CALL ONLY.

sizeOfSocketAddrStorage :: CSize

IPv4 address

newtype InetAddr

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

For direct manipulation prefer inetAddrToTuple and tupleToInetAddr.

Constructors

InetAddr

Fields

• getInetAddr :: Word32

Instances

Eq InetAddr

Defined in Z.IO.Network.SocketAddr

Methods

(==) :: InetAddr -> InetAddr -> Bool

(/=) :: InetAddr -> InetAddr -> Bool

Ord InetAddr

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

Defined in Z.IO.Network.SocketAddr

Methods

showsPrec :: Int -> InetAddr -> ShowS

show :: InetAddr -> String

showList :: [InetAddr] -> ShowS

Unaligned InetAddr

Defined in Z.IO.Network.SocketAddr

Methods

unalignedSize :: InetAddr -> Int

indexWord8ArrayAs# :: ByteArray# -> Int# -> InetAddr

readWord8ArrayAs# :: MutableByteArray# s -> Int# -> State# s -> (#State# s, InetAddr#)

writeWord8ArrayAs# :: MutableByteArray# s -> Int# -> InetAddr -> State# s -> State# s

peekMBA :: MutableByteArray# RealWorld -> Int -> IO InetAddr

pokeMBA :: MutableByteArray# RealWorld -> Int -> InetAddr -> IO ()

indexBA :: ByteArray# -> Int -> InetAddr

Storable InetAddr

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

0.0.0.0

inetBroadcast :: InetAddr

255.255.255.255

inetNone :: InetAddr

255.255.255.255

inetLoopback :: InetAddr

127.0.0.1

inetUnspecificGroup :: InetAddr

224.0.0.0

inetAllHostsGroup :: InetAddr

224.0.0.1

inetMaxLocalGroup :: InetAddr

224.0.0.255

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

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

Converts IPv4 quadruple to InetAddr.

IPv6 address

data Inet6Addr

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

For direct manipulation prefer inet6AddrToTuple and tupleToInet6Addr.

Constructors

Inet6Addr !Word32 !Word32 !Word32 !Word32

Instances

Eq Inet6Addr

Defined in Z.IO.Network.SocketAddr

Methods

(==) :: Inet6Addr -> Inet6Addr -> Bool

(/=) :: Inet6Addr -> Inet6Addr -> Bool

Ord Inet6Addr

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

Defined in Z.IO.Network.SocketAddr

Methods

showsPrec :: Int -> Inet6Addr -> ShowS

show :: Inet6Addr -> String

showList :: [Inet6Addr] -> ShowS

Unaligned Inet6Addr

Defined in Z.IO.Network.SocketAddr

Methods

unalignedSize :: Inet6Addr -> Int

indexWord8ArrayAs# :: ByteArray# -> Int# -> Inet6Addr

readWord8ArrayAs# :: MutableByteArray# s -> Int# -> State# s -> (#State# s, Inet6Addr#)

writeWord8ArrayAs# :: MutableByteArray# s -> Int# -> Inet6Addr -> State# s -> State# s

peekMBA :: MutableByteArray# RealWorld -> Int -> IO Inet6Addr

pokeMBA :: MutableByteArray# RealWorld -> Int -> Inet6Addr -> IO ()

indexBA :: ByteArray# -> Int -> Inet6Addr

Storable Inet6Addr

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

::

inet6Loopback :: Inet6Addr

::1

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

convert Inet6Addr to octets.

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

convert Inet6Addr from octets.

type FlowInfo = Word32

type ScopeID = Word32

port numbber

newtype PortNumber

Port number. Use the Num instance (i.e. use a literal) to create a PortNumber value.

>>> 1 :: PortNumber
1
>>> read "1" :: PortNumber
1
>>> show (12345 :: PortNumber)
"12345"
>>> 50000 < (51000 :: PortNumber)
True
>>> 50000 < (52000 :: PortNumber)
True
>>> 50000 + (10000 :: PortNumber)
60000

Constructors

PortNumber Word16

Instances

Bounded PortNumber

Defined in Z.IO.Network.SocketAddr

Methods

minBound :: PortNumber

maxBound :: PortNumber

Enum PortNumber

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

Defined in Z.IO.Network.SocketAddr

Methods

(==) :: PortNumber -> PortNumber -> Bool

(/=) :: PortNumber -> PortNumber -> Bool

Integral PortNumber

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

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

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

Defined in Z.IO.Network.SocketAddr

Methods

readsPrec :: Int -> ReadS PortNumber

readList :: ReadS [PortNumber]

readPrec :: ReadPrec PortNumber

readListPrec :: ReadPrec [PortNumber]

Real PortNumber

Defined in Z.IO.Network.SocketAddr

Methods

toRational :: PortNumber -> Rational

Show PortNumber

Defined in Z.IO.Network.SocketAddr

Methods

showsPrec :: Int -> PortNumber -> ShowS

show :: PortNumber -> String

showList :: [PortNumber] -> ShowS

Generic PortNumber

Defined in Z.IO.Network.SocketAddr

Associated Types

type Rep PortNumber :: Type -> Type

Methods

from :: PortNumber -> Rep PortNumber x

to :: Rep PortNumber x -> PortNumber

ShowT PortNumber

Defined in Z.IO.Network.SocketAddr

Methods

toTextBuilder :: Int -> PortNumber -> TextBuilder ()

Unaligned PortNumber

Defined in Z.IO.Network.SocketAddr

Methods

unalignedSize :: PortNumber -> Int

indexWord8ArrayAs# :: ByteArray# -> Int# -> PortNumber

readWord8ArrayAs# :: MutableByteArray# s -> Int# -> State# s -> (#State# s, PortNumber#)

writeWord8ArrayAs# :: MutableByteArray# s -> Int# -> PortNumber -> State# s -> State# s

peekMBA :: MutableByteArray# RealWorld -> Int -> IO PortNumber

pokeMBA :: MutableByteArray# RealWorld -> Int -> PortNumber -> IO ()

indexBA :: ByteArray# -> Int -> PortNumber

Storable PortNumber

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 ()

type Rep PortNumber

Defined in Z.IO.Network.SocketAddr

type Rep PortNumber = D1 (MetaData "PortNumber" "Z.IO.Network.SocketAddr" "Z-IO-0.1.5.2-E8snmgiQshiGGBBWzHXGeM" True) (C1 (MetaCons "PortNumber" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Word16)))

portAny :: PortNumber

:0

family, type, protocol

SocketFamily

type SocketFamily = CInt

pattern AF_UNSPEC :: SocketFamily

unspecified

pattern AF_INET :: SocketFamily

internetwork: UDP, TCP, etc

pattern AF_INET6 :: SocketFamily

Internet Protocol version 6

type 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

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

type ProtocolNumber = CInt

pattern IPPROTO_DEFAULT :: ProtocolNumber

pattern IPPROTO_IP :: ProtocolNumber

pattern IPPROTO_TCP :: ProtocolNumber

pattern IPPROTO_UDP :: ProtocolNumber

Internal helper

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

pokeSocketAddr :: Ptr SocketAddr -> SocketAddr -> IO ()

peekSocketAddrMBA :: HasCallStack => MBA# SocketAddr -> IO SocketAddr

pokeSocketAddrMBA :: MBA# SocketAddr -> SocketAddr -> IO ()

htons :: Word16 -> Word16

ntohs :: Word16 -> Word16

ntohl :: Word32 -> Word32

htonl :: Word32 -> Word32