Network.BERT.Transport

Underlying transport abstraction

Core definitions

class Transport t where

The class for transports

Methods

runSession :: t -> TransportM a -> IO a

closeConnection :: t -> IO ()

Instances

Transport TCP

class Transport (ServerTransport s) => Server s where

Associated Types

type ServerTransport s

The underlying transport used by the server

Methods

runServer :: s -> (ServerTransport s -> IO ()) -> IO ()

This method should listen for incoming requests, establish some sort of a connection (represented by the transport) and then invoke the handling function

cleanup :: s -> IO ()

Free any resources that the server has acquired (such as the listening socket)

Instances

Server TCPServer

type TransportM = ReaderT SendPacketFn (ConduitM Packet Void IO)

The transport monad allows receiving packets through the conduit, and sending functions via the provided SendPacketFn

type SendPacketFn = Packet -> IO ()

A function to send packets to the peer

Sending and receiving packets

sendt :: Term -> TransportM ()

Send a term

recvt :: TransportM (Maybe Term)

Receive a term

recvtForever :: (Term -> TransportM a) -> TransportM ()

Execute an action for every incoming term, until the connection is closed

TCP transport

data TCP

The TCP transport

Constructors

TCP

Fields

getTcpSocket :: !Socket

The socket used for communication.

The connection is assumed to be already established when this structure is passed in.

Instances

Transport TCP

tcpClient :: HostName -> PortNumber -> IO TCP

Establish a connection to the TCP server and return the resulting transport. It can be used to make multiple requests.

data TCPServer

The TCP server

Constructors

TCPServer

Fields

getTcpListenSocket :: !Socket

The listening socket. Assumed to be bound but not listening yet.

Instances

Server TCPServer

type ServerTransport TCPServer = TCP

tcpServer :: PortNumber -> IO TCPServer

A simple TCPServer constructor, listens on all local interfaces.

If you want to bind only to some of the interfaces, create the socket manually using the functions from Network.Socket.

Utilities

resolve :: HostName -> IO HostAddress

A simple address resolver