Copyright	(c) Lars Petersen 2016
License	MIT
Maintainer	[email protected]
Stability	experimental
Safe Haskell	None
Language	Haskell2010

Network.Stack.Server

Description

Synopsis

Documentation

data TLS a Source #

Instances

Eq (ServerException (TLS a)) Source #
Methods (==) :: ServerException (TLS a) -> ServerException (TLS a) -> Bool # (/=) :: ServerException (TLS a) -> ServerException (TLS a) -> Bool #
Ord (ServerException (TLS a)) Source #
Methods compare :: ServerException (TLS a) -> ServerException (TLS a) -> Ordering # (<) :: ServerException (TLS a) -> ServerException (TLS a) -> Bool # (<=) :: ServerException (TLS a) -> ServerException (TLS a) -> Bool # (>) :: ServerException (TLS a) -> ServerException (TLS a) -> Bool # (>=) :: ServerException (TLS a) -> ServerException (TLS a) -> Bool # max :: ServerException (TLS a) -> ServerException (TLS a) -> ServerException (TLS a) # min :: ServerException (TLS a) -> ServerException (TLS a) -> ServerException (TLS a) #
Show (ServerException (TLS a)) Source #
Methods showsPrec :: Int -> ServerException (TLS a) -> ShowS # show :: ServerException (TLS a) -> String # showList :: [ServerException (TLS a)] -> ShowS #
Show (ServerConnectionInfo a) => Show (ServerConnectionInfo (TLS a)) Source #
Methods showsPrec :: Int -> ServerConnectionInfo (TLS a) -> ShowS # show :: ServerConnectionInfo (TLS a) -> String # showList :: [ServerConnectionInfo (TLS a)] -> ShowS #
Typeable * a => Exception (ServerException (TLS a)) Source #
Methods toException :: ServerException (TLS a) -> SomeException # fromException :: SomeException -> Maybe (ServerException (TLS a)) # displayException :: ServerException (TLS a) -> String #
StreamServerStack a => StreamServerStack (TLS a) Source #
Methods sendStream :: ServerConnection (TLS a) -> ByteString -> IO Int Source # sendStreamLazy :: ServerConnection (TLS a) -> ByteString -> IO Int64 Source # sendStreamBuilder :: ServerConnection (TLS a) -> Int -> Builder -> IO Int64 Source # receiveStream :: ServerConnection (TLS a) -> Int -> IO ByteString Source # receiveStreamLazy :: ServerConnection (TLS a) -> Int -> IO ByteString Source #
(StreamServerStack a, Typeable * a) => ServerStack (TLS a) Source #
Associated Types data Server (TLS a) :: * Source # data ServerConfig (TLS a) :: * Source # data ServerException (TLS a) :: * Source # data ServerConnection (TLS a) :: * Source # data ServerConnectionInfo (TLS a) :: * Source # Methods withServer :: ServerConfig (TLS a) -> (Server (TLS a) -> IO b) -> IO b Source # withConnection :: Server (TLS a) -> (ServerConnection (TLS a) -> ServerConnectionInfo (TLS a) -> IO b) -> IO (Async b) Source #
(StreamServerStack a, MqttServerTransportStack a) => MqttServerTransportStack (TLS a) Source #
Methods getConnectionRequest :: ServerConnectionInfo (TLS a) -> IO ConnectionRequest Source #
data Server (TLS a) Source #
data Server (TLS a) = TlsServer { tlsTransportServer :: Server a tlsServerConfig :: ServerConfig (TLS a) }
data ServerConfig (TLS a) Source #
data ServerConfig (TLS a) = TlsServerConfig { tlsTransportConfig :: ServerConfig a tlsServerParams :: ServerParams }
data ServerException (TLS a) Source #
data ServerException (TLS a) = TlsServerEndOfStreamException
data ServerConnection (TLS a) Source #
data ServerConnection (TLS a) = TlsServerConnection { tlsTransportConnection :: ServerConnection a tlsContext :: Context }
data ServerConnectionInfo (TLS a) Source #
data ServerConnectionInfo (TLS a) = TlsServerConnectionInfo { tlsTransportServerConnectionInfo :: ServerConnectionInfo a tlsCertificateChain :: Maybe CertificateChain }

data WebSocket a Source #

Instances

