netw-0.1.1.0: Binding to C socket API operating on bytearrays.
Safe HaskellSafe-Inferred
LanguageGHC2021

Netw.Socket

Description

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

Synopsis

Documentation

newtype Socket Source #

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

Constructors

MkSocket 

Fields

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

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

closeSocket :: Socket -> IO () Source #

Close a socket (see `man 3 close`)

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

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

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

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

getsockname :: Socket -> IO Addr Source #

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

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

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

A version of accept which does not return the peer address

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

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

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

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

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

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

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

Send the whole content of a bytearray

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

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

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

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

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

A version of sendmsg that uses pointers instead of bytearrays

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

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

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

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

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

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

A version of recvfrom that takes a pointer

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

A version of recvfrom that automatically allocates a bytearray

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

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

A version of recvmsg that does not return the address

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

Shutdown all or part of of a duplex connection

newtype ProtocolFamily Source #

Constructors

ProtocolFamily CInt 

Instances

Instances details
Eq ProtocolFamily Source # 
Instance details

Defined in Netw.Internal.Enum

Methods

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

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

pattern PF_UNIX :: ProtocolFamily Source #

pattern PF_LOCAL :: ProtocolFamily Source #

pattern PF_INET :: ProtocolFamily Source #

pattern PF_AX25 :: ProtocolFamily Source #

pattern PF_IPX :: ProtocolFamily Source #

pattern PF_APPLETALK :: ProtocolFamily Source #

pattern PF_NETROM :: ProtocolFamily Source #

pattern PF_BRIDGE :: ProtocolFamily Source #

pattern PF_ATMPVC :: ProtocolFamily Source #

pattern PF_X25 :: ProtocolFamily Source #

pattern PF_INET6 :: ProtocolFamily Source #

pattern PF_ROSE :: ProtocolFamily Source #

pattern PF_DECnet :: ProtocolFamily Source #

pattern PF_NETBEUI :: ProtocolFamily Source #

pattern PF_SECURITY :: ProtocolFamily Source #

pattern PF_KEY :: ProtocolFamily Source #

pattern PF_NETLINK :: ProtocolFamily Source #

pattern PF_PACKET :: ProtocolFamily Source #

pattern PF_ECONET :: ProtocolFamily Source #

pattern PF_ATMSVC :: ProtocolFamily Source #

pattern PF_RDS :: ProtocolFamily Source #

pattern PF_IRDA :: ProtocolFamily Source #

pattern PF_PPPOX :: ProtocolFamily Source #

pattern PF_WANPIPE :: ProtocolFamily Source #

pattern PF_LLC :: ProtocolFamily Source #

pattern PF_IB :: ProtocolFamily Source #

pattern PF_MPLS :: ProtocolFamily Source #

pattern PF_CAN :: ProtocolFamily Source #

pattern PF_TIPC :: ProtocolFamily Source #

pattern PF_BLUETOOTH :: ProtocolFamily Source #

pattern PF_IUCV :: ProtocolFamily Source #

pattern PF_RXRPC :: ProtocolFamily Source #

pattern PF_ISDN :: ProtocolFamily Source #

pattern PF_PHONET :: ProtocolFamily Source #

pattern PF_IEEE802154 :: ProtocolFamily Source #

pattern PF_CAIF :: ProtocolFamily Source #

pattern PF_ALG :: ProtocolFamily Source #

pattern PF_VSOCK :: ProtocolFamily Source #

pattern PF_KCM :: ProtocolFamily Source #

pattern PF_QIPCRTR :: ProtocolFamily Source #

pattern PF_SMC :: ProtocolFamily Source #

pattern PF_XDP :: ProtocolFamily Source #

newtype SocketType Source #

Constructors

SocketType CInt 

Instances

Instances details
Bits SocketType Source # 
Instance details

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

Defined in Netw.Internal.Enum

Methods

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

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

pattern SOCK_STREAM :: SocketType Source #

pattern SOCK_DGRAM :: SocketType Source #

pattern SOCK_SEQPACKET :: SocketType Source #

pattern SOCK_RAW :: SocketType Source #

pattern SOCK_RDM :: SocketType Source #

pattern SOCK_PACKET :: SocketType Source #

pattern SOCK_NONBLOCK :: SocketType Source #

pattern SOCK_CLOEXEC :: SocketType Source #

newtype Protocol Source #

Constructors

Protocol CInt 

Instances

Instances details
Eq Protocol Source # 
Instance details

Defined in Netw.Internal.Enum

Methods

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

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

pattern DefaultProtocol :: Protocol Source #

pattern IPPROTO_RESERVED :: Protocol Source #

pattern IPPROTO_NSH :: Protocol Source #

pattern IPPROTO_AGGFRAG :: Protocol Source #

pattern IPPROTO_ETHERNET :: Protocol Source #

pattern IPPROTO_ROHC :: Protocol Source #

