Netw.Socket

This module contains all the functions required to create and use sockets.

Documentation

newtype Socket

A file descriptor that is a socket. All socket used by this library is in nonblocking mode (O_NONBLOCK)

Constructors

MkSocket

Fields

• unSocket :: Fd

socket :: ProtocolFamily -> SocketType -> Protocol -> IO Socket

Create a new socket (see `man 3 socket`)

closeSocket :: Socket -> IO ()

Close a socket (see `man 3 close`)

bind :: SockAddr a => Socket -> a -> IO ()

Bind a socket to an address (see `man 3 bind`)

listen :: Socket -> Int -> IO ()

Mark a socket as accepting connection (see `man 3 listen`)

getsockname :: Socket -> IO Addr

Retrieve the name of the socket (see `man 3 getsockname`)

accept :: Socket -> IO (Socket, Addr)

Extract the first connection on the pending connection queue (see `man 3 accept`). This function blocks the calling thread until a connection is made.

accept_ :: Socket -> IO Socket

A version of accept which does not return the peer address

connect :: SockAddr a => Socket -> a -> IO ()

Try to connect to an address (see `man 3 connect`)

sendall :: Socket -> ByteArray -> MsgFlags -> IO ()

Send the whole content of a bytearray through a socket. Block until the entire bytearray has been sent.

send :: Socket -> ByteArray -> Int -> Int -> MsgFlags -> IO Int

`send socket buffer offset size flags` Send a range of bytes in buffer located at offset and is size bytes long. Return the number of bytes accually sent which may be less than the number of bytes specified. Block the current thread until some bytes are sent. (see `man 3 send`)

send' :: Socket -> Ptr Word8 -> Int -> MsgFlags -> IO Int

A version of send that accept a pointer instead of a bytearray.

sendallto :: SockAddr a => Socket -> ByteArray -> MsgFlags -> a -> IO ()

Send the whole content of a bytearray

sendto :: SockAddr a => Socket -> ByteArray -> Int -> Int -> MsgFlags -> a -> IO Int

A version of send that accept the destination address (see `man 3 sendto`) Return the number of bytes accually sent which may be less than the number of bytes specified. Block the thread until some bytes are sent.

sendto' :: SockAddr a => Socket -> Ptr Word8 -> Int -> MsgFlags -> a -> IO Int

A version of sendto that accept a pointer instead of a bytearray

sendmsg :: SockAddr a => Socket -> a -> [(ByteArray, Int, Int)] -> [AncillaryData] -> MsgFlags -> IO Int

`sendmsg socket address iovecs cmsgs flags` The iovecs argument is a list of 3-tuples of the data buffer, the offset in bytes, and the number of bytes to send. Use SockAddrNull if no address is to be specified. This function blocks the calling thread and return the number of bytes sent, which may be less than the intended message size.

(See `man 3 sendmsg`)

sendmsg' :: SockAddr a => Socket -> a -> [(Ptr Word8, Int)] -> [AncillaryData] -> MsgFlags -> IO Int

A version of sendmsg that uses pointers instead of bytearrays

recvsome :: Socket -> Int -> MsgFlags -> IO ByteArray

`recvsome socket n flags` Receive a maximum of n bytes from socket. Return the message as a bytearray. If the bytearray is empty (size == 0) then there is no more data to be read and the socket should be closed.

recv :: Socket -> MutableByteArray RealWorld -> Int -> Int -> MsgFlags -> IO Int

`recv socket buffer offset size flags` Receive a maximum of size bytes from socket, storing those bytes in buffer at offset Return the number of bytes received. (See `man 3 recv`) Block the calling thread until some bytes are received.

recv' :: Socket -> Ptr Word8 -> Int -> MsgFlags -> IO Int

A version of recv that takes a pointer instead of a mutablebytearray

recvfrom :: Socket -> MutableByteArray RealWorld -> Int -> Int -> MsgFlags -> IO (Int, Addr)

`recvfrom socket buffer offset size flags` Receive a message less than size bytes long and the source address. The bytes received are stored in buffer at offset Return the number of bytes received.

