Copyright	(c) Dong Han 2018
License	BSD
Maintainer	winterland1989@gmail.com
Stability	experimental
Portability	non-portable
Safe Haskell	None
Language	Haskell2010

Std.IO.UDP

Contents

TCP Client
multicast and broadcast

Description

This module provides an API for creating UDP sender and receiver.

Synopsis

data UDP = UDP {
- udpHandle :: !(Ptr UVHandle)
- udpSlot :: !UVSlot
- udpManager :: UVManager
- udpRecvLargeBuffer :: !(MutablePrimArray RealWorld Word8)
- udpRecvBufferSiz :: !Int32
- udpRecvBufferArray :: !(MutablePrimArray RealWorld (Ptr Word8))
- udpSendBuffer :: !(MutablePrimArray RealWorld Word8)
- udpClosed :: !(IORef Bool)
}
initUDP :: HasCallStack => UDPConfig -> Resource UDP
data UDPConfig = UDPConfig {
- recvMsgSize :: !Int32
- recvBatchSize :: !Int
- sendMsgSize :: !Int
- localUDPAddr :: Maybe (SockAddr, UVUDPFlag)
}
defaultUDPConfig :: UDPConfig
data UVUDPFlag where
- pattern UV_UDP_DEFAULT :: UVUDPFlag
- pattern UV_UDP_IPV6ONLY :: UVUDPFlag
- pattern UV_UDP_REUSEADDR :: UVUDPFlag
recvUDP :: HasCallStack => UDP -> IO [(Maybe SockAddr, Bool, Bytes)]
sendUDP :: HasCallStack => UDP -> SockAddr -> Bytes -> IO ()
getSockName :: HasCallStack => UDP -> IO SockAddr
data UVMembership where
- pattern UV_JOIN_GROUP :: UVMembership
- pattern UV_LEAVE_GROUP :: UVMembership
setMembership :: HasCallStack => UDP -> CBytes -> CBytes -> UVMembership -> IO ()
setMulticastLoop :: HasCallStack => UDP -> Bool -> IO ()
setMulticastTTL :: HasCallStack => UDP -> Int -> IO ()
setMulticastInterface :: HasCallStack => UDP -> CBytes -> IO ()
setBroadcast :: HasCallStack => UDP -> Bool -> IO ()
setTTL :: HasCallStack => UDP -> Int -> IO ()

TCP Client

data UDP Source #

UDP socket.

UDP socket is not thread safe, don't use it among multiple thread! UDP is not a sequential protocol, thus not an instance of 'Input/Output'. Message are received or sent individually, we do provide batch receiving to improve performance under high load.

Constructors

UDP
Fields udpHandle :: !(Ptr UVHandle) udpSlot :: !UVSlot udpManager :: UVManager udpRecvLargeBuffer :: !(MutablePrimArray RealWorld Word8) udpRecvBufferSiz :: !Int32 udpRecvBufferArray :: !(MutablePrimArray RealWorld (Ptr Word8)) udpSendBuffer :: !(MutablePrimArray RealWorld Word8) udpClosed :: !(IORef Bool)

Instances

Show UDP Source #
Instance details Defined in Std.IO.UDP Methods showsPrec :: Int -> UDP -> ShowS # show :: UDP -> String # showList :: [UDP] -> ShowS #

initUDP :: HasCallStack => UDPConfig -> Resource UDP Source #

Initialize a UDP socket.

data UDPConfig Source #

UDP options.

Though technically message length field in the UDP header is a max of 65535, but large packets could be more likely dropped by routers, usually a packet(IPV4) with a payload <= 508 bytes is considered safe.

Constructors

UDPConfig

Fields

recvMsgSize :: !Int32
maximum size of a received message
recvBatchSize :: !Int
how many messages we want to receive per uv loop, inside each uv_run, we do batch receiving, increase this number can improve receiving performance, at the cost of memory and potential GHC thread starving.
sendMsgSize :: !Int
maximum size of sending buffer
localUDPAddr :: Maybe (SockAddr, UVUDPFlag)
do we want bind a local address before receiving & sending? set to Nothing to let OS pick a random one.

Instances

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

defaultUDPConfig :: UDPConfig Source #

default UDPConfig, defaultUDPConfig = UDPConfig 512 6 512 Nothing

data UVUDPFlag where Source #

Bundled Patterns

pattern UV_UDP_DEFAULT :: UVUDPFlag
pattern UV_UDP_IPV6ONLY :: UVUDPFlag
pattern UV_UDP_REUSEADDR :: UVUDPFlag

Instances