pattern IPPROTO_WESP :: Protocol Source #

pattern IPPROTO_SHIM6 :: Protocol Source #

pattern IPPROTO_HIP :: Protocol Source #

pattern IPPROTO_MANET :: Protocol Source #

pattern IPPROTO_MPLS_IN_IP :: Protocol Source #

pattern IPPROTO_UDPLITE :: Protocol Source #

pattern IPPROTO_RSVP_E2E_IGNORE :: Protocol Source #

pattern IPPROTO_FC :: Protocol Source #

pattern IPPROTO_SCTP :: Protocol Source #

pattern IPPROTO_PIPE :: Protocol Source #

pattern IPPROTO_SPS :: Protocol Source #

pattern IPPROTO_IPLT :: Protocol Source #

pattern IPPROTO_SSCOPMCE :: Protocol Source #

pattern IPPROTO_CRUDP :: Protocol Source #

pattern IPPROTO_CRTP :: Protocol Source #

pattern IPPROTO_FIRE :: Protocol Source #

pattern IPPROTO_PTP :: Protocol Source #

pattern IPPROTO_SMP :: Protocol Source #

pattern IPPROTO_UTI :: Protocol Source #

pattern IPPROTO_SRP :: Protocol Source #

pattern IPPROTO_STP :: Protocol Source #

pattern IPPROTO_IATP :: Protocol Source #

pattern IPPROTO_DDX :: Protocol Source #

pattern IPPROTO_L2TP :: Protocol Source #

pattern IPPROTO_PGM :: Protocol Source #

pattern IPPROTO_VRRP :: Protocol Source #

pattern IPPROTO_IPX_IN_IP :: Protocol Source #

pattern IPPROTO_COMPAQ_PEER :: Protocol Source #

pattern IPPROTO_SNP :: Protocol Source #

pattern IPPROTO_IPCOMP :: Protocol Source #

pattern IPPROTO_A_N :: Protocol Source #

pattern IPPROTO_QNX :: Protocol Source #

pattern IPPROTO_SCPS :: Protocol Source #

pattern IPPROTO_ARIS :: Protocol Source #

pattern IPPROTO_PIM :: Protocol Source #

pattern IPPROTO_PNNI :: Protocol Source #

pattern IPPROTO_IFMP :: Protocol Source #

pattern IPPROTO_GMTP :: Protocol Source #

pattern IPPROTO_ENCAP :: Protocol Source #

pattern IPPROTO_ETHERIP :: Protocol Source #

pattern IPPROTO_SCC_SP :: Protocol Source #

pattern IPPROTO_IPIP :: Protocol Source #

pattern IPPROTO_AX_25 :: Protocol Source #

pattern IPPROTO_MTP :: Protocol Source #

pattern IPPROTO_LARP :: Protocol Source #

pattern IPPROTO_SPRITE_RPC :: Protocol Source #

pattern IPPROTO_OSPFIGP :: Protocol Source #

pattern IPPROTO_EIGRP :: Protocol Source #

pattern IPPROTO_TCF :: Protocol Source #

pattern IPPROTO_DGP :: Protocol Source #

pattern IPPROTO_NSFNET_IGP :: Protocol Source #

pattern IPPROTO_IPTM :: Protocol Source #

pattern IPPROTO_VINES :: Protocol Source #

pattern IPPROTO_SECURE_VMTP :: Protocol Source #

pattern IPPROTO_VMTP :: Protocol Source #

pattern IPPROTO_ISO_IP :: Protocol Source #

pattern IPPROTO_WB_EXPAK :: Protocol Source #

pattern IPPROTO_WB_MON :: Protocol Source #

pattern IPPROTO_SUN_ND :: Protocol Source #

pattern IPPROTO_BR_SAT_MON :: Protocol Source #

pattern IPPROTO_PVP :: Protocol Source #

pattern IPPROTO_WSN :: Protocol Source #

pattern IPPROTO_CPHB :: Protocol Source #

pattern IPPROTO_CPNX :: Protocol Source #

pattern IPPROTO_IPCV :: Protocol Source #

pattern IPPROTO_VISA :: Protocol Source #

pattern IPPROTO_SAT_MON :: Protocol Source #

pattern IPPROTO_IPPC :: Protocol Source #

pattern IPPROTO_RVD :: Protocol Source #

pattern IPPROTO_KRYPTOLAN :: Protocol Source #

pattern IPPROTO_SAT_EXPAK :: Protocol Source #

pattern IPPROTO_CFTP :: Protocol Source #

pattern IPPROTO_IPV6_OPTS :: Protocol Source #

pattern IPPROTO_IPV6_NONXT :: Protocol Source #

pattern IPPROTO_IPV6_ICMP :: Protocol Source #

pattern IPPROTO_SKIP :: Protocol Source #

pattern IPPROTO_TLSP :: Protocol Source #

pattern IPPROTO_MIN_IPV4 :: Protocol Source #

