Documentation

Upgrade a websockets ServerApp to a wai Application. Uses the given backup Application to handle Requests that are not WebSocket requests.

websocketsOr opts ws_app backup_app = \req respond ->
    case websocketsApp opts ws_app req of
        Nothing  -> backup_app req send_response
        Just res -> respond res

For example, below is an Application that sends "Hello, client!" to each connected client.

app :: Application
app = websocketsOr defaultConnectionOptions wsApp backupApp
  where
    wsApp :: ServerApp
    wsApp pending_conn = do
        conn <- acceptRequest pending_conn
        sendTextData conn ("Hello, client!" :: Text)

    backupApp :: Application
    backupApp _ respond = respond $ responseLBS status400 [] "Not a WebSocket request"

The default connection options:

• Nothing happens when a pong is received.
• Compression is disabled.
• Lenient unicode decoding.
• 30 second timeout for connection establishment.

Turn one or more Pages into a Wai Application. Respond using both HTTP and WebSockets

#EMBED Example/Docs/BasicPage.hs main

Run a Hyperbole application, customizing both the document and the format of server errors

A simple mobile-friendly document with all required embeds and live reload

liveApp quickStartDocument (routeRequest router)

Route URL patterns to different pages

#EMBED ExampleDocsApp.hs import Example.Docs.Page

#EMBED ExampleDocsApp.hs type UserId

#EMBED ExampleDocsApp.hs data AppRoute

#EMBED ExampleDocsApp.hs instance Route

#EMBED ExampleDocsApp.hs router