Safe Haskell	None
Language	Haskell98

System.Posix.Socket

Contents

Socket types
Socket operations

Description

POSIX sockets.

Synopsis

Socket types

data Socket f Source #

Socket of a particular family.

Instances

Eq (Socket f) Source #
Methods (==) :: Socket f -> Socket f -> Bool # (/=) :: Socket f -> Socket f -> Bool #

withSocketFd :: MonadBase IO μ => Socket f -> (Fd -> IO α) -> μ α Source #

Lock the socket and pass the underlying file descriptor to the given action.

unsafeSocketFd :: MonadBase IO μ => Socket f -> μ Fd Source #

Get the underlying file descriptor.

unsafeSocketFromFd :: MonadBase IO μ => Fd -> μ (Socket f) Source #

Use file descriptor as a socket.

class SockAddr (SockFamilyAddr f) => SockFamily f where Source #

Socket family.

Minimal complete definition

sockFamilyCode

Associated Types

type SockFamilyAddr f Source #

Methods

sockFamilyCode :: Proxy f -> CInt Source #

Socket family code.

Instances

SockFamily AF_INET6 Source #
Associated Types type SockFamilyAddr AF_INET6 :: * Source # Methods sockFamilyCode :: Proxy * AF_INET6 -> CInt Source #
SockFamily AF_INET Source #
Associated Types type SockFamilyAddr AF_INET :: * Source # Methods sockFamilyCode :: Proxy * AF_INET -> CInt Source #
SockFamily AF_LOCAL Source #
Associated Types type SockFamilyAddr AF_LOCAL :: * Source # Methods sockFamilyCode :: Proxy * AF_LOCAL -> CInt Source #

class SockAddr a where Source #

Socket address.

Minimal complete definition

sockAddrMaxSize, sockAddrSize, peekSockAddr, pokeSockAddr

Methods

sockAddrMaxSize :: Proxy a -> Int Source #

Maximum size of a socket address.

sockAddrSize :: a -> Int Source #

Size of a particular socket address.

peekSockAddr Source #

Arguments

:: Ptr a	Buffer
-> Int	Buffer size
-> IO a

Read socket address from a memory buffer.

pokeSockAddr Source #

Arguments

:: Ptr a	Buffer of sufficient size
-> a	The address to poke
-> IO ()

Write socket address to a memory buffer.

Instances

SockAddr LocalAddr Source #
Methods sockAddrMaxSize :: Proxy * LocalAddr -> Int Source # sockAddrSize :: LocalAddr -> Int Source # peekSockAddr :: Ptr LocalAddr -> Int -> IO LocalAddr Source # pokeSockAddr :: Ptr LocalAddr -> LocalAddr -> IO () Source #

newtype SockType Source #

Socket type.

Constructors

SockType CInt

Instances

Eq SockType Source #
Methods (==) :: SockType -> SockType -> Bool # (/=) :: SockType -> SockType -> Bool #
Ord SockType Source #
Methods compare :: SockType -> SockType -> Ordering # (<) :: SockType -> SockType -> Bool # (<=) :: SockType -> SockType -> Bool # (>) :: SockType -> SockType -> Bool # (>=) :: SockType -> SockType -> Bool # max :: SockType -> SockType -> SockType # min :: SockType -> SockType -> SockType #
Show SockType Source #
Methods showsPrec :: Int -> SockType -> ShowS # show :: SockType -> String # showList :: [SockType] -> ShowS #
Storable SockType Source #
Methods sizeOf :: SockType -> Int # alignment :: SockType -> Int # peekElemOff :: Ptr SockType -> Int -> IO SockType # pokeElemOff :: Ptr SockType -> Int -> SockType -> IO () # peekByteOff :: Ptr b -> Int -> IO SockType # pokeByteOff :: Ptr b -> Int -> SockType -> IO () # peek :: Ptr SockType -> IO SockType # poke :: Ptr SockType -> SockType -> IO () #

pattern SOCK_STREAM :: SockType Source #

See socket(2).

pattern SOCK_DGRAM :: SockType Source #

See socket(2).

pattern SOCK_RAW :: SockType Source #

See socket(2).