(See `man 3 recvfrom`)

recvfrom' :: Socket -> Ptr Word8 -> Int -> MsgFlags -> IO (Int, Addr)

A version of recvfrom that takes a pointer

recvsomefrom :: Socket -> Int -> MsgFlags -> IO (ByteArray, Addr)

A version of recvfrom that automatically allocates a bytearray

recvmsg :: Socket -> [(MutableByteArray RealWorld, Int, Int)] -> Int -> MsgFlags -> IO (Int, MsgFlags, [AncillaryData], Addr)

Receive messages alongside ancillary data. The elements of iovecs are tuples containing the storage bytearray, offset into bytearray, and the number of bytes to write to said bytearray.

(See `man 3 recvmsg`)

recvmsg_ :: Socket -> [(MutableByteArray RealWorld, Int, Int)] -> Int -> MsgFlags -> IO (Int, MsgFlags, [AncillaryData])

A version of recvmsg that does not return the address

shutdown :: Socket -> ShutHow -> IO ()

Shutdown all or part of of a duplex connection

newtype ProtocolFamily

Constructors

ProtocolFamily CInt

Instances

Eq ProtocolFamily

Defined in Netw.Internal.Enum

Methods

(==) :: ProtocolFamily -> ProtocolFamily -> Bool

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

pattern PF_UNIX :: ProtocolFamily

pattern PF_LOCAL :: ProtocolFamily

pattern PF_INET :: ProtocolFamily

pattern PF_AX25 :: ProtocolFamily

pattern PF_IPX :: ProtocolFamily

pattern PF_APPLETALK :: ProtocolFamily

pattern PF_NETROM :: ProtocolFamily

pattern PF_BRIDGE :: ProtocolFamily

pattern PF_ATMPVC :: ProtocolFamily

pattern PF_X25 :: ProtocolFamily

pattern PF_INET6 :: ProtocolFamily

pattern PF_ROSE :: ProtocolFamily

pattern PF_DECnet :: ProtocolFamily

pattern PF_NETBEUI :: ProtocolFamily

pattern PF_SECURITY :: ProtocolFamily

pattern PF_KEY :: ProtocolFamily

pattern PF_NETLINK :: ProtocolFamily

pattern PF_PACKET :: ProtocolFamily

pattern PF_ECONET :: ProtocolFamily

pattern PF_ATMSVC :: ProtocolFamily

pattern PF_RDS :: ProtocolFamily

pattern PF_IRDA :: ProtocolFamily

pattern PF_PPPOX :: ProtocolFamily

pattern PF_WANPIPE :: ProtocolFamily

pattern PF_LLC :: ProtocolFamily

pattern PF_IB :: ProtocolFamily

pattern PF_MPLS :: ProtocolFamily

pattern PF_CAN :: ProtocolFamily

pattern PF_TIPC :: ProtocolFamily

pattern PF_BLUETOOTH :: ProtocolFamily

pattern PF_IUCV :: ProtocolFamily

pattern PF_RXRPC :: ProtocolFamily

pattern PF_ISDN :: ProtocolFamily

pattern PF_PHONET :: ProtocolFamily

pattern PF_IEEE802154 :: ProtocolFamily

pattern PF_CAIF :: ProtocolFamily

pattern PF_ALG :: ProtocolFamily

pattern PF_VSOCK :: ProtocolFamily

pattern PF_KCM :: ProtocolFamily

pattern PF_QIPCRTR :: ProtocolFamily

pattern PF_SMC :: ProtocolFamily

pattern PF_XDP :: ProtocolFamily

newtype SocketType

Constructors

SocketType CInt

Instances

Bits SocketType

Defined in Netw.Internal.Enum

Methods

(.&.) :: SocketType -> SocketType -> SocketType

(.|.) :: SocketType -> SocketType -> SocketType

xor :: SocketType -> SocketType -> SocketType

complement :: SocketType -> SocketType

shift :: SocketType -> Int -> SocketType

rotate :: SocketType -> Int -> SocketType

zeroBits :: SocketType