Show (ServerConnectionInfo a) => Show (ServerConnectionInfo (WebSocket a)) Source #
Methods showsPrec :: Int -> ServerConnectionInfo (WebSocket a) -> ShowS # show :: ServerConnectionInfo (WebSocket a) -> String # showList :: [ServerConnectionInfo (WebSocket a)] -> ShowS #
StreamServerStack a => StreamServerStack (WebSocket a) Source #
Methods sendStream :: ServerConnection (WebSocket a) -> ByteString -> IO Int Source # sendStreamLazy :: ServerConnection (WebSocket a) -> ByteString -> IO Int64 Source # sendStreamBuilder :: ServerConnection (WebSocket a) -> Int -> Builder -> IO Int64 Source # receiveStream :: ServerConnection (WebSocket a) -> Int -> IO ByteString Source # receiveStreamLazy :: ServerConnection (WebSocket a) -> Int -> IO ByteString Source #
StreamServerStack a => ServerStack (WebSocket a) Source #
Associated Types data Server (WebSocket a) :: * Source # data ServerConfig (WebSocket a) :: * Source # data ServerException (WebSocket a) :: * Source # data ServerConnection (WebSocket a) :: * Source # data ServerConnectionInfo (WebSocket a) :: * Source # Methods withServer :: ServerConfig (WebSocket a) -> (Server (WebSocket a) -> IO b) -> IO b Source # withConnection :: Server (WebSocket a) -> (ServerConnection (WebSocket a) -> ServerConnectionInfo (WebSocket a) -> IO b) -> IO (Async b) Source #
(StreamServerStack a, MqttServerTransportStack a) => MqttServerTransportStack (WebSocket a) Source #
Methods getConnectionRequest :: ServerConnectionInfo (WebSocket a) -> IO ConnectionRequest Source #
data Server (WebSocket a) Source #
data Server (WebSocket a) = WebSocketServer { wsTransportServer :: Server a }
data ServerConfig (WebSocket a) Source #
data ServerConfig (WebSocket a) = WebSocketServerConfig { wsTransportConfig :: ServerConfig a }
data ServerException (WebSocket a) Source #
data ServerException (WebSocket a) = WebSocketServerException
data ServerConnection (WebSocket a) Source #
data ServerConnection (WebSocket a) = WebSocketServerConnection { wsTransportConnection :: ServerConnection a wsConnection :: Connection }
data ServerConnectionInfo (WebSocket a) Source #
data ServerConnectionInfo (WebSocket a) = WebSocketServerConnectionInfo { wsTransportServerConnectionInfo :: ServerConnectionInfo a wsRequestHead :: RequestHead }

class Typeable a => ServerStack a where Source #

Minimal complete definition

withServer, withConnection

Associated Types

data Server a Source #

data ServerConfig a Source #

data ServerException a Source #

data ServerConnection a Source #

data ServerConnectionInfo a Source #

Methods

withServer :: ServerConfig a -> (Server a -> IO b) -> IO b Source #

Creates a new server from a configuration and passes it to a handler function.

The server given to the handler function shall be bound and in listening state. The handler function is usually a forever loop that accepts and handles new connections.

withServer config $ \server->
  forever $ withConnection handleConnection

withConnection :: Server a -> (ServerConnection a -> ServerConnectionInfo a -> IO b) -> IO (Async b) Source #

Waits for and accepts a new connection from a listening server and passes it to a handler function.

This operation is blocking until the lowest layer in the stack accepts a new connection. The handlers of all other layers are executed within an Async which is returned. This allows the main thread waiting on the underlying socket to block just as long as necessary. Upper layer protocol handshakes (TLS etc) will be executed in the new thread.

withServer config $ \server-> forever $
  future <- withConnection server handleConnection
  putStrLn "The lowest layer accepted a new connection!"
  async $ do
      result <- wait future
      putStrLn "The connection handler returned:"
      print result

Instances

StreamServerStack a => ServerStack (WebSocket a) Source #
Associated Types data Server (WebSocket a) :: * Source # data ServerConfig (WebSocket a) :: * Source # data ServerException (WebSocket a) :: * Source # data ServerConnection (WebSocket a) :: * Source # data ServerConnectionInfo (WebSocket a) :: * Source # Methods withServer :: ServerConfig (WebSocket a) -> (Server (WebSocket a) -> IO b) -> IO b Source # withConnection :: Server (WebSocket a) -> (ServerConnection (WebSocket a) -> ServerConnectionInfo (WebSocket a) -> IO b) -> IO (Async b) Source #
(StreamServerStack a, Typeable * a) => ServerStack (TLS a) Source #
Associated Types data Server (TLS a) :: * Source # data ServerConfig (TLS a) :: * Source # data ServerException (TLS a) :: * Source # data ServerConnection (TLS a) :: * Source # data ServerConnectionInfo (TLS a) :: * Source # Methods withServer :: ServerConfig (TLS a) -> (Server (TLS a) -> IO b) -> IO b Source # withConnection :: Server (TLS a) -> (ServerConnection (TLS a) -> ServerConnectionInfo (TLS a) -> IO b) -> IO (Async b) Source #
StreamServerStack transport => ServerStack (MQTT transport) Source #
Associated Types data Server (MQTT transport) :: * Source # data ServerConfig (MQTT transport) :: * Source # data ServerException (MQTT transport) :: * Source # data ServerConnection (MQTT transport) :: * Source # data ServerConnectionInfo (MQTT transport) :: * Source # Methods withServer :: ServerConfig (MQTT transport) -> (Server (MQTT transport) -> IO b) -> IO b Source # withConnection :: Server (MQTT transport) -> (ServerConnection (MQTT transport) -> ServerConnectionInfo (MQTT transport) -> IO b) -> IO (Async b) Source #
(Family f, Type t, Protocol p, Typeable * f, Typeable * t, Typeable * p) => ServerStack (Socket f t p) Source #
Associated Types data Server (Socket f t p) :: * Source # data ServerConfig (Socket f t p) :: * Source # data ServerException (Socket f t p) :: * Source # data ServerConnection (Socket f t p) :: * Source # data ServerConnectionInfo (Socket f t p) :: * Source # Methods withServer :: ServerConfig (Socket f t p) -> (Server (Socket f t p) -> IO b) -> IO b Source # withConnection :: Server (Socket f t p) -> (ServerConnection (Socket f t p) -> ServerConnectionInfo (Socket f t p) -> IO b) -> IO (Async b) Source #