pattern SOCK_RDM :: SockType Source #

See socket(2).

pattern SOCK_SEQPACKET :: SockType Source #

See socket(2).

newtype SockProto Source #

Socket protocol.

Constructors

SockProto CInt

Instances

Eq SockProto Source #
Methods (==) :: SockProto -> SockProto -> Bool # (/=) :: SockProto -> SockProto -> Bool #
Ord SockProto Source #
Methods compare :: SockProto -> SockProto -> Ordering # (<) :: SockProto -> SockProto -> Bool # (<=) :: SockProto -> SockProto -> Bool # (>) :: SockProto -> SockProto -> Bool # (>=) :: SockProto -> SockProto -> Bool # max :: SockProto -> SockProto -> SockProto # min :: SockProto -> SockProto -> SockProto #
Show SockProto Source #
Methods showsPrec :: Int -> SockProto -> ShowS # show :: SockProto -> String # showList :: [SockProto] -> ShowS #
Storable SockProto Source #
Methods sizeOf :: SockProto -> Int # alignment :: SockProto -> Int # peekElemOff :: Ptr SockProto -> Int -> IO SockProto # pokeElemOff :: Ptr SockProto -> Int -> SockProto -> IO () # peekByteOff :: Ptr b -> Int -> IO SockProto # pokeByteOff :: Ptr b -> Int -> SockProto -> IO () # peek :: Ptr SockProto -> IO SockProto # poke :: Ptr SockProto -> SockProto -> IO () #
Default SockProto Source #
Methods def :: SockProto #

defaultSockProto :: SockProto Source #

Default socket protocol (corresponds to 0).

class Storable (SockOptRaw o) => SockOpt o where Source #

Socket option.

Minimal complete definition

sockOptRaw, sockOptValue, sockOptLevel, sockOptCode

Associated Types

type SockOptValue o Source #

Option value type

type SockOptRaw o Source #

FFI-level option value type

type SockOptReadable o :: Bool Source #

Whether option is readable

type SockOptWritable o :: Bool Source #

Whether option is writable

Methods

sockOptRaw :: Proxy o -> SockOptValue o -> SockOptRaw o Source #

Convert to FFI-level value

sockOptValue :: Proxy o -> SockOptRaw o -> SockOptValue o Source #

Convert from FFI-level value

sockOptLevel :: Proxy o -> CInt Source #

Option protocol level

sockOptCode :: Proxy o -> CInt Source #

Option code

Instances

SockOpt SO_REUSEADDR Source #
Associated Types type SockOptValue SO_REUSEADDR :: * Source # type SockOptRaw SO_REUSEADDR :: * Source # type SockOptReadable SO_REUSEADDR :: Bool Source # type SockOptWritable SO_REUSEADDR :: Bool Source # Methods sockOptRaw :: Proxy * SO_REUSEADDR -> SockOptValue SO_REUSEADDR -> SockOptRaw SO_REUSEADDR Source # sockOptValue :: Proxy * SO_REUSEADDR -> SockOptRaw SO_REUSEADDR -> SockOptValue SO_REUSEADDR Source # sockOptLevel :: Proxy * SO_REUSEADDR -> CInt Source # sockOptCode :: Proxy * SO_REUSEADDR -> CInt Source #
SockOpt SO_KEEPALIVE Source #
Associated Types type SockOptValue SO_KEEPALIVE :: * Source # type SockOptRaw SO_KEEPALIVE :: * Source # type SockOptReadable SO_KEEPALIVE :: Bool Source # type SockOptWritable SO_KEEPALIVE :: Bool Source # Methods sockOptRaw :: Proxy * SO_KEEPALIVE -> SockOptValue SO_KEEPALIVE -> SockOptRaw SO_KEEPALIVE Source # sockOptValue :: Proxy * SO_KEEPALIVE -> SockOptRaw SO_KEEPALIVE -> SockOptValue SO_KEEPALIVE Source # sockOptLevel :: Proxy * SO_KEEPALIVE -> CInt Source # sockOptCode :: Proxy * SO_KEEPALIVE -> CInt Source #
SockOpt SO_ERROR Source #
Associated Types type SockOptValue SO_ERROR :: * Source # type SockOptRaw SO_ERROR :: * Source # type SockOptReadable SO_ERROR :: Bool Source # type SockOptWritable SO_ERROR :: Bool Source # Methods sockOptRaw :: Proxy * SO_ERROR -> SockOptValue SO_ERROR -> SockOptRaw SO_ERROR Source # sockOptValue :: Proxy * SO_ERROR -> SockOptRaw SO_ERROR -> SockOptValue SO_ERROR Source # sockOptLevel :: Proxy * SO_ERROR -> CInt Source # sockOptCode :: Proxy * SO_ERROR -> CInt Source #