Eq UVUDPFlag Source #
Instance details Defined in Std.IO.UV.FFI Methods (==) :: UVUDPFlag -> UVUDPFlag -> Bool # (/=) :: UVUDPFlag -> UVUDPFlag -> Bool #
Num UVUDPFlag Source #
Instance details Defined in Std.IO.UV.FFI Methods (+) :: UVUDPFlag -> UVUDPFlag -> UVUDPFlag # (-) :: UVUDPFlag -> UVUDPFlag -> UVUDPFlag # (*) :: UVUDPFlag -> UVUDPFlag -> UVUDPFlag # negate :: UVUDPFlag -> UVUDPFlag # abs :: UVUDPFlag -> UVUDPFlag # signum :: UVUDPFlag -> UVUDPFlag # fromInteger :: Integer -> UVUDPFlag #
Ord UVUDPFlag Source #
Instance details Defined in Std.IO.UV.FFI Methods compare :: UVUDPFlag -> UVUDPFlag -> Ordering # (<) :: UVUDPFlag -> UVUDPFlag -> Bool # (<=) :: UVUDPFlag -> UVUDPFlag -> Bool # (>) :: UVUDPFlag -> UVUDPFlag -> Bool # (>=) :: UVUDPFlag -> UVUDPFlag -> Bool # max :: UVUDPFlag -> UVUDPFlag -> UVUDPFlag # min :: UVUDPFlag -> UVUDPFlag -> UVUDPFlag #
Show UVUDPFlag Source #
Instance details Defined in Std.IO.UV.FFI Methods showsPrec :: Int -> UVUDPFlag -> ShowS # show :: UVUDPFlag -> String # showList :: [UVUDPFlag] -> ShowS #
Storable UVUDPFlag Source #
Instance details Defined in Std.IO.UV.FFI Methods sizeOf :: UVUDPFlag -> Int # alignment :: UVUDPFlag -> Int # peekElemOff :: Ptr UVUDPFlag -> Int -> IO UVUDPFlag # pokeElemOff :: Ptr UVUDPFlag -> Int -> UVUDPFlag -> IO () # peekByteOff :: Ptr b -> Int -> IO UVUDPFlag # pokeByteOff :: Ptr b -> Int -> UVUDPFlag -> IO () # peek :: Ptr UVUDPFlag -> IO UVUDPFlag # poke :: Ptr UVUDPFlag -> UVUDPFlag -> IO () #
Bits UVUDPFlag Source #
Instance details Defined in Std.IO.UV.FFI Methods (.&.) :: UVUDPFlag -> UVUDPFlag -> UVUDPFlag # (.\|.) :: UVUDPFlag -> UVUDPFlag -> UVUDPFlag # xor :: UVUDPFlag -> UVUDPFlag -> UVUDPFlag # complement :: UVUDPFlag -> UVUDPFlag # shift :: UVUDPFlag -> Int -> UVUDPFlag # rotate :: UVUDPFlag -> Int -> UVUDPFlag # zeroBits :: UVUDPFlag # bit :: Int -> UVUDPFlag # setBit :: UVUDPFlag -> Int -> UVUDPFlag # clearBit :: UVUDPFlag -> Int -> UVUDPFlag # complementBit :: UVUDPFlag -> Int -> UVUDPFlag # testBit :: UVUDPFlag -> Int -> Bool # bitSizeMaybe :: UVUDPFlag -> Maybe Int # bitSize :: UVUDPFlag -> Int # isSigned :: UVUDPFlag -> Bool # shiftL :: UVUDPFlag -> Int -> UVUDPFlag # unsafeShiftL :: UVUDPFlag -> Int -> UVUDPFlag # shiftR :: UVUDPFlag -> Int -> UVUDPFlag # unsafeShiftR :: UVUDPFlag -> Int -> UVUDPFlag # rotateL :: UVUDPFlag -> Int -> UVUDPFlag # rotateR :: UVUDPFlag -> Int -> UVUDPFlag # popCount :: UVUDPFlag -> Int #
FiniteBits UVUDPFlag Source #
Instance details Defined in Std.IO.UV.FFI Methods finiteBitSize :: UVUDPFlag -> Int # countLeadingZeros :: UVUDPFlag -> Int # countTrailingZeros :: UVUDPFlag -> Int #

recvUDP :: HasCallStack => UDP -> IO [(Maybe SockAddr, Bool, Bytes)] Source #

Recv messages from UDP socket, return source address if available, and a Bool to indicate if the message is partial (larger than receive buffer size).

sendUDP :: HasCallStack => UDP -> SockAddr -> Bytes -> IO () Source #

Send a UDP message to target address.

WARNING: A InvalidArgument with errno UV_EMSGSIZE will be thrown if message is larger than sendMsgSize.

getSockName :: HasCallStack => UDP -> IO SockAddr Source #

multicast and broadcast

data UVMembership where Source #

Bundled Patterns

pattern UV_JOIN_GROUP :: UVMembership
pattern UV_LEAVE_GROUP :: UVMembership

Instances

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

setMembership :: HasCallStack => UDP -> CBytes -> CBytes -> UVMembership -> IO () Source #

setMulticastLoop :: HasCallStack => UDP -> Bool -> IO () Source #

setMulticastTTL :: HasCallStack => UDP -> Int -> IO () Source #

setMulticastInterface :: HasCallStack => UDP -> CBytes -> IO () Source #

setBroadcast :: HasCallStack => UDP -> Bool -> IO () Source #

setTTL :: HasCallStack => UDP -> Int -> IO () Source #