Hans.Socket

Abstract Sockets

class Socket sock where

Minimal complete definition

sClose

Methods

sClose :: Network addr => sock addr -> IO ()

Close an open socket.

Instances

Socket TcpListenSocket

Methods

sClose :: Network addr => TcpListenSocket addr -> IO ()

Socket TcpSocket

Methods

sClose :: Network addr => TcpSocket addr -> IO ()

Socket UdpSocket

Methods

sClose :: Network addr => UdpSocket addr -> IO ()

class (DataSocket (Client sock), Socket sock) => ListenSocket sock where

Minimal complete definition

sListen, sAccept

Associated Types

type Client sock :: * -> *

Methods

sListen :: (HasNetworkStack ns, Network addr) => ns -> SocketConfig -> addr -> SockPort -> Int -> IO (sock addr)

Create a listening socket, with a backlog of n.

sAccept :: Network addr => sock addr -> IO (Client sock addr)

Instances

ListenSocket TcpListenSocket

Associated Types

type Client (TcpListenSocket :: * -> *) :: * -> *

Methods

sListen :: (HasNetworkStack ns, Network addr) => ns -> SocketConfig -> addr -> SockPort -> Int -> IO (TcpListenSocket addr)

sAccept :: Network addr => TcpListenSocket addr -> IO (Client TcpListenSocket addr)

class Socket sock => DataSocket sock where

Minimal complete definition

sConnect, sCanWrite, sWrite, sCanRead, sRead, sTryRead

Methods

sConnect :: (HasNetworkStack ns, Network addr) => ns -> SocketConfig -> Maybe Device -> addr -> Maybe SockPort -> addr -> SockPort -> IO (sock addr)

Connect this socket to one on a remote machine.

sCanWrite :: Network addr => sock addr -> IO Bool

Returns True iff there is currently space in the buffer to accept a write. Note, this is probably a bad thing to count on in a concurrent system ...

sWrite :: Network addr => sock addr -> ByteString -> IO Int

Send a chunk of data on a socket.

sCanRead :: Network addr => sock addr -> IO Bool

Returns True iff there is data in the buffer that can be read. Note, this is probably a bad thing to count on in a concurrent system ...

sRead :: Network addr => sock addr -> Int -> IO ByteString

Read a chunk of data from a socket. Reading an empty result indicates that the socket has closed.

sTryRead :: Network addr => sock addr -> Int -> IO (Maybe ByteString)

Non-blocking read from a socket. Reading an empty result means that the socket has closed, while reading a Nothing result indicates that there was no data available.

Instances

DataSocket TcpSocket

Methods

sConnect :: (HasNetworkStack ns, Network addr) => ns -> SocketConfig -> Maybe Device -> addr -> Maybe SockPort -> addr -> SockPort -> IO (TcpSocket addr)

sCanWrite :: Network addr => TcpSocket addr -> IO Bool

sWrite :: Network addr => TcpSocket addr -> ByteString -> IO Int

sCanRead :: Network addr => TcpSocket addr -> IO Bool

sRead :: Network addr => TcpSocket addr -> Int -> IO ByteString

sTryRead :: Network addr => TcpSocket addr -> Int -> IO (Maybe ByteString)

DataSocket UdpSocket

Methods

sConnect :: (HasNetworkStack ns, Network addr) => ns -> SocketConfig -> Maybe Device -> addr -> Maybe SockPort -> addr -> SockPort -> IO (UdpSocket addr)

sCanWrite :: Network addr => UdpSocket addr -> IO Bool

sWrite :: Network addr => UdpSocket addr -> ByteString -> IO Int

sCanRead :: Network addr => UdpSocket addr -> IO Bool

sRead :: Network addr => UdpSocket addr -> Int -> IO ByteString

sTryRead :: Network addr => UdpSocket addr -> Int -> IO (Maybe ByteString)

data SocketConfig

Constructors

SocketConfig

Fields

• scRecvBufferSize :: !Int

  Bytes to buffer

Instances

Show SocketConfig

Methods

showsPrec :: Int -> SocketConfig -> ShowS

show :: SocketConfig -> String

showList :: [SocketConfig] -> ShowS

defaultSocketConfig :: SocketConfig

type SockPort = Word16

UDP Sockets

data UdpSocket addr

Instances

DataSocket UdpSocket

Methods

