magellan_microservice v0.1.4 MagellanMicroservice.Router

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

Summary

Functions

Callback implementation for c:Plug.call/2

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

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

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

Functions

call(conn, opts)

Callback implementation for c:Plug.call/2.

init(opts)

Specs

init([]) :: any

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

register_router(x)

Specs

register_router(any) :: any

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()

Specs

status :: map

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