System.Posix.Socket

POSIX sockets.

Socket types

data Socket f

Socket of a particular family.

Instances

Eq (Socket f)

Methods

(==) :: Socket f -> Socket f -> Bool

(/=) :: Socket f -> Socket f -> Bool

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

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

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

Get the underlying file descriptor.

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

Use file descriptor as a socket.

class SockAddr (SockFamilyAddr f) => SockFamily f where

Socket family.

Minimal complete definition

sockFamilyCode

Associated Types

type SockFamilyAddr f

Methods

sockFamilyCode :: Proxy f -> CInt

Socket family code.

Instances

SockFamily AF_INET6

Associated Types

type SockFamilyAddr AF_INET6 :: *

Methods

sockFamilyCode :: Proxy * AF_INET6 -> CInt

SockFamily AF_INET

Associated Types

type SockFamilyAddr AF_INET :: *

Methods

sockFamilyCode :: Proxy * AF_INET -> CInt

SockFamily AF_LOCAL

Associated Types

type SockFamilyAddr AF_LOCAL :: *

Methods

sockFamilyCode :: Proxy * AF_LOCAL -> CInt

class SockAddr a where

Socket address.

Minimal complete definition

sockAddrMaxSize, sockAddrSize, peekSockAddr, pokeSockAddr

Methods

sockAddrMaxSize :: Proxy a -> Int

Maximum size of a socket address.

sockAddrSize :: a -> Int

Size of a particular socket address.

peekSockAddr

Arguments

:: Ptr a

Buffer

-> Int

Buffer size

-> IO a

Read socket address from a memory buffer.

pokeSockAddr

Arguments

:: Ptr a

Buffer of sufficient size

-> a

The address to poke

-> IO ()

Write socket address to a memory buffer.

Instances

SockAddr LocalAddr

Methods

sockAddrMaxSize :: Proxy * LocalAddr -> Int

sockAddrSize :: LocalAddr -> Int

peekSockAddr :: Ptr LocalAddr -> Int -> IO LocalAddr

pokeSockAddr :: Ptr LocalAddr -> LocalAddr -> IO ()

newtype SockType

Socket type.

Constructors

SockType CInt

Instances

Eq SockType

Methods

(==) :: SockType -> SockType -> Bool

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

Ord SockType

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

Methods

showsPrec :: Int -> SockType -> ShowS

show :: SockType -> String

showList :: [SockType] -> ShowS

Storable SockType

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

See socket(2).

pattern SOCK_DGRAM :: SockType

See socket(2).

pattern SOCK_RAW :: SockType

See socket(2).

pattern SOCK_RDM :: SockType

See socket(2).

pattern SOCK_SEQPACKET :: SockType

See socket(2).

newtype SockProto

Socket protocol.

Constructors

SockProto CInt

Instances

Eq SockProto

Methods

(==) :: SockProto -> SockProto -> Bool

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

Ord SockProto

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

Methods

showsPrec :: Int -> SockProto -> ShowS

show :: SockProto -> String

showList :: [SockProto] -> ShowS

Storable SockProto

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

Methods

def :: SockProto

defaultSockProto :: SockProto

Default socket protocol (corresponds to 0).

class Storable (SockOptRaw o) => SockOpt o where

Socket option.

Minimal complete definition

sockOptRaw, sockOptValue, sockOptLevel, sockOptCode

Associated Types

type SockOptValue o

Option value type

type SockOptRaw o

FFI-level option value type

type SockOptReadable o :: Bool

Whether option is readable

type SockOptWritable o :: Bool

Whether option is writable

Methods

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

Convert to FFI-level value

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

Convert from FFI-level value

sockOptLevel :: Proxy o -> CInt

Option protocol level

sockOptCode :: Proxy o -> CInt

Option code

Instances

SockOpt SO_REUSEADDR

Associated Types

type SockOptValue SO_REUSEADDR :: *

type SockOptRaw SO_REUSEADDR :: *

type SockOptReadable SO_REUSEADDR :: Bool

type SockOptWritable SO_REUSEADDR :: Bool

Methods

sockOptRaw :: Proxy * SO_REUSEADDR -> SockOptValue SO_REUSEADDR -> SockOptRaw SO_REUSEADDR

sockOptValue :: Proxy * SO_REUSEADDR -> SockOptRaw SO_REUSEADDR -> SockOptValue SO_REUSEADDR

sockOptLevel :: Proxy * SO_REUSEADDR -> CInt

sockOptCode :: Proxy * SO_REUSEADDR -> CInt

SockOpt SO_KEEPALIVE

Associated Types

type SockOptValue SO_KEEPALIVE :: *

type SockOptRaw SO_KEEPALIVE :: *

type SockOptReadable SO_KEEPALIVE :: Bool

type SockOptWritable SO_KEEPALIVE :: Bool

Methods

sockOptRaw :: Proxy * SO_KEEPALIVE -> SockOptValue SO_KEEPALIVE -> SockOptRaw SO_KEEPALIVE

sockOptValue :: Proxy * SO_KEEPALIVE -> SockOptRaw SO_KEEPALIVE -> SockOptValue SO_KEEPALIVE

sockOptLevel :: Proxy * SO_KEEPALIVE -> CInt

sockOptCode :: Proxy * SO_KEEPALIVE -> CInt

SockOpt SO_ERROR

Associated Types

type SockOptValue SO_ERROR :: *

type SockOptRaw SO_ERROR :: *

type SockOptReadable SO_ERROR :: Bool

type SockOptWritable SO_ERROR :: Bool

Methods

sockOptRaw :: Proxy * SO_ERROR -> SockOptValue SO_ERROR -> SockOptRaw SO_ERROR

sockOptValue :: Proxy * SO_ERROR -> SockOptRaw SO_ERROR -> SockOptValue SO_ERROR

sockOptLevel :: Proxy * SO_ERROR -> CInt

sockOptCode :: Proxy * SO_ERROR -> CInt

data SO_ERROR

Instances

SockOpt SO_ERROR

Associated Types

type SockOptValue SO_ERROR :: *

type SockOptRaw SO_ERROR :: *

type SockOptReadable SO_ERROR :: Bool

type SockOptWritable SO_ERROR :: Bool

Methods

sockOptRaw :: Proxy * SO_ERROR -> SockOptValue SO_ERROR -> SockOptRaw SO_ERROR

sockOptValue :: Proxy * SO_ERROR -> SockOptRaw SO_ERROR -> SockOptValue SO_ERROR

sockOptLevel :: Proxy * SO_ERROR -> CInt

sockOptCode :: Proxy * SO_ERROR -> CInt

type SockOptValue SO_ERROR

type SockOptValue SO_ERROR = Errno

type SockOptRaw SO_ERROR

type SockOptRaw SO_ERROR = CInt

type SockOptReadable SO_ERROR

type SockOptReadable SO_ERROR = True

type SockOptWritable SO_ERROR

type SockOptWritable SO_ERROR = False

pattern SO_ERROR :: Proxy SO_ERROR

data SO_KEEPALIVE

Instances

SockOpt SO_KEEPALIVE

Associated Types

type SockOptValue SO_KEEPALIVE :: *

type SockOptRaw SO_KEEPALIVE :: *

type SockOptReadable SO_KEEPALIVE :: Bool

type SockOptWritable SO_KEEPALIVE :: Bool

Methods

sockOptRaw :: Proxy * SO_KEEPALIVE -> SockOptValue SO_KEEPALIVE -> SockOptRaw SO_KEEPALIVE

sockOptValue :: Proxy * SO_KEEPALIVE -> SockOptRaw SO_KEEPALIVE -> SockOptValue SO_KEEPALIVE

sockOptLevel :: Proxy * SO_KEEPALIVE -> CInt

sockOptCode :: Proxy * SO_KEEPALIVE -> CInt

type SockOptValue SO_KEEPALIVE

type SockOptValue SO_KEEPALIVE = Bool

type SockOptRaw SO_KEEPALIVE

type SockOptRaw SO_KEEPALIVE = CInt

type SockOptReadable SO_KEEPALIVE

type SockOptReadable SO_KEEPALIVE = True

type SockOptWritable SO_KEEPALIVE

type SockOptWritable SO_KEEPALIVE = True

pattern SO_KEEPALIVE :: Proxy SO_KEEPALIVE

data SO_REUSEADDR

Instances

SockOpt SO_REUSEADDR

Associated Types

type SockOptValue SO_REUSEADDR :: *

type SockOptRaw SO_REUSEADDR :: *

type SockOptReadable SO_REUSEADDR :: Bool

type SockOptWritable SO_REUSEADDR :: Bool

Methods

sockOptRaw :: Proxy * SO_REUSEADDR -> SockOptValue SO_REUSEADDR -> SockOptRaw SO_REUSEADDR

sockOptValue :: Proxy * SO_REUSEADDR -> SockOptRaw SO_REUSEADDR -> SockOptValue SO_REUSEADDR

sockOptLevel :: Proxy * SO_REUSEADDR -> CInt

sockOptCode :: Proxy * SO_REUSEADDR -> CInt

type SockOptValue SO_REUSEADDR

type SockOptValue SO_REUSEADDR = Bool

type SockOptRaw SO_REUSEADDR

type SockOptRaw SO_REUSEADDR = CInt

type SockOptReadable SO_REUSEADDR

type SockOptReadable SO_REUSEADDR = True

type SockOptWritable SO_REUSEADDR

type SockOptWritable SO_REUSEADDR = True

pattern SO_REUSEADDR :: Proxy SO_REUSEADDR

data SockOps

Socket operations.

Constructors

NoSockOps

RecvSockOps

SendSockOps

AllSockOps

Instances

Eq SockOps

Methods

(==) :: SockOps -> SockOps -> Bool

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

Read SockOps

Methods

readsPrec :: Int -> ReadS SockOps

readList :: ReadS [SockOps]

readPrec :: ReadPrec SockOps

readListPrec :: ReadPrec [SockOps]

Show SockOps

Methods

showsPrec :: Int -> SockOps -> ShowS

show :: SockOps -> String

showList :: [SockOps] -> ShowS

Flags SockOps

Methods

noFlags :: SockOps

andFlags :: SockOps -> SockOps -> SockOps

butFlags :: SockOps -> SockOps -> SockOps

commonFlags :: SockOps -> SockOps -> SockOps

BoundedFlags SockOps

Methods

allFlags :: SockOps

enumFlags :: SockOps -> [SockOps]

newtype MsgFlags

Message flags.

Constructors

MsgFlags CInt

Instances

Eq MsgFlags

Methods

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

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

Show MsgFlags

Methods

showsPrec :: Int -> MsgFlags -> ShowS

show :: MsgFlags -> String

showList :: [MsgFlags] -> ShowS

Storable MsgFlags

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

Methods

noFlags :: MsgFlags

andFlags :: MsgFlags -> MsgFlags -> MsgFlags

butFlags :: MsgFlags -> MsgFlags -> MsgFlags

commonFlags :: MsgFlags -> MsgFlags -> MsgFlags

pattern MSG_PEEK :: MsgFlags

See recvmsg(2) and sendmsg(2).

pattern MSG_TRUNC :: MsgFlags

See recvmsg(2) and sendmsg(2).

pattern MSG_OOB :: MsgFlags

See recvmsg(2) and sendmsg(2).

pattern MSG_DONTROUTE :: MsgFlags

See recvmsg(2) and sendmsg(2).

Socket operations

Creating and connecting

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

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)

Get socket option value. See getsockopt(2).

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

Set socket option value. See setsockopt(2).

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

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

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

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

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

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 -> μ ()

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

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

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))

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)

Get the local address. See getsockname(2).

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

Get the remote address. See getpeername(2).

Receiving messages

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

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

recvBufs

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

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'

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

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

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

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'

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

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

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'

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

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

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'

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

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

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'

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

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

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'

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

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

An alias for RecvSockOps.

pattern SHUT_WR :: SockOps

An alias for SendSockOps.

pattern SHUT_RDWR :: SockOps

An alias for AllSockOps.

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

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

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

Close the socket. See close(2).