bit :: Int -> SocketType

setBit :: SocketType -> Int -> SocketType

clearBit :: SocketType -> Int -> SocketType

complementBit :: SocketType -> Int -> SocketType

testBit :: SocketType -> Int -> Bool

bitSizeMaybe :: SocketType -> Maybe Int

bitSize :: SocketType -> Int

isSigned :: SocketType -> Bool

shiftL :: SocketType -> Int -> SocketType

unsafeShiftL :: SocketType -> Int -> SocketType

shiftR :: SocketType -> Int -> SocketType

unsafeShiftR :: SocketType -> Int -> SocketType

rotateL :: SocketType -> Int -> SocketType

rotateR :: SocketType -> Int -> SocketType

popCount :: SocketType -> Int

Eq SocketType

Defined in Netw.Internal.Enum

Methods

(==) :: SocketType -> SocketType -> Bool

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

pattern SOCK_STREAM :: SocketType

pattern SOCK_DGRAM :: SocketType

pattern SOCK_SEQPACKET :: SocketType

pattern SOCK_RAW :: SocketType

pattern SOCK_RDM :: SocketType

pattern SOCK_PACKET :: SocketType

pattern SOCK_NONBLOCK :: SocketType

pattern SOCK_CLOEXEC :: SocketType

newtype Protocol

Constructors

Protocol CInt

Instances

Eq Protocol

Defined in Netw.Internal.Enum

Methods

(==) :: Protocol -> Protocol -> Bool

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

pattern DefaultProtocol :: Protocol

pattern IPPROTO_RESERVED :: Protocol

pattern IPPROTO_NSH :: Protocol

pattern IPPROTO_AGGFRAG :: Protocol

pattern IPPROTO_ETHERNET :: Protocol

pattern IPPROTO_ROHC :: Protocol

pattern IPPROTO_WESP :: Protocol

pattern IPPROTO_SHIM6 :: Protocol

pattern IPPROTO_HIP :: Protocol

pattern IPPROTO_MANET :: Protocol

pattern IPPROTO_MPLS_IN_IP :: Protocol

pattern IPPROTO_UDPLITE :: Protocol

pattern IPPROTO_RSVP_E2E_IGNORE :: Protocol

pattern IPPROTO_FC :: Protocol

pattern IPPROTO_SCTP :: Protocol

pattern IPPROTO_PIPE :: Protocol

pattern IPPROTO_SPS :: Protocol

pattern IPPROTO_IPLT :: Protocol

pattern IPPROTO_SSCOPMCE :: Protocol

pattern IPPROTO_CRUDP :: Protocol

pattern IPPROTO_CRTP :: Protocol

pattern IPPROTO_FIRE :: Protocol

pattern IPPROTO_PTP :: Protocol

pattern IPPROTO_SMP :: Protocol

pattern IPPROTO_UTI :: Protocol

pattern IPPROTO_SRP :: Protocol

pattern IPPROTO_STP :: Protocol

pattern IPPROTO_IATP :: Protocol

pattern IPPROTO_DDX :: Protocol

pattern IPPROTO_L2TP :: Protocol

pattern IPPROTO_PGM :: Protocol

pattern IPPROTO_VRRP :: Protocol

pattern IPPROTO_IPX_IN_IP :: Protocol

pattern IPPROTO_COMPAQ_PEER :: Protocol

pattern IPPROTO_SNP :: Protocol

pattern IPPROTO_IPCOMP :: Protocol

pattern IPPROTO_A_N :: Protocol

pattern IPPROTO_QNX :: Protocol

pattern IPPROTO_SCPS :: Protocol

pattern IPPROTO_ARIS :: Protocol

pattern IPPROTO_PIM :: Protocol

pattern IPPROTO_PNNI :: Protocol

pattern IPPROTO_IFMP :: Protocol

pattern IPPROTO_GMTP :: Protocol

pattern IPPROTO_ENCAP :: Protocol

pattern IPPROTO_ETHERIP :: Protocol

pattern IPPROTO_SCC_SP :: Protocol

