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.

Example on JSON instance:

> JSON.encodeText  $ ipv6 "3731:54:65fe:2::a8" 9090
"{"addr":[14129,84,26110,2,0,0,0,168],"port":9090,"flow":0,"scope":0}"
> JSON.encodeText  $ ipv4 "128.14.32.1" 9090
"{"addr":[128,14,32,1],"port":9090}"

Constructors

SocketAddrIPv4 !IPv4 !PortNumber

SocketAddrIPv6 !IPv6 !PortNumber !FlowInfo !ScopeID

Instances

JSON SocketAddr

Defined in Z.IO.Network.SocketAddr

Methods

fromValue :: Value -> Converter SocketAddr

toValue :: SocketAddr -> Value

encodeJSON :: SocketAddr -> Builder ()

Print SocketAddr

Defined in Z.IO.Network.SocketAddr

Methods

toUTF8BuilderP :: Int -> SocketAddr -> Builder ()

Generic SocketAddr

Defined in Z.IO.Network.SocketAddr

Associated Types

type Rep SocketAddr :: Type -> Type

Methods

from :: SocketAddr -> Rep SocketAddr x

to :: Rep SocketAddr x -> SocketAddr

Show SocketAddr

Defined in Z.IO.Network.SocketAddr

Methods

showsPrec :: Int -> SocketAddr -> ShowS

show :: SocketAddr -> String

showList :: [SocketAddr] -> ShowS

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

type Rep SocketAddr

Defined in Z.IO.Network.SocketAddr

type Rep SocketAddr = D1 ('MetaData "SocketAddr" "Z.IO.Network.SocketAddr" "Z-IO-2.0.0.0-51Vcxm8cL7LL2DAVynurM3" 'False) (C1 ('MetaCons "SocketAddrIPv4" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 IPv4) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 PortNumber)) :+: C1 ('MetaCons "SocketAddrIPv6" 'PrefixI 'False) ((S1 ('MetaSel ('Nothing :: Maybe Symbol) 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 IPv6) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 PortNumber)) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 FlowInfo) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 ScopeID))))

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 IPv4

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

For direct manipulation prefer ipv4AddrToTuple and tupleToIPv4Addr.

JSON instance encode ipv4 address into an array with 4 Word8 octets.

Constructors

IPv4

Fields

• getIPv4Addr :: Word32

Instances

Unaligned IPv4

Defined in Z.IO.Network.SocketAddr

Methods

unalignedSize :: UnalignedSize IPv4

indexWord8ArrayAs# :: ByteArray# -> Int# -> IPv4

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

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

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

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

indexBA :: ByteArray# -> Int -> IPv4

JSON IPv4

Defined in Z.IO.Network.SocketAddr

Methods

fromValue :: Value -> Converter IPv4

toValue :: IPv4 -> Value

encodeJSON :: IPv4 -> Builder ()

Print IPv4

Defined in Z.IO.Network.SocketAddr

Methods

toUTF8BuilderP :: Int -> IPv4 -> Builder ()

Storable IPv4

Defined in Z.IO.Network.SocketAddr

Methods

sizeOf :: IPv4 -> Int

alignment :: IPv4 -> Int

peekElemOff :: Ptr IPv4 -> Int -> IO IPv4

pokeElemOff :: Ptr IPv4 -> Int -> IPv4 -> IO ()

peekByteOff :: Ptr b -> Int -> IO IPv4

pokeByteOff :: Ptr b -> Int -> IPv4 -> IO ()

peek :: Ptr IPv4 -> IO IPv4

poke :: Ptr IPv4 -> IPv4 -> IO ()

Generic IPv4

Defined in Z.IO.Network.SocketAddr

Associated Types

type Rep IPv4 :: Type -> Type

Methods

from :: IPv4 -> Rep IPv4 x

to :: Rep IPv4 x -> IPv4

Show IPv4

Defined in Z.IO.Network.SocketAddr

Methods

showsPrec :: Int -> IPv4 -> ShowS

show :: IPv4 -> String

showList :: [IPv4] -> ShowS

Eq IPv4

Defined in Z.IO.Network.SocketAddr

Methods

(==) :: IPv4 -> IPv4 -> Bool

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

Ord IPv4

Defined in Z.IO.Network.SocketAddr

Methods

compare :: IPv4 -> IPv4 -> Ordering

(<) :: IPv4 -> IPv4 -> Bool

(<=) :: IPv4 -> IPv4 -> Bool

(>) :: IPv4 -> IPv4 -> Bool