pattern IPPROTO_NARP :: Protocol Source #

pattern IPPROTO_I_NLSP :: Protocol Source #

pattern IPPROTO_AH :: Protocol Source #

pattern IPPROTO_ESP :: Protocol Source #

pattern IPPROTO_BNA :: Protocol Source #

pattern IPPROTO_DSR :: Protocol Source #

pattern IPPROTO_GRE :: Protocol Source #

pattern IPPROTO_RSVP :: Protocol Source #

pattern IPPROTO_IDRP :: Protocol Source #

pattern IPPROTO_IPV6_FRAG :: Protocol Source #

pattern IPPROTO_IPV6_ROUTE :: Protocol Source #

pattern IPPROTO_SDRP :: Protocol Source #

pattern IPPROTO_IPV6 :: Protocol Source #

pattern IPPROTO_IL :: Protocol Source #

pattern IPPROTO_TPpp :: Protocol Source #

pattern IPPROTO_IDPR_CMTP :: Protocol Source #

pattern IPPROTO_DDP :: Protocol Source #

pattern IPPROTO_XTP :: Protocol Source #

pattern IPPROTO_IDPR :: Protocol Source #

pattern IPPROTO_3PC :: Protocol Source #

pattern IPPROTO_DCCP :: Protocol Source #

pattern IPPROTO_MERIT_INP :: Protocol Source #

pattern IPPROTO_MFE_NSP :: Protocol Source #

pattern IPPROTO_NETBLT :: Protocol Source #

pattern IPPROTO_ISO_TP4 :: Protocol Source #

pattern IPPROTO_IRTP :: Protocol Source #

pattern IPPROTO_RDP :: Protocol Source #

pattern IPPROTO_LEAF_2 :: Protocol Source #

pattern IPPROTO_LEAF_1 :: Protocol Source #

pattern IPPROTO_TRUNK_2 :: Protocol Source #

pattern IPPROTO_TRUNK_1 :: Protocol Source #

pattern IPPROTO_XNS_IDP :: Protocol Source #

pattern IPPROTO_PRM :: Protocol Source #

pattern IPPROTO_HMP :: Protocol Source #

pattern IPPROTO_DCN_MEAS :: Protocol Source #

pattern IPPROTO_MUX :: Protocol Source #

pattern IPPROTO_UDP :: Protocol Source #

pattern IPPROTO_CHAOS :: Protocol Source #

pattern IPPROTO_XNET :: Protocol Source #

pattern IPPROTO_EMCON :: Protocol Source #

pattern IPPROTO_PUP :: Protocol Source #

pattern IPPROTO_NVP_II :: Protocol Source #

pattern IPPROTO_BBN_RCC_MON :: Protocol Source #

pattern IPPROTO_IGP :: Protocol Source #

pattern IPPROTO_EGP :: Protocol Source #

pattern IPPROTO_CBT :: Protocol Source #

pattern IPPROTO_TCP :: Protocol Source #

pattern IPPROTO_ST :: Protocol Source #

pattern IPPROTO_IPV4 :: Protocol Source #

pattern IPPROTO_GGP :: Protocol Source #

pattern IPPROTO_IGMP :: Protocol Source #

pattern IPPROTO_ICMP :: Protocol Source #

pattern IPPROTO_HOPOPT :: Protocol Source #

pattern IPPROTO_IP :: Protocol Source #

pattern IPPROTO_RAW :: Protocol Source #

pattern IPPROTO_MPTCP :: Protocol Source #

pattern IPPROTO_MH :: Protocol Source #

newtype MsgFlags Source #

Constructors

MsgFlags CInt 

Instances

Instances details
Storable MsgFlags Source # 
Instance details

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

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

Defined in Netw.Internal.Enum

Methods

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

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

pattern MSG_EOR :: MsgFlags Source #

pattern MSG_OOB :: MsgFlags Source #

pattern MSG_NOSIGNAL :: MsgFlags Source #

pattern MSG_PEEK :: MsgFlags Source #

pattern MSG_WAITALL :: MsgFlags Source #

pattern MSG_TRUNC :: MsgFlags Source #

pattern MSG_CTRUNC :: MsgFlags Source #

pattern MSG_CONFIRM :: MsgFlags Source #

pattern MSG_DONTROUTE :: MsgFlags Source #

pattern MSG_DONTWAIT :: MsgFlags Source #

pattern MSG_MORE :: MsgFlags Source #

pattern MSG_FASTOPEN :: MsgFlags Source #

pattern MSG_CMSG_CLOEXEC :: MsgFlags Source #

pattern MSG_ERRQUEUE :: MsgFlags Source #

newtype ShutHow Source #

Constructors

ShutHow CInt 

pattern SHUT_RD :: ShutHow Source #

pattern SHUT_WR :: ShutHow Source #

pattern SHUT_RDWR :: ShutHow Source #