data SO_ERROR Source #

Instances

SockOpt SO_ERROR Source #
Associated Types type SockOptValue SO_ERROR :: * Source # type SockOptRaw SO_ERROR :: * Source # type SockOptReadable SO_ERROR :: Bool Source # type SockOptWritable SO_ERROR :: Bool Source # Methods sockOptRaw :: Proxy * SO_ERROR -> SockOptValue SO_ERROR -> SockOptRaw SO_ERROR Source # sockOptValue :: Proxy * SO_ERROR -> SockOptRaw SO_ERROR -> SockOptValue SO_ERROR Source # sockOptLevel :: Proxy * SO_ERROR -> CInt Source # sockOptCode :: Proxy * SO_ERROR -> CInt Source #
type SockOptValue SO_ERROR Source #
type SockOptValue SO_ERROR = Errno
type SockOptRaw SO_ERROR Source #
type SockOptRaw SO_ERROR = CInt
type SockOptReadable SO_ERROR Source #
type SockOptReadable SO_ERROR = True
type SockOptWritable SO_ERROR Source #
type SockOptWritable SO_ERROR = False

pattern SO_ERROR :: Proxy SO_ERROR Source #

data SO_KEEPALIVE Source #

Instances

SockOpt SO_KEEPALIVE Source #
Associated Types type SockOptValue SO_KEEPALIVE :: * Source # type SockOptRaw SO_KEEPALIVE :: * Source # type SockOptReadable SO_KEEPALIVE :: Bool Source # type SockOptWritable SO_KEEPALIVE :: Bool Source # Methods sockOptRaw :: Proxy * SO_KEEPALIVE -> SockOptValue SO_KEEPALIVE -> SockOptRaw SO_KEEPALIVE Source # sockOptValue :: Proxy * SO_KEEPALIVE -> SockOptRaw SO_KEEPALIVE -> SockOptValue SO_KEEPALIVE Source # sockOptLevel :: Proxy * SO_KEEPALIVE -> CInt Source # sockOptCode :: Proxy * SO_KEEPALIVE -> CInt Source #
type SockOptValue SO_KEEPALIVE Source #
type SockOptValue SO_KEEPALIVE = Bool
type SockOptRaw SO_KEEPALIVE Source #
type SockOptRaw SO_KEEPALIVE = CInt
type SockOptReadable SO_KEEPALIVE Source #
type SockOptReadable SO_KEEPALIVE = True
type SockOptWritable SO_KEEPALIVE Source #
type SockOptWritable SO_KEEPALIVE = True

pattern SO_KEEPALIVE :: Proxy SO_KEEPALIVE Source #

data SO_REUSEADDR Source #

Instances

SockOpt SO_REUSEADDR Source #
Associated Types type SockOptValue SO_REUSEADDR :: * Source # type SockOptRaw SO_REUSEADDR :: * Source # type SockOptReadable SO_REUSEADDR :: Bool Source # type SockOptWritable SO_REUSEADDR :: Bool Source # Methods sockOptRaw :: Proxy * SO_REUSEADDR -> SockOptValue SO_REUSEADDR -> SockOptRaw SO_REUSEADDR Source # sockOptValue :: Proxy * SO_REUSEADDR -> SockOptRaw SO_REUSEADDR -> SockOptValue SO_REUSEADDR Source # sockOptLevel :: Proxy * SO_REUSEADDR -> CInt Source # sockOptCode :: Proxy * SO_REUSEADDR -> CInt Source #
type SockOptValue SO_REUSEADDR Source #
type SockOptValue SO_REUSEADDR = Bool
type SockOptRaw SO_REUSEADDR Source #
type SockOptRaw SO_REUSEADDR = CInt
type SockOptReadable SO_REUSEADDR Source #
type SockOptReadable SO_REUSEADDR = True
type SockOptWritable SO_REUSEADDR Source #
type SockOptWritable SO_REUSEADDR = True

