package opium

  1. Overview
  2. Docs

Module Opium.AppSource

An opium app provides a set of convenience functions and types to construct a rock app.

  • Re-exporting common functions needed in handlers
  • Easy handling of routes and bodies
  • Automatic generation of a command line app
Sourcetype t

An opium app is a simple builder wrapper around a rock app

Sourceval to_handler : t -> Rock.Handler.t

to_handler t converts the app t to a Rock handler.

Sourceval empty : t

A basic empty app

Sourcetype builder = t -> t

A builder is a function that transforms an app by adding some functionality. Builders are usuallys composed with a base app using (|>) to create a full app

Sourceval host : string -> builder
Sourceval backlog : int -> builder

backlog specifies the maximum number of clients that can have a pending connection request to the Opium server.

Sourceval port : int -> builder
Sourceval ssl : cert:string -> key:string -> builder
Sourceval cmd_name : string -> builder
Sourceval not_found : (Request.t -> (Headers.t * Body.t) Lwt.t) -> builder

not_found accepts a regular Opium handler that will be used instead of the default 404 handler.

Sourcetype route = string -> Rock.Handler.t -> builder

A route is a function that returns a buidler that hooks up a handler to a url mapping

Method specific routes

Sourceval get : route
Sourceval post : route
Sourceval delete : route
Sourceval put : route
Sourceval options : route
Sourceval head : route
Sourceval patch : route
Sourceval any : Method.t list -> route

any methods will bind a route to any http method inside of methods

Sourceval all : route

all methods will bind a route to a URL regardless of the http method. You may escape the actual method used from the request passed.

Sourceval action : Method.t -> route
Sourceval middleware : Rock.Middleware.t -> builder
Sourceval start : t -> Lwt_io.server Lwt.t

Start an opium server. The thread returned can be cancelled to shutdown the server

Sourceval run_command : t -> unit

Create a cmdliner command from an app and run lwt's event loop

Sourceval run_command' : t -> [> `Ok of unit Lwt.t | `Error | `Not_running ]