pattern IPPROTO_IPIP :: Protocol

pattern IPPROTO_AX_25 :: Protocol

pattern IPPROTO_MTP :: Protocol

pattern IPPROTO_LARP :: Protocol

pattern IPPROTO_SPRITE_RPC :: Protocol

pattern IPPROTO_OSPFIGP :: Protocol

pattern IPPROTO_EIGRP :: Protocol

pattern IPPROTO_TCF :: Protocol

pattern IPPROTO_DGP :: Protocol

pattern IPPROTO_NSFNET_IGP :: Protocol

pattern IPPROTO_IPTM :: Protocol

pattern IPPROTO_VINES :: Protocol

pattern IPPROTO_SECURE_VMTP :: Protocol

pattern IPPROTO_VMTP :: Protocol

pattern IPPROTO_ISO_IP :: Protocol

pattern IPPROTO_WB_EXPAK :: Protocol

pattern IPPROTO_WB_MON :: Protocol

pattern IPPROTO_SUN_ND :: Protocol

pattern IPPROTO_BR_SAT_MON :: Protocol

pattern IPPROTO_PVP :: Protocol

pattern IPPROTO_WSN :: Protocol

pattern IPPROTO_CPHB :: Protocol

pattern IPPROTO_CPNX :: Protocol

pattern IPPROTO_IPCV :: Protocol

pattern IPPROTO_VISA :: Protocol

pattern IPPROTO_SAT_MON :: Protocol

pattern IPPROTO_IPPC :: Protocol

pattern IPPROTO_RVD :: Protocol

pattern IPPROTO_KRYPTOLAN :: Protocol

pattern IPPROTO_SAT_EXPAK :: Protocol

pattern IPPROTO_CFTP :: Protocol

pattern IPPROTO_IPV6_OPTS :: Protocol

pattern IPPROTO_IPV6_NONXT :: Protocol

pattern IPPROTO_IPV6_ICMP :: Protocol

pattern IPPROTO_SKIP :: Protocol

pattern IPPROTO_TLSP :: Protocol

pattern IPPROTO_MIN_IPV4 :: Protocol

pattern IPPROTO_NARP :: Protocol

pattern IPPROTO_I_NLSP :: Protocol

pattern IPPROTO_AH :: Protocol

pattern IPPROTO_ESP :: Protocol

pattern IPPROTO_BNA :: Protocol

pattern IPPROTO_DSR :: Protocol

pattern IPPROTO_GRE :: Protocol

pattern IPPROTO_RSVP :: Protocol

pattern IPPROTO_IDRP :: Protocol

pattern IPPROTO_IPV6_FRAG :: Protocol

pattern IPPROTO_IPV6_ROUTE :: Protocol

pattern IPPROTO_SDRP :: Protocol

pattern IPPROTO_IPV6 :: Protocol

pattern IPPROTO_IL :: Protocol

pattern IPPROTO_TPpp :: Protocol

pattern IPPROTO_IDPR_CMTP :: Protocol

pattern IPPROTO_DDP :: Protocol

pattern IPPROTO_XTP :: Protocol

pattern IPPROTO_IDPR :: Protocol

pattern IPPROTO_3PC :: Protocol

pattern IPPROTO_DCCP :: Protocol

pattern IPPROTO_MERIT_INP :: Protocol

pattern IPPROTO_MFE_NSP :: Protocol

pattern IPPROTO_NETBLT :: Protocol

pattern IPPROTO_ISO_TP4 :: Protocol

pattern IPPROTO_IRTP :: Protocol

pattern IPPROTO_RDP :: Protocol

pattern IPPROTO_LEAF_2 :: Protocol

pattern IPPROTO_LEAF_1 :: Protocol

pattern IPPROTO_TRUNK_2 :: Protocol

pattern IPPROTO_TRUNK_1 :: Protocol

pattern IPPROTO_XNS_IDP :: Protocol

pattern IPPROTO_PRM :: Protocol

pattern IPPROTO_HMP :: Protocol

pattern IPPROTO_DCN_MEAS :: Protocol