pattern SO_REUSEADDR :: Proxy SO_REUSEADDR Source #

data SockOps Source #

Socket operations.

Constructors

NoSockOps
RecvSockOps
SendSockOps
AllSockOps

Instances

Eq SockOps Source #
Methods (==) :: SockOps -> SockOps -> Bool # (/=) :: SockOps -> SockOps -> Bool #
Read SockOps Source #
Methods readsPrec :: Int -> ReadS SockOps # readList :: ReadS [SockOps] # readPrec :: ReadPrec SockOps # readListPrec :: ReadPrec [SockOps] #
Show SockOps Source #
Methods showsPrec :: Int -> SockOps -> ShowS # show :: SockOps -> String # showList :: [SockOps] -> ShowS #
Flags SockOps Source #
Methods noFlags :: SockOps # andFlags :: SockOps -> SockOps -> SockOps # butFlags :: SockOps -> SockOps -> SockOps # commonFlags :: SockOps -> SockOps -> SockOps #
BoundedFlags SockOps Source #
Methods allFlags :: SockOps # enumFlags :: SockOps -> [SockOps] #

newtype MsgFlags Source #

Message flags.

Constructors

MsgFlags CInt

Instances

Eq MsgFlags Source #
Methods (==) :: MsgFlags -> MsgFlags -> Bool # (/=) :: MsgFlags -> MsgFlags -> Bool #
Show MsgFlags Source #
Methods showsPrec :: Int -> MsgFlags -> ShowS # show :: MsgFlags -> String # showList :: [MsgFlags] -> ShowS #
Storable MsgFlags Source #
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 () #
Flags MsgFlags Source #
Methods noFlags :: MsgFlags # andFlags :: MsgFlags -> MsgFlags -> MsgFlags # butFlags :: MsgFlags -> MsgFlags -> MsgFlags # commonFlags :: MsgFlags -> MsgFlags -> MsgFlags #

pattern MSG_PEEK :: MsgFlags Source #

See recvmsg(2) and sendmsg(2).

pattern MSG_TRUNC :: MsgFlags Source #

See recvmsg(2) and sendmsg(2).

pattern MSG_OOB :: MsgFlags Source #

See recvmsg(2) and sendmsg(2).

pattern MSG_DONTROUTE :: MsgFlags Source #

See recvmsg(2) and sendmsg(2).

Socket operations

Creating and connecting

socket :: (SockFamily f, MonadBase IO μ) => Proxy f -> SockType -> SockProto -> μ (Socket f) Source #

Create a socket. The underlying file descriptor is non-blocking. All blocking operations are done via the GHC event manager. See socket(2).

getSockOpt :: (SockOpt o, SockOptReadable o ~ True, MonadBase IO μ) => Socket f -> Proxy o -> μ (SockOptValue o) Source #

Get socket option value. See getsockopt(2).

setSockOpt :: (SockOpt o, SockOptWritable o ~ True, MonadBase IO μ) => Socket f -> Proxy o -> SockOptValue o -> μ () Source #

Set socket option value. See setsockopt(2).

bind :: forall f μ. (SockFamily f, MonadBase IO μ) => Socket f -> SockFamilyAddr f -> μ () Source #

Bind socket to the specified address. See bind(2).

connect :: forall f μ. (SockFamily f, MonadBase IO μ) => Socket f -> SockFamilyAddr f -> μ () Source #

Connect socket to the specified address. This operation blocks. See connect(2).

tryConnect :: forall f μ. (SockFamily f, MonadBase IO μ) => Socket f -> SockFamilyAddr f -> μ Bool Source #

Try to connect socket without blocking. On success True is returned. If the connection did not succeed immediately, False is returned. See connect(2).

listen :: MonadBase IO μ => Socket f -> Int -> μ () Source #

Listen for connections on the given socket. See listen(2).

