Nettle.Servers.TCPServer

Provides a generic TCP server, parameterized over the server's listening port and the types of messages received from and sent to clients.

Documentation

tcpServer :: Show a => ServerPortNumber -> TCPMessageDriver a b -> IO [Peer a b]

tcpServer starts a TCP server at the given port number, waiting for new connections. Whenever a new connection is established, new threads are created for reading and writing to the thread, using the given tcp message driver. The socket address of the other side of the connection, along with a pair of channels for the incoming messages and outgoing messages is placed on the result channel. This method returns immediately.

type ServerPortNumber = Word16

data TCPMessageDriver a b

A TCPMessageDriver a b is used by the tcpServer to read messages of type a from the underlying TCP sockets with peers as well as write messages of type b to the TCP sockets.

Constructors

TCPMessageDriver

Fields

getMessage :: Handle -> IO (Maybe a)

Method to read a value from the handle. Returns Nothing if the read failed.

putMessage :: b -> Handle -> IO ()

Method to write a value to a handle.

type Peer a b = (SockAddr, Process a b IOException)

A Peer is a TCP peer. It consists of a SockAddr value giving the the socket address of the peer, as well as a Process value which provides methods to access messages received from the peer and send messages to a peer.

data Process a b c

A Process a b c represents a process with an API that allows another IO computation to observe its outputs (of type a), to supply it with inputs (of type b), and to observe when it terminates.

Constructors

Process

Fields

readP :: IO a

interact with the process by receiving one of its outputs; should block until the process emits a value.

tellP :: b -> IO ()

interact with the process by sending it an input; should be non-blocking.

whenDeadP :: IO c

should block until the process terminates, carrying an output value of type c.

readAll :: Process a b c -> IO [a]

Read all of the output from the process as a lazy stream.

writeAll :: Process a b c -> [b] -> IO ()

Write a list to the process; does not return until every element of the list has been sent to the process.

data SockAddr

Instances

Eq SockAddr

Ord SockAddr

Show SockAddr

Typeable SockAddr