pattern IPPROTO_MUX :: Protocol

pattern IPPROTO_UDP :: Protocol

pattern IPPROTO_CHAOS :: Protocol

pattern IPPROTO_XNET :: Protocol

pattern IPPROTO_EMCON :: Protocol

pattern IPPROTO_PUP :: Protocol

pattern IPPROTO_NVP_II :: Protocol

pattern IPPROTO_BBN_RCC_MON :: Protocol

pattern IPPROTO_IGP :: Protocol

pattern IPPROTO_EGP :: Protocol

pattern IPPROTO_CBT :: Protocol

pattern IPPROTO_TCP :: Protocol

pattern IPPROTO_ST :: Protocol

pattern IPPROTO_IPV4 :: Protocol

pattern IPPROTO_GGP :: Protocol

pattern IPPROTO_IGMP :: Protocol

pattern IPPROTO_ICMP :: Protocol

pattern IPPROTO_HOPOPT :: Protocol

pattern IPPROTO_IP :: Protocol

pattern IPPROTO_RAW :: Protocol

pattern IPPROTO_MPTCP :: Protocol

pattern IPPROTO_MH :: Protocol

newtype MsgFlags

Constructors

MsgFlags CInt

Instances

Storable MsgFlags

Defined in Netw.Internal.Enum

Methods

sizeOf :: MsgFlags -> Int

alignment :: MsgFlags -> Int

peekElemOff :: Ptr MsgFlags -> Int -> IO MsgFlags

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

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

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

peek :: Ptr MsgFlags -> IO MsgFlags

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

Bits MsgFlags

Defined in Netw.Internal.Enum

Methods

(.&.) :: MsgFlags -> MsgFlags -> MsgFlags

(.|.) :: MsgFlags -> MsgFlags -> MsgFlags

xor :: MsgFlags -> MsgFlags -> MsgFlags

complement :: MsgFlags -> MsgFlags

shift :: MsgFlags -> Int -> MsgFlags

rotate :: MsgFlags -> Int -> MsgFlags

zeroBits :: MsgFlags

bit :: Int -> MsgFlags

setBit :: MsgFlags -> Int -> MsgFlags

clearBit :: MsgFlags -> Int -> MsgFlags

complementBit :: MsgFlags -> Int -> MsgFlags

testBit :: MsgFlags -> Int -> Bool

bitSizeMaybe :: MsgFlags -> Maybe Int

bitSize :: MsgFlags -> Int

isSigned :: MsgFlags -> Bool

shiftL :: MsgFlags -> Int -> MsgFlags

unsafeShiftL :: MsgFlags -> Int -> MsgFlags

shiftR :: MsgFlags -> Int -> MsgFlags

unsafeShiftR :: MsgFlags -> Int -> MsgFlags

rotateL :: MsgFlags -> Int -> MsgFlags

rotateR :: MsgFlags -> Int -> MsgFlags

popCount :: MsgFlags -> Int

Eq MsgFlags

Defined in Netw.Internal.Enum

Methods

(==) :: MsgFlags -> MsgFlags -> Bool

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

pattern MSG_EOR :: MsgFlags

pattern MSG_OOB :: MsgFlags

pattern MSG_NOSIGNAL :: MsgFlags

pattern MSG_PEEK :: MsgFlags

pattern MSG_WAITALL :: MsgFlags

pattern MSG_TRUNC :: MsgFlags

pattern MSG_CTRUNC :: MsgFlags

pattern MSG_CONFIRM :: MsgFlags

pattern MSG_DONTROUTE :: MsgFlags

pattern MSG_DONTWAIT :: MsgFlags

pattern MSG_MORE :: MsgFlags

pattern MSG_FASTOPEN :: MsgFlags

pattern MSG_CMSG_CLOEXEC :: MsgFlags

pattern MSG_ERRQUEUE :: MsgFlags

newtype ShutHow

Constructors

ShutHow CInt

pattern SHUT_RD :: ShutHow

pattern SHUT_WR :: ShutHow

pattern SHUT_RDWR :: ShutHow