magellan_microservice

v0.3.0

magellan_microservice v0.3.0 MagellanMicroservice.Router

This module is used by the server to provide the default routes to status and health page. Via the register_router/0 function, one can add a custom router to expand the functionality.

Link to this section Summary

Functions

call(conn, opts)

Callback implementation for Plug.call/2

init(opts)

This function gets invoked by the start_link function. It registers its status function status/0 and starts an Agent :router which can store a custom router

register_router(x)

This funtion enables you to register your own router. All requests that don’t match the configured status and health url will be send to the specified router. Refer to the examples in the Readme in order to use your own router with this microservice

status()

Ths function gets invoked by MagellanMicroservice.AppStatus.get_status/0 and MagellanMicroservice.AppStatus.get_health/0. It returns the current status of the module

Link to this section Functions

Link to this function call(conn, opts)

Callback implementation for Plug.call/2.

Link to this function init(opts) 
init([]) :: any

This function gets invoked by the start_link function. It registers its status function status/0 and starts an Agent :router which can store a custom router.

Link to this function register_router(x) 
register_router(any) :: atom

This funtion enables you to register your own router. All requests that don’t match the configured status and health url will be send to the specified router. Refer to the examples in the Readme in order to use your own router with this microservice.

Link to this function status() 
status() :: %{optional(atom) => atom}

Ths function gets invoked by MagellanMicroservice.AppStatus.get_status/0 and MagellanMicroservice.AppStatus.get_health/0. It returns the current status of the module.