Stetson

configure :: StetsonConfig NoArguments NoArguments

Creates a blank stetson config with default settings and no routes

cowboyRoutes :: forall t a. List Path -> StetsonConfig t a -> StetsonConfig t a

Introduce a list of native Erlang cowboy handlers to this config

routes :: forall t' a' t a rep r. Generic a rep => GDispatch rep r => RouteDuplex t a -> Record r -> StetsonConfig t' a' -> StetsonConfig t a

routes2 :: forall t a rep r. Generic a rep => GDispatch rep r => RouteDuplex t a -> Record r -> RouteConfig t a

port :: forall t a. Port -> StetsonConfig t a -> StetsonConfig t a

Set the port that this http listener will listen to

bindTo :: forall t a. Ip4Address -> StetsonConfig t a -> StetsonConfig t a

Set the IP that this http listener will bind to (default: 0.0.0.0)

streamHandlers :: forall t a. List NativeModuleName -> StetsonConfig t a -> StetsonConfig t a

Supply a list of modules to act as native stream handlers in cowboy

middlewares :: forall t a. List NativeModuleName -> StetsonConfig t a -> StetsonConfig t a

Supply a list of modules to act as native middlewares in cowboy

tcpOptions :: forall t a. Record ListenOptions -> StetsonConfig t a -> StetsonConfig t a

Supply tcp transport options for cowboy/ranch

tlsOptions :: forall t a. Record ListenOptions -> StetsonConfig t a -> StetsonConfig t a

Supply tls/ssl transport options for cowboy/ranch

startClear :: forall t a. String -> StetsonConfig t a -> Effect (Either Foreign Unit)

Start the listener with the specified name

startTls :: forall t a. String -> StetsonConfig t a -> Effect (Either Foreign Unit)

Start the TLS listener with the specified name

stop :: String -> Effect Unit

type WebSocketInitHandler msg state = state -> WebSocketResult msg (WebSocketCallResult state)

Callback used to kick off the WebSocket handler This is a good time to get hold of 'self' and set up subscriptions

type WebSocketInfoHandler msg state = msg -> state -> WebSocketResult msg (WebSocketCallResult state)

Callback used to handle messages sent from Erlang (hopefully via the router) so they'll be of the right type

type WebSocketHandleHandler msg state = Frame -> state -> WebSocketResult msg (WebSocketCallResult state)

Callback used to handle messages sent from the client in the form of 'Frames' which will need unpacking/decoding/parsing etc

data WebSocketCallResult state

Return type of most WebSocket callbacks

Constructors

• NoReply state
• Hibernate state
• Reply (List Frame) state
• ReplyAndHibernate (List Frame) state
• Stop state

data StetsonHandler msg state

A builder containing the complete set of callbacks for any sort of request

Constructors

• StetsonHandler (StetsonHandlerCallbacks msg state)

type StetsonConfig t a = { bindAddress :: Ip4Address, bindPort :: Port, cowboyRoutes :: List Path, middlewares :: Maybe (List NativeModuleName), routes :: RouteConfig t a, streamHandlers :: Maybe (List NativeModuleName), tcpOptions :: Maybe (Record ListenOptions), tlsOptions :: Maybe (Record ListenOptions) }

data StaticAssetLocation

Constructors

• PrivDir String String
• PrivFile String String

type SimpleStetsonHandler state = StetsonHandler Unit state

A type alias for StetsonHandler, but with no ability to receive messages

data RouteHandler

Constructors

• StetsonRoute (Exists StetsonRouteInner)
• StaticRoute (Array String) StaticAssetLocation
• CowboyRouteFallthrough

type RouteConfig t a = { dispatch :: a -> RouteHandler, routing :: RouteDuplex t a }

data RestResult reply state

The return type of most of the callbacks invoked as part of the REST workflow

Constructors

• RestOk reply Req state
• RestStop Req state
• RestSwitch CowboyHandler Req state

type ProvideHandler state = Req -> state -> Effect (RestResult IOData state)

A callback invoked to 'provide' a specific content type

data LoopCallResult state

Return type of most Loop callbacks

Constructors

• LoopOk Req state
• LoopHibernate Req state
• LoopStop Req state

data InitResult state

The return type of the 'init' callback in the REST workflow

Constructors

• Rest Req state
• WebSocket Req state
• Loop Req state

type InitHandler state = Req -> Effect (InitResult state)

The callback invoked to kick off the REST workflow

data HttpMethod

or is it a verb

Constructors

• GET
• POST
• HEAD
• OPTIONS
• PUT
• DELETE
• PATCH

Instances

• Show HttpMethod

data HandlerArgs

data CowboyHandler

The different handlers exposed by Cowboy and loosely mapping onto the Rest/Loop/WebSocket namespaces

Constructors

• RestHandler
• LoopHandler
• WebSocketHandler

data Authorized

Return type of the isAuthorized callback

Constructors

• Authorized
• NotAuthorized String

data AcceptHandlerResult

The return result of an AcceptHandler (success/failure/success with url)

type AcceptHandler state = Req -> state -> Effect (RestResult AcceptHandlerResult state)

A callback invoked to 'accept' a specific content type

runStetsonRoute :: forall z. (forall b c. StetsonHandler b c -> z) -> Exists StetsonRouteInner -> z

mkStetsonRoute :: forall a s. StetsonHandler a s -> Exists StetsonRouteInner

emptyHandler :: forall msg state. InitHandler state -> StetsonHandler msg state

acceptSuccessLocation :: String -> AcceptHandlerResult

The resource was accepted succesfully And here is the URI of its new location

acceptSuccess :: AcceptHandlerResult

The resource was accepted succesfully

acceptFailure :: AcceptHandlerResult

The resource was not accepted