class ServerStack a => StreamServerStack a where Source #

Methods

sendStream :: ServerConnection a -> ByteString -> IO Int Source #

sendStreamLazy :: ServerConnection a -> ByteString -> IO Int64 Source #

sendStreamBuilder :: ServerConnection a -> Int -> Builder -> IO Int64 Source #

receiveStream :: ServerConnection a -> Int -> IO ByteString Source #

receiveStreamLazy :: ServerConnection a -> Int -> IO ByteString Source #

Instances

StreamServerStack a => StreamServerStack (WebSocket a) Source #
Methods sendStream :: ServerConnection (WebSocket a) -> ByteString -> IO Int Source # sendStreamLazy :: ServerConnection (WebSocket a) -> ByteString -> IO Int64 Source # sendStreamBuilder :: ServerConnection (WebSocket a) -> Int -> Builder -> IO Int64 Source # receiveStream :: ServerConnection (WebSocket a) -> Int -> IO ByteString Source # receiveStreamLazy :: ServerConnection (WebSocket a) -> Int -> IO ByteString Source #
StreamServerStack a => StreamServerStack (TLS a) Source #
Methods sendStream :: ServerConnection (TLS a) -> ByteString -> IO Int Source # sendStreamLazy :: ServerConnection (TLS a) -> ByteString -> IO Int64 Source # sendStreamBuilder :: ServerConnection (TLS a) -> Int -> Builder -> IO Int64 Source # receiveStream :: ServerConnection (TLS a) -> Int -> IO ByteString Source # receiveStreamLazy :: ServerConnection (TLS a) -> Int -> IO ByteString Source #
(Typeable * f, Typeable * p, Family f, Protocol p) => StreamServerStack (Socket f Stream p) Source #
Methods sendStream :: ServerConnection (Socket f Stream p) -> ByteString -> IO Int Source # sendStreamLazy :: ServerConnection (Socket f Stream p) -> ByteString -> IO Int64 Source # sendStreamBuilder :: ServerConnection (Socket f Stream p) -> Int -> Builder -> IO Int64 Source # receiveStream :: ServerConnection (Socket f Stream p) -> Int -> IO ByteString Source # receiveStreamLazy :: ServerConnection (Socket f Stream p) -> Int -> IO ByteString Source #

class ServerStack a => MessageServerStack a where Source #

This class is an abstraction for ServerStacks that support the transmission and reception of finite messages.

Minimal complete definition

sendMessage, sendMessages, receiveMessage, consumeMessages

Associated Types

type ClientMessage a Source #

type ServerMessage a Source #

Methods

sendMessage :: ServerConnection a -> ServerMessage a -> IO Int64 Source #

Send a message.

Returns the encoded message size.

sendMessages :: Foldable t => ServerConnection a -> t (ServerMessage a) -> IO Int64 Source #

Send several messages. This might lead to an improvement for very short messages.

Returns the summed size of all encoded messages.

receiveMessage :: ServerConnection a -> Int64 -> IO (ClientMessage a) Source #

Receive a message.

The second parameter determines the maximum encoded message size which must not be exceeded by the client or an exception will be thrown. Implementations shall track the consumed bytes and shall throw an exception as soon as the limit is exceeded even if the message is not yet complete. This is important to prevent _denial of service_ attacks.

consumeMessages :: ServerConnection a -> Int64 -> (ClientMessage a -> IO Bool) -> IO () Source #

Consumes incoming messages with a supplied consumer callback.

The second parameter limits the size of a single encoded message (see receiveMessage).

Instances

StreamServerStack transport => MessageServerStack (MQTT transport) Source #