(>=) :: IPv4 -> IPv4 -> Bool

max :: IPv4 -> IPv4 -> IPv4

min :: IPv4 -> IPv4 -> IPv4

type Rep IPv4

Defined in Z.IO.Network.SocketAddr

type Rep IPv4 = D1 ('MetaData "IPv4" "Z.IO.Network.SocketAddr" "Z-IO-2.0.0.0-51Vcxm8cL7LL2DAVynurM3" 'True) (C1 ('MetaCons "IPv4" 'PrefixI 'True) (S1 ('MetaSel ('Just "getIPv4Addr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32)))

ipv4Any :: IPv4

0.0.0.0

ipv4Broadcast :: IPv4

255.255.255.255

ipv4None :: IPv4

255.255.255.255

ipv4Loopback :: IPv4

127.0.0.1

ipv4UnspecificGroup :: IPv4

224.0.0.0

ipv4AllHostsGroup :: IPv4

224.0.0.1

ipv4MaxLocalGroup :: IPv4

224.0.0.255

ipv4AddrToTuple :: IPv4 -> (Word8, Word8, Word8, Word8)

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

tupleToIPv4Addr :: (Word8, Word8, Word8, Word8) -> IPv4

Converts IPv4 quadruple to IPv4.

IPv6 address

data IPv6

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

For direct manipulation prefer ipv6AddrToTuple and tupleToIPv6Addr.

JSON instance encode ipv6 address into an array with 8 Word16 octets.

Constructors

IPv6 !Word32 !Word32 !Word32 !Word32

Instances

Unaligned IPv6

Defined in Z.IO.Network.SocketAddr

Methods

unalignedSize :: UnalignedSize IPv6

indexWord8ArrayAs# :: ByteArray# -> Int# -> IPv6

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

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

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

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

indexBA :: ByteArray# -> Int -> IPv6

JSON IPv6

Defined in Z.IO.Network.SocketAddr

Methods

fromValue :: Value -> Converter IPv6

toValue :: IPv6 -> Value

encodeJSON :: IPv6 -> Builder ()

Print IPv6

Defined in Z.IO.Network.SocketAddr

Methods

toUTF8BuilderP :: Int -> IPv6 -> Builder ()

Storable IPv6

Defined in Z.IO.Network.SocketAddr

Methods

sizeOf :: IPv6 -> Int

alignment :: IPv6 -> Int

peekElemOff :: Ptr IPv6 -> Int -> IO IPv6

pokeElemOff :: Ptr IPv6 -> Int -> IPv6 -> IO ()

peekByteOff :: Ptr b -> Int -> IO IPv6

pokeByteOff :: Ptr b -> Int -> IPv6 -> IO ()

peek :: Ptr IPv6 -> IO IPv6

poke :: Ptr IPv6 -> IPv6 -> IO ()

Generic IPv6

Defined in Z.IO.Network.SocketAddr

Associated Types

type Rep IPv6 :: Type -> Type

Methods

from :: IPv6 -> Rep IPv6 x

to :: Rep IPv6 x -> IPv6

Show IPv6

Defined in Z.IO.Network.SocketAddr

Methods

showsPrec :: Int -> IPv6 -> ShowS

show :: IPv6 -> String

showList :: [IPv6] -> ShowS

Eq IPv6

Defined in Z.IO.Network.SocketAddr

Methods

(==) :: IPv6 -> IPv6 -> Bool

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

Ord IPv6

Defined in Z.IO.Network.SocketAddr

Methods

compare :: IPv6 -> IPv6 -> Ordering

(<) :: IPv6 -> IPv6 -> Bool

(<=) :: IPv6 -> IPv6 -> Bool

(>) :: IPv6 -> IPv6 -> Bool

(>=) :: IPv6 -> IPv6 -> Bool

max :: IPv6 -> IPv6 -> IPv6

min :: IPv6 -> IPv6 -> IPv6

type Rep IPv6

Defined in Z.IO.Network.SocketAddr

type Rep IPv6 = D1 ('MetaData "IPv6" "Z.IO.Network.SocketAddr" "Z-IO-2.0.0.0-51Vcxm8cL7LL2DAVynurM3" 'False) (C1 ('MetaCons "IPv6" 'PrefixI 'False) ((S1 ('MetaSel ('Nothing :: Maybe Symbol) 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Word32) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Word32)) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Word32) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 Word32))))

ipv6Any :: IPv6

::

ipv6Loopback :: IPv6

::1

ipv6AddrToTuple :: IPv6 -> (Word16, Word16, Word16, Word16, Word16, Word16, Word16, Word16)

convert IPv6 to octets.

tupleToIPv6Addr :: (Word16, Word16, Word16, Word16, Word16, Word16, Word16, Word16) -> IPv6

convert IPv6 from octets.

type FlowInfo = Word32

type ScopeID = Word32

Interface

data Interface

Data type for interface addresses.

Constructors

Interface

Fields

• interfaceName :: !CBytes
• interfacePhysAddr :: !HexBytes
• interfaceIsInternal :: !Bool
• interfaceAddr :: !SocketAddr
• interfaceMask :: !SocketAddr

Instances

JSON Interface

Defined in Z.IO.Network.SocketAddr

Methods

fromValue :: Value -> Converter Interface

toValue :: Interface -> Value

encodeJSON :: Interface -> Builder ()

Print Interface

Defined in Z.IO.Network.SocketAddr

Methods

toUTF8BuilderP :: Int -> Interface -> Builder ()

Generic Interface

Defined in Z.IO.Network.SocketAddr

Associated Types

type Rep Interface :: Type -> Type

Methods

from :: Interface -> Rep Interface x

to :: Rep Interface x -> Interface

Show Interface

Defined in Z.IO.Network.SocketAddr

Methods

showsPrec :: Int -> Interface -> ShowS

show :: Interface -> String

showList :: [Interface] -> ShowS

Eq Interface

Defined in Z.IO.Network.SocketAddr

Methods

(==) :: Interface -> Interface -> Bool

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

Ord Interface

Defined in Z.IO.Network.SocketAddr

Methods

compare :: Interface -> Interface -> Ordering

(<) :: Interface -> Interface -> Bool

(<=) :: Interface -> Interface -> Bool

(>) :: Interface -> Interface -> Bool

(>=) :: Interface -> Interface -> Bool

max :: Interface -> Interface -> Interface

min :: Interface -> Interface -> Interface

type Rep Interface

Defined in Z.IO.Network.SocketAddr

type Rep Interface = D1 ('MetaData "Interface" "Z.IO.Network.SocketAddr" "Z-IO-2.0.0.0-51Vcxm8cL7LL2DAVynurM3" 'False) (C1 ('MetaCons "Interface" 'PrefixI 'True) ((S1 ('MetaSel ('Just "interfaceName") 'SourceUnpack 'SourceStrict 'DecidedStrict) (Rec0 CBytes) :*: S1 ('MetaSel ('Just "interfacePhysAddr") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 HexBytes)) :*: (S1 ('MetaSel ('Just "interfaceIsInternal") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool) :*: (S1 ('MetaSel ('Just "interfaceAddr") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SocketAddr) :*: S1 ('MetaSel ('Just "interfaceMask") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SocketAddr)))))

getInterface :: IO [Interface]

Gets address information about the network interfaces on the system.

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

Unaligned PortNumber

Defined in Z.IO.Network.SocketAddr

Methods

unalignedSize :: UnalignedSize PortNumber

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

JSON PortNumber

Defined in Z.IO.Network.SocketAddr

Methods

fromValue :: Value -> Converter PortNumber

toValue :: PortNumber -> Value

encodeJSON :: PortNumber -> Builder ()

Print PortNumber

Defined in Z.IO.Network.SocketAddr

Methods

toUTF8BuilderP :: Int -> PortNumber -> Builder ()

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

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]

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

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

Read PortNumber

Defined in Z.IO.Network.SocketAddr

Methods

readsPrec :: Int -> ReadS PortNumber

readList :: ReadS [PortNumber]

readPrec :: ReadPrec PortNumber

readListPrec :: ReadPrec [PortNumber]

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

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

Eq PortNumber

Defined in Z.IO.Network.SocketAddr

Methods

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

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

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

type Rep PortNumber

Defined in Z.IO.Network.SocketAddr

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

portAny :: PortNumber

:0

defaultPortNumberHTTP :: PortNumber

defaultPortNumberHTTPS :: PortNumber

defaultPortNumberSMTP :: PortNumber

defaultPortNumberPOP3 :: PortNumber

defaultPortNumberIMAP :: PortNumber

defaultPortNumberIRC :: PortNumber

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

peekInterface :: HasCallStack => Ptr Interface -> IO Interface

htons :: Word16 -> Word16

ntohs :: Word16 -> Word16

ntohl :: Word32 -> Word32

htonl :: Word32 -> Word32