emqx/apps/emqx_resource
Zaiming (Stone) Shi d6f7ffec3c
Merge pull request #6881 from zmstone/refactor-upgrade-hocon-0.23.0
refactor: upgrade to hocon 0.23.0
2022-01-27 15:48:23 +01:00
..
include refactor: call new hocon apis 2022-01-27 00:23:08 +01:00
src Merge pull request #6881 from zmstone/refactor-upgrade-hocon-0.23.0 2022-01-27 15:48:23 +01:00
test test(emqx_resource): improve emqx_resource test coverage to 80% 2022-01-25 17:59:29 +08:00
README.md refactor(authn resources): add `emqx_resource` and `emqx_authn` tests 2021-11-22 21:08:04 +03:00
rebar.config refactor(emqx_resource): Decorate RPCs 2022-01-19 22:00:34 +01:00

README.md

emqx_resource

The emqx_resource is a behavior that manages configuration specs and runtime states for resources like mysql or redis backends.

It is intended to be used by the emqx_bridges and all other resources that need CRUD operations to their configs, and need to initialize the states when creating.

There can be foreign references between resource instances via resource-id. So they may find each other via this Id.

The main idea of the emqx resource is to put all the general code in a common lib, including the config operations (like config validation, config dump back to files), and the state management. And we put all the specific codes to the callback modules.

See

  • test/emqx_test_resource.erl for a minimal emqx_resource implementation;
  • test/emqx_resource_SUITE.erl for examples of emqx_resource usage.