Network.WebSockets.Skews

The server object type and related types.

data Server

The Server object. You can easily configure the behavior (how the server responds with some requests) after creating by start function.

data Args

Constructors

Args

Fields

• host :: String
• portNumber :: Int

type RequestHandler = ByteString -> IO (Maybe ByteString)

Used to configure the server's behavior when receiving DataMessage as a ByteString. If returns Nothing, the server does nothing.

Controling the server's lifecycle.

start :: Args -> IO Server

Start the server by the given hostname and port number as Args object.

reinit :: Server -> IO ()

Close all connections, forget recently received requests, and delete any configured RequestHandlers.

threadId :: Server -> ThreadId

Call killThread to stop the server.

Configuring how the server responds/sends WebSocket messages to the client.

enqueRequestHandler :: Server -> RequestHandler -> IO ()

Configure the request handler called when the server receives next. RequestHandlers configured with this function and other non-Default functions are "dequeued". So the server responds with the request handler only once.

If you need the server to respond always with the same response, use setDefaultResponse and setDefaultRequestHandler.

enqueResponse :: Server -> ByteString -> IO ()

Configure the response called when the server receives next.

replaceRequestHandlers :: Server -> [RequestHandler] -> IO ()

Reset the request handler queue.

setDefaultRequestHandler :: Server -> RequestHandler -> IO ()

Configure the request handler called when no request handlers are queued.

setDefaultResponse :: Server -> ByteString -> IO ()

Configure the response called when no request handlers are queued.

respondWith :: ByteString -> RequestHandler

Maybe often used RequestHandler. Always respond with the given Message.

doNothing :: RequestHandler

Maybe often used RequestHandler. Do nothing.

sendToClients :: Server -> ByteString -> IO ()

Send the given Message immediately to the all connected clients.

forgetDefaultRequestHandler :: Server -> IO ()

Delete the default request handler. After calling this function, the Server object doesn't respond to any message if the request handler queue is empty.

forgetDefaultResponse :: Server -> IO ()

Alias for forgetDefaultRequestHandler

forgetReceivedRequests :: Server -> IO ()

Forget recently received requests.

Checking the server's status.

listeningPort :: Server -> Int

listeningHost :: Server -> String

recentlyReceived :: Server -> IO (Deque ByteString)

Retrieve any messages sent by the clients.

countConnectedClients :: Server -> IO Int

For debugging