accept :: forall f μ. (SockFamily f, MonadBase IO μ) => Socket f -> μ (Socket f, SockFamilyAddr f) Source #

Accept a connection on the given socket. This operation blocks. See accept(2).

tryAccept :: forall f μ. (SockFamily f, MonadBase IO μ) => Socket f -> μ (Maybe (Socket f, SockFamilyAddr f)) Source #

Try to accept a connection on the given socket without blocking. On success the accepted socket and the peer address are returned. See accept(2).

getLocalAddr :: forall f μ. (SockFamily f, MonadBase IO μ) => Socket f -> μ (SockFamilyAddr f) Source #

Get the local address. See getsockname(2).

getRemoteAddr :: forall f μ. (SockFamily f, MonadBase IO μ) => Socket f -> μ (SockFamilyAddr f) Source #

Get the remote address. See getpeername(2).

Receiving messages

hasOobData :: MonadBase IO μ => Socket f -> μ Bool Source #

Check if socket has out-of-band data. See sockatmark(3).

recvBufs Source #

Arguments

:: (SockFamily f, MonadBase IO μ)
=> Socket f	The socket
-> [(Ptr Word8, Int)]	Memory buffers
-> MsgFlags	Message flags
-> μ (Int, MsgFlags)	Received message length and flags

Receive a message from a connected socket, possibly utilizing multiple memory buffers. See recvmsg(2).

recvBuf Source #

Arguments

:: (SockFamily f, MonadBase IO μ)
=> Socket f	The socket
-> Ptr α	Buffer pointer
-> Int	Buffer length
-> MsgFlags	Message flags
-> μ (Int, MsgFlags)	Received message length and flags

Receive a message from a connected socket. This operation blocks. See recvmsg(2).

recv' Source #

Arguments

:: (SockFamily f, MonadBase IO μ)
=> Socket f	The socket
-> Int	Maximum message length
-> MsgFlags	Message flags
-> μ (ByteString, MsgFlags)	Received message contents and flags

Receive a message from a connected socket. This operation blocks. See recvmsg(2).

recv Source #

Arguments

:: (SockFamily f, MonadBase IO μ)
=> Socket f	The socket
-> Int	Maximum message length
-> μ ByteString	Received message contents

Receive a message from a connected socket. This operation blocks. See recvmsg(2).

recvBufsFrom Source #

Arguments

:: (SockFamily f, MonadBase IO μ)
=> Socket f	The socket
-> [(Ptr Word8, Int)]	Memory buffers
-> MsgFlags	Message flags
-> μ (SockFamilyAddr f, Int, MsgFlags)	Received message source address, length, and flags

Receive a message from an unconnected socket, possibly utilizing multiple memory buffers. This operation blocks. See recvmsg(2).

recvBufFrom Source #

Arguments

:: (SockFamily f, MonadBase IO μ)
=> Socket f	The socket
-> Ptr α	Buffer pointer
-> Int	Buffer length
-> MsgFlags	Message flags
-> μ (SockFamilyAddr f, Int, MsgFlags)	Received message source address, length, and flags

Receive a message from an unconnected socket. This operation blocks. See recvmsg(2).

recvFrom' Source #

Arguments

:: (SockFamily f, MonadBase IO μ)
=> Socket f	The socket
-> Int	Maximum message length
-> MsgFlags	Message flags
-> μ (SockFamilyAddr f, ByteString, MsgFlags)	Received message source address, contents, and flags

Receive a message from an unconnected socket. This operation blocks. See recvmsg(2).

recvFrom Source #

Arguments

:: (SockFamily f, MonadBase IO μ)
=> Socket f	The socket
-> Int	Maximum message length
-> μ (SockFamilyAddr f, ByteString)	Received message source address and contents

Receive a message from an unconnected socket. This operation blocks. See recvmsg(2).

Sending messages

sendBufs Source #

Arguments

:: (SockFamily f, MonadBase IO μ)
=> Socket f	The socket
-> [(Ptr Word8, Int)]	Memory buffers
-> MsgFlags	Message flags
-> μ Int	The number of bytes sent

Send a message split into several memory buffers on a connected socket. This operation blocks. See sendmsg(2).

