Zaiming (Stone) Shi d6f7ffec3c Merge pull request #6881 from zmstone/refactor-upgrade-hocon-0.23.0 %!s(int64=4) %!d(string=hai) anos
..
include 252d7e85d9 refactor: call new hocon apis %!s(int64=4) %!d(string=hai) anos
src d6f7ffec3c Merge pull request #6881 from zmstone/refactor-upgrade-hocon-0.23.0 %!s(int64=4) %!d(string=hai) anos
test 8cfbdc2730 test(emqx_resource): improve emqx_resource test coverage to 80% %!s(int64=4) %!d(string=hai) anos
README.md 071c2c99e8 refactor(authn resources): add `emqx_resource` and `emqx_authn` tests %!s(int64=4) %!d(string=hai) anos
rebar.config 542c9a2b68 refactor(emqx_resource): Decorate RPCs %!s(int64=4) %!d(string=hai) anos

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.