Module leptus

This module defines the leptus behaviour.
Required callback functions: init/3, terminate/4, routes/0, allowed_methods/1.
Optional callback functions: prefix/0, get/3, put/3, post/3, delete/3, options/3.

Data Types

handler()

handler() = {module(), State::any()}

handlers()

handlers() = [{host_match(), [handler()]}]

host_match()

host_match() = term()

listener()

listener() = http | https

option()

option() = {nb_acceptors, non_neg_integer()} | {ip, inet:ip_address()} | {port, inet:port_number()} | {cacertfile, file:name_all()} | {certfile, file:name_all()} | {keyfile, file:name_all()} | {static_dir, {host_match(), static_directory()}} | {log_handlers, [{module(), any()}]}

options()

options() = [option()]

static_directory()

static_directory() = file:name() | {priv_dir, App::atom(), Dir::file:name()}

Function Index

listener_uptime/1
running_listeners/0
start_listener/2
start_listener/3
start_listener/4
stop_listener/1
upgrade/0
upgrade/1
upgrade/2
upgrade/3

Function Details

listener_uptime/1

listener_uptime(Listener::listener()) -> {Days::integer(), calendar:time()} | {error, not_found}

running_listeners/0

running_listeners() -> [listener()]

start_listener/2

start_listener(Listener::listener(), App::atom() | handlers()) -> {ok, pid()} | {error, any()}

start_listener/3

start_listener(Listener::listener(), Handlers::handlers(), Opts::options()) -> {ok, pid()} | {error, any()}

start_listener/4

start_listener(Listener::listener(), Handlers::handlers(), Opts::options(), UserCowboyProtoOpts::cowboy_protocol:opts()) -> {ok, pid()} | {error, any()}

stop_listener/1

stop_listener(Listener::listener()) -> ok | {error, not_found}

upgrade/0

upgrade() -> ok

upgrade/1

upgrade(Listeners::[listener()]) -> ok

upgrade/2

upgrade(Listener::listener(), Handlers::handlers()) -> ok

upgrade/3

upgrade(Listener::listener(), Handlers::handlers(), Opts::options()) -> ok


Generated by EDoc