sendMany' Source #

Arguments

:: (SockFamily f, MonadBase IO μ)
=> Socket f	The socket
-> [ByteString]	Message contents
-> MsgFlags	Message flags
-> μ Int	The number of bytes sent

Send a message split into several ByteStrings on a connected socket. This operation blocks. See sendmsg(2).

sendMany Source #

Arguments

:: (SockFamily f, MonadBase IO μ)
=> Socket f	The socket
-> [ByteString]	Message contents
-> μ Int	The number of bytes sent

Send a message split into several ByteStrings on a connected socket. This operation blocks. See sendmsg(2).

sendBuf Source #

Arguments

:: (SockFamily f, MonadBase IO μ)
=> Socket f	The socket
-> Ptr α	Buffer pointer
-> Int	Buffer length
-> MsgFlags	Message flags
-> μ Int	The number of bytes sent

Send a message on a connected socket. This operation blocks. See sendmsg(2).

send' Source #

Arguments

:: (SockFamily f, MonadBase IO μ)
=> Socket f	The socket
-> ByteString	Message contents
-> MsgFlags	Message flags
-> μ Int	The number of bytes sent

Send a message on a connected socket. This operation blocks. See sendmsg(2).

send Source #

Arguments

:: (SockFamily f, MonadBase IO μ)
=> Socket f	The socket
-> ByteString	Message contents
-> μ Int	The number of bytes sent

Send a message on a connected socket. This operation blocks. See sendmsg(2).

sendBufsTo Source #

Arguments

:: (SockFamily f, MonadBase IO μ)
=> Socket f	The socket
-> [(Ptr Word8, Int)]	Memory buffers
-> MsgFlags	Message flags
-> SockFamilyAddr f	Message destination address
-> μ Int	The number of bytes sent

Send a message split into several memory buffers on an unconnected socket. This operation blocks. See sendmsg(2).

sendManyTo' Source #

Arguments

:: (SockFamily f, MonadBase IO μ)
=> Socket f	The socket
-> [ByteString]	Message contents
-> MsgFlags	Message flags
-> SockFamilyAddr f	Message destination address
-> μ Int	The number of bytes sent

Send a message split into several ByteStrings on an unconnected socket. This operation blocks. See sendmsg(2).

sendManyTo Source #

Arguments

:: (SockFamily f, MonadBase IO μ)
=> Socket f	The socket
-> [ByteString]	Message contents
-> SockFamilyAddr f	Message destination address
-> μ Int	The number of bytes sent

Send a message split into several ByteStrings on an unconnected socket. This operation blocks. See sendmsg(2).

sendBufTo Source #

Arguments

:: (SockFamily f, MonadBase IO μ)
=> Socket f	The socket
-> Ptr α	Buffer pointer
-> Int	Buffer length
-> MsgFlags	Message flags
-> SockFamilyAddr f	Message destination address
-> μ Int	The number of bytes sent

Send a message on an unconnected socket. This operation blocks. See sendmsg(2).

sendTo' Source #

Arguments

:: (SockFamily f, MonadBase IO μ)
=> Socket f	The socket
-> ByteString	Message contents
-> MsgFlags	Message flags
-> SockFamilyAddr f	Message destination address
-> μ Int	The number of bytes sent

Send a message on an unconnected socket. This operation blocks. See sendmsg(2).

sendTo Source #

Arguments

:: (SockFamily f, MonadBase IO μ)
=> Socket f	The socket
-> ByteString	Message contents
-> SockFamilyAddr f	Message destination address
-> μ Int	The number of bytes sent

Send a message on an unconnected socket. This operation blocks. See sendmsg(2).

Closing

pattern SHUT_RD :: SockOps Source #

An alias for RecvSockOps.

pattern SHUT_WR :: SockOps Source #

An alias for SendSockOps.

pattern SHUT_RDWR :: SockOps Source #

An alias for AllSockOps.

shutdown :: MonadBase IO μ => Socket f -> SockOps -> μ () Source #

Shut down a part of a full-duplex connection. See shutdown(2).

close :: MonadBase IO μ => Socket f -> μ () Source #

Close the socket. See close(2).