emqx4.3/apps/emqx_resource/include/emqx_resource.hrl

%%--------------------------------------------------------------------
%% Copyright (c) 2020-2022 EMQ Technologies Co., Ltd. All Rights Reserved.
%%
%% Licensed under the Apache License, Version 2.0 (the "License");
%% you may not use this file except in compliance with the License.
%% You may obtain a copy of the License at
%%
%%     http://www.apache.org/licenses/LICENSE-2.0
%%
%% Unless required by applicable law or agreed to in writing, software
%% distributed under the License is distributed on an "AS IS" BASIS,
%% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
%% See the License for the specific language governing permissions and
%% limitations under the License.
%%--------------------------------------------------------------------
-type resource_type() :: module().
-type instance_id() :: binary().
-type raw_resource_config() :: binary() | raw_term_resource_config().
-type raw_term_resource_config() :: #{binary() => term()} | [raw_term_resource_config()].
-type resource_config() :: term().
-type resource_spec() :: map().
-type resource_state() :: term().
-type resource_data() :: #{
    id := instance_id(),
    mod := module(),
    config := resource_config(),
    state := resource_state(),
    status := started | stopped | starting,
    metrics := emqx_plugin_libs_metrics:metrics()
}.
-type resource_group() :: binary().
-type create_opts() :: #{
        %% The emqx_resource:create/4 will return OK event if the Mod:on_start/2 fails,
        %% the 'status' of the resource will be 'stopped' in this case.
        %% Defaults to 'false'
        async_create => boolean()
    }.
-type after_query() :: {[OnSuccess :: after_query_fun()], [OnFailed :: after_query_fun()]} |
    undefined.

%% the `after_query_fun()` is mainly for callbacks that increment counters or do some fallback
%% actions upon query failure
-type after_query_fun() :: {fun((...) -> ok), Args :: [term()]}.

-define(TEST_ID_PREFIX, "_test_:").