sConnect :: (HasNetworkStack ns, Network addr) => ns -> SocketConfig -> Maybe Device -> addr -> Maybe SockPort -> addr -> SockPort -> IO (UdpSocket addr)

sCanWrite :: Network addr => UdpSocket addr -> IO Bool

sWrite :: Network addr => UdpSocket addr -> ByteString -> IO Int

sCanRead :: Network addr => UdpSocket addr -> IO Bool

sRead :: Network addr => UdpSocket addr -> Int -> IO ByteString

sTryRead :: Network addr => UdpSocket addr -> Int -> IO (Maybe ByteString)

Socket UdpSocket

Methods

sClose :: Network addr => UdpSocket addr -> IO ()

HasNetworkStack (UdpSocket addr)

Methods

networkStack :: Getting r (UdpSocket addr) NetworkStack

newUdpSocket :: (HasNetworkStack ns, Network addr) => ns -> SocketConfig -> Maybe Device -> addr -> Maybe SockPort -> IO (UdpSocket addr)

sendto :: Network addr => UdpSocket addr -> addr -> SockPort -> ByteString -> IO ()

Send to a specific end host.

recvfrom :: Network addr => UdpSocket addr -> IO (Device, addr, SockPort, ByteString)

Receive, with information about who sent this datagram.

recvfrom' :: Network addr => UdpSocket addr -> IO (Device, addr, SockPort, addr, ByteString)

TCP Sockets

data TcpSocket addr

Instances

DataSocket TcpSocket

Methods

sConnect :: (HasNetworkStack ns, Network addr) => ns -> SocketConfig -> Maybe Device -> addr -> Maybe SockPort -> addr -> SockPort -> IO (TcpSocket addr)

sCanWrite :: Network addr => TcpSocket addr -> IO Bool

sWrite :: Network addr => TcpSocket addr -> ByteString -> IO Int

sCanRead :: Network addr => TcpSocket addr -> IO Bool

sRead :: Network addr => TcpSocket addr -> Int -> IO ByteString

sTryRead :: Network addr => TcpSocket addr -> Int -> IO (Maybe ByteString)

Socket TcpSocket

Methods

sClose :: Network addr => TcpSocket addr -> IO ()

HasNetworkStack (TcpSocket addr)

Methods

networkStack :: Getting r (TcpSocket addr) NetworkStack

data TcpListenSocket addr

Instances

ListenSocket TcpListenSocket

Associated Types

type Client (TcpListenSocket :: * -> *) :: * -> *

Methods

sListen :: (HasNetworkStack ns, Network addr) => ns -> SocketConfig -> addr -> SockPort -> Int -> IO (TcpListenSocket addr)

sAccept :: Network addr => TcpListenSocket addr -> IO (Client TcpListenSocket addr)

Socket TcpListenSocket

Methods

sClose :: Network addr => TcpListenSocket addr -> IO ()

type Client TcpListenSocket

type Client TcpListenSocket = TcpSocket

tcpRemoteAddr :: NetworkAddr addr => Getting r (TcpSocket addr) addr

The remote address of this socket.

tcpRemotePort :: Getting r (TcpSocket addr) SockPort

The remote port of this socket.

tcpLocalAddr :: NetworkAddr addr => Getting r (TcpSocket addr) addr

The source address of this socket.

tcpLocalPort :: Getting r (TcpSocket addr) SockPort

The local port for this socket.

Exceptions

data ConnectionException

Instances

Show ConnectionException

Methods

showsPrec :: Int -> ConnectionException -> ShowS

show :: ConnectionException -> String

showList :: [ConnectionException] -> ShowS

Exception ConnectionException

Methods

toException :: ConnectionException -> SomeException

fromException :: SomeException -> Maybe ConnectionException

displayException :: ConnectionException -> String

data ListenException

Instances

Show ListenException

Methods

showsPrec :: Int -> ListenException -> ShowS

show :: ListenException -> String

showList :: [ListenException] -> ShowS

Exception ListenException

Methods

toException :: ListenException -> SomeException

fromException :: SomeException -> Maybe ListenException

displayException :: ListenException -> String

data RoutingException

Instances

Show RoutingException

Methods

showsPrec :: Int -> RoutingException -> ShowS

show :: RoutingException -> String

showList :: [RoutingException] -> ShowS

Exception RoutingException

Methods

toException :: RoutingException -> SomeException

fromException :: SomeException -> Maybe RoutingException

displayException :: RoutingException -> String