VintageNetWizard.Web.Endpoint (vintage_net_wizard v0.4.3) View Source

Supervisor for the Web part of the VintageNet Wizard.

Link to this section Summary

Types

opt()

ui_opt()

UI specific configuration

Functions

child_spec(arg)

Returns a specification to start this module under a supervisor.

start_server(opts \\ [])

Start the web server

stop_server()

Stop the web server

Link to this section Types

opt()

Specs

opt() ::
  {:ssl, :ssl.tls_server_option()}
  | {:on_exit, {module(), atom(), list()}}
  | {:ifname, VintageNet.ifname()}
  | {:ui, [ui_opt()]}
  | VintageNetWizard.Backend.opt()

ui_opt()

Specs

ui_opt() ::
  {:title, String.t()}
  | {:title_color, String.t()}
  | {:button_color, String.t()}

UI specific configuration

:title - the title of the HTML pages that will be displayed to the user.
:title_color - color of the title for branding purposes
:button_color - color of the buttons for branding purposes

Link to this section Functions

child_spec(arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

start_server(opts \\ [])

Specs

start_server([opt()]) ::
  :ok | {:error, :already_started | :no_keyfile | :no_certfile}

Start the web server

If the web server is started then {:error, already_started} is returned.

Only one server can be running at a time.

stop_server()

Specs

stop_server() :: :ok | {:error, :not_found}

Stop the web server