%%--------------------------------------------------------------------
%% Copyright (c) 2017-2021 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.
%%--------------------------------------------------------------------

-ifndef(EMQX_GATEWAY_HRL).
-define(EMQX_GATEWAY_HRL, 1).

-type instance_id()  :: atom().
-type gateway_type() :: atom().

%% @doc The Gateway Instace defination
-type instance() ::
        #{ id      := instance_id()
         , type    := gateway_type()
         , name    := binary()
         , descr   => binary() | undefined
         %% Appears only in creating or detailed info
         , rawconf => map()
         %% Appears only in getting instance status/info
         , status  => stopped | running
         }.

-endif.