Copyright	(c) Winterland 2018
License	BSD
Maintainer	winterland1989@gmail.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
- SocketFamily
Internal helper

Description

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

Synopsis

data SocketAddr
- = SocketAddrIPv4 !IPv4 !PortNumber
- | SocketAddrIPv6 !IPv6 !PortNumber !FlowInfo !ScopeID
ipv4 :: HasCallStack => CBytes -> PortNumber -> SocketAddr
ipv6 :: HasCallStack => CBytes -> PortNumber -> SocketAddr
sockAddrFamily :: SocketAddr -> SocketFamily
withSocketAddr :: SocketAddr -> (Ptr SocketAddr -> IO a) -> IO a
withSocketAddrUnsafe :: SocketAddr -> (MBA# SocketAddr -> IO a) -> IO a
sizeOfSocketAddr :: SocketAddr -> CSize
withSocketAddrStorage :: (Ptr SocketAddr -> IO ()) -> IO SocketAddr
withSocketAddrStorageUnsafe :: (MBA# SocketAddr -> IO ()) -> IO SocketAddr
sizeOfSocketAddrStorage :: CSize
newtype IPv4 = IPv4 {
- getIPv4Addr :: Word32
}
ipv4Any :: IPv4
ipv4Broadcast :: IPv4
ipv4None :: IPv4
ipv4Loopback :: IPv4
ipv4UnspecificGroup :: IPv4
ipv4AllHostsGroup :: IPv4
ipv4MaxLocalGroup :: IPv4
ipv4AddrToTuple :: IPv4 -> (Word8, Word8, Word8, Word8)
tupleToIPv4Addr :: (Word8, Word8, Word8, Word8) -> IPv4
data IPv6 = IPv6 !Word32 !Word32 !Word32 !Word32
ipv6Any :: IPv6
ipv6Loopback :: IPv6
ipv6AddrToTuple :: IPv6 -> (Word16, Word16, Word16, Word16, Word16, Word16, Word16, Word16)
tupleToIPv6Addr :: (Word16, Word16, Word16, Word16, Word16, Word16, Word16, Word16) -> IPv6
type FlowInfo = Word32
type ScopeID = Word32
newtype PortNumber = PortNumber Word16
portAny :: PortNumber
type SocketFamily = CInt
pattern AF_UNSPEC :: SocketFamily
pattern AF_INET :: SocketFamily
pattern AF_INET6 :: SocketFamily
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
type ProtocolNumber = CInt
pattern IPPROTO_DEFAULT :: ProtocolNumber
pattern IPPROTO_IP :: ProtocolNumber
pattern IPPROTO_TCP :: ProtocolNumber
pattern IPPROTO_UDP :: ProtocolNumber
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

name to address

data SocketAddr Source #

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

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 #
Generic SocketAddr Source #
Instance details Defined in Z.IO.Network.SocketAddr Associated Types type Rep SocketAddr :: Type -> Type # Methods from :: SocketAddr -> Rep SocketAddr x # to :: Rep SocketAddr x -> SocketAddr #
JSON SocketAddr Source #
Instance details Defined in Z.IO.Network.SocketAddr Methods fromValue :: Value -> Converter SocketAddr # toValue :: SocketAddr -> Value # encodeJSON :: SocketAddr -> Builder () #
Print SocketAddr Source #
Instance details Defined in Z.IO.Network.SocketAddr Methods toUTF8BuilderP :: Int -> SocketAddr -> Builder () #
type Rep SocketAddr Source #
Instance details Defined in Z.IO.Network.SocketAddr type Rep SocketAddr = D1 ('MetaData "SocketAddr" "Z.IO.Network.SocketAddr" "Z-IO-0.6.4.0-3RdtkLMi3pWlcaS0GimBE" '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 Source #

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 Source #

Convert a string containing an IPv6 addresses to a binary structure

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

sockAddrFamily :: SocketAddr -> SocketFamily Source #

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

Pass SocketAddr to FFI as pointer.

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

Pass SocketAddr to FFI as pointer.

USE THIS FUNCTION WITH UNSAFE FFI CALL ONLY.

sizeOfSocketAddr :: SocketAddr -> CSize Source #

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

Allocate space for sockaddr_storage and pass to FFI.

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

Allocate space for sockaddr_storage and pass to FFI.

USE THIS FUNCTION WITH UNSAFE FFI CALL ONLY.

sizeOfSocketAddrStorage :: CSize Source #

IPv4 address

newtype IPv4 Source #

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

Instances details

Eq IPv4 Source #
Instance details Defined in Z.IO.Network.SocketAddr Methods (==) :: IPv4 -> IPv4 -> Bool # (/=) :: IPv4 -> IPv4 -> Bool #
Ord IPv4 Source #
Instance details 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 #
Show IPv4 Source #
Instance details Defined in Z.IO.Network.SocketAddr Methods showsPrec :: Int -> IPv4 -> ShowS # show :: IPv4 -> String # showList :: [IPv4] -> ShowS #
Generic IPv4 Source #
Instance details Defined in Z.IO.Network.SocketAddr Associated Types type Rep IPv4 :: Type -> Type # Methods from :: IPv4 -> Rep IPv4 x # to :: Rep IPv4 x -> IPv4 #
JSON IPv4 Source #
Instance details Defined in Z.IO.Network.SocketAddr Methods fromValue :: Value -> Converter IPv4 # toValue :: IPv4 -> Value # encodeJSON :: IPv4 -> Builder () #
Print IPv4 Source #
Instance details Defined in Z.IO.Network.SocketAddr Methods toUTF8BuilderP :: Int -> IPv4 -> Builder () #
Unaligned IPv4 Source #
Instance details 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 #
Storable IPv4 Source #
Instance details 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 () #
type Rep IPv4 Source #
Instance details Defined in Z.IO.Network.SocketAddr type Rep IPv4 = D1 ('MetaData "IPv4" "Z.IO.Network.SocketAddr" "Z-IO-0.6.4.0-3RdtkLMi3pWlcaS0GimBE" 'True) (C1 ('MetaCons "IPv4" 'PrefixI 'True) (S1 ('MetaSel ('Just "getIPv4Addr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32)))

ipv4Any :: IPv4 Source #

0.0.0.0

ipv4Broadcast :: IPv4 Source #

255.255.255.255

ipv4None :: IPv4 Source #

255.255.255.255

ipv4Loopback :: IPv4 Source #

127.0.0.1

ipv4UnspecificGroup :: IPv4 Source #

224.0.0.0

ipv4AllHostsGroup :: IPv4 Source #

224.0.0.1

ipv4MaxLocalGroup :: IPv4 Source #

224.0.0.255

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

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 Source #

Converts IPv4 quadruple to IPv4.

IPv6 address

data IPv6 Source #

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

Instances details

Eq IPv6 Source #
Instance details Defined in Z.IO.Network.SocketAddr Methods (==) :: IPv6 -> IPv6 -> Bool # (/=) :: IPv6 -> IPv6 -> Bool #
Ord IPv6 Source #
Instance details 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 #
Show IPv6 Source #
Instance details Defined in Z.IO.Network.SocketAddr Methods showsPrec :: Int -> IPv6 -> ShowS # show :: IPv6 -> String # showList :: [IPv6] -> ShowS #
Generic IPv6 Source #
Instance details Defined in Z.IO.Network.SocketAddr Associated Types type Rep IPv6 :: Type -> Type # Methods from :: IPv6 -> Rep IPv6 x # to :: Rep IPv6 x -> IPv6 #
JSON IPv6 Source #
Instance details Defined in Z.IO.Network.SocketAddr Methods fromValue :: Value -> Converter IPv6 # toValue :: IPv6 -> Value # encodeJSON :: IPv6 -> Builder () #
Print IPv6 Source #
Instance details Defined in Z.IO.Network.SocketAddr Methods toUTF8BuilderP :: Int -> IPv6 -> Builder () #
Unaligned IPv6 Source #
Instance details 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 #
Storable IPv6 Source #
Instance details 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 () #
type Rep IPv6 Source #
Instance details Defined in Z.IO.Network.SocketAddr type Rep IPv6 = D1 ('MetaData "IPv6" "Z.IO.Network.SocketAddr" "Z-IO-0.6.4.0-3RdtkLMi3pWlcaS0GimBE" '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 Source #

::

ipv6Loopback :: IPv6 Source #

::1

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

convert IPv6 to octets.

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

convert IPv6 from octets.

type FlowInfo = Word32 Source #

type ScopeID = Word32 Source #

port numbber

newtype PortNumber Source #

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

Instances details

Bounded PortNumber Source #
Instance details Defined in Z.IO.Network.SocketAddr Methods minBound :: PortNumber # maxBound :: PortNumber #
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 #
Generic PortNumber Source #
Instance details Defined in Z.IO.Network.SocketAddr Associated Types type Rep PortNumber :: Type -> Type # Methods from :: PortNumber -> Rep PortNumber x # to :: Rep PortNumber x -> PortNumber #
JSON PortNumber Source #
Instance details Defined in Z.IO.Network.SocketAddr Methods fromValue :: Value -> Converter PortNumber # toValue :: PortNumber -> Value # encodeJSON :: PortNumber -> Builder () #
Print PortNumber Source #
Instance details Defined in Z.IO.Network.SocketAddr Methods toUTF8BuilderP :: Int -> PortNumber -> Builder () #
Unaligned PortNumber Source #
Instance details 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 #
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 () #
type Rep PortNumber Source #
Instance details Defined in Z.IO.Network.SocketAddr type Rep PortNumber = D1 ('MetaData "PortNumber" "Z.IO.Network.SocketAddr" "Z-IO-0.6.4.0-3RdtkLMi3pWlcaS0GimBE" 'True) (C1 ('MetaCons "PortNumber" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word16)))