193 lines
6.3 KiB
Erlang
193 lines
6.3 KiB
Erlang
%%--------------------------------------------------------------------
|
|
%% Copyright (c) 2013-2017 EMQ Enterprise, Inc. (http://emqtt.io)
|
|
%%
|
|
%% 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.
|
|
%%--------------------------------------------------------------------
|
|
|
|
%%--------------------------------------------------------------------
|
|
%% Banner
|
|
%%--------------------------------------------------------------------
|
|
|
|
-define(COPYRIGHT, "Copyright (c) 2013-2017 EMQ Enterprise, Inc.").
|
|
|
|
-define(LICENSE_MESSAGE, "Licensed under the Apache License, Version 2.0").
|
|
|
|
-define(PROTOCOL_VERSION, "MQTT/3.1.1").
|
|
|
|
-define(ERTS_MINIMUM, "7.0").
|
|
|
|
%%--------------------------------------------------------------------
|
|
%% Sys/Queue/Share Topics' Prefix
|
|
%%--------------------------------------------------------------------
|
|
|
|
-define(SYSTOP, <<"$SYS/">>). %% System Topic
|
|
|
|
-define(QUEUE, <<"$queue/">>). %% Queue Topic
|
|
|
|
-define(SHARE, <<"$share/">>). %% Shared Topic
|
|
|
|
%%--------------------------------------------------------------------
|
|
%% PubSub
|
|
%%--------------------------------------------------------------------
|
|
|
|
-type(pubsub() :: publish | subscribe).
|
|
|
|
-define(PUBSUB(PS), (PS =:= publish orelse PS =:= subscribe)).
|
|
|
|
%%--------------------------------------------------------------------
|
|
%% MQTT Topic
|
|
%%--------------------------------------------------------------------
|
|
|
|
-record(mqtt_topic,
|
|
{ topic :: binary(),
|
|
flags = [] :: [retained | static]
|
|
}).
|
|
|
|
-type(mqtt_topic() :: #mqtt_topic{}).
|
|
|
|
%%--------------------------------------------------------------------
|
|
%% MQTT Subscription
|
|
%%--------------------------------------------------------------------
|
|
-record(mqtt_subscription,
|
|
{ subid :: binary() | atom(),
|
|
topic :: binary(),
|
|
qos :: 0 | 1 | 2
|
|
}).
|
|
|
|
-type(mqtt_subscription() :: #mqtt_subscription{}).
|
|
|
|
%%--------------------------------------------------------------------
|
|
%% MQTT Client
|
|
%%--------------------------------------------------------------------
|
|
|
|
-type(ws_header_key() :: atom() | binary() | string()).
|
|
-type(ws_header_val() :: atom() | binary() | string() | integer()).
|
|
|
|
-record(mqtt_client,
|
|
{ client_id :: binary() | undefined,
|
|
client_pid :: pid(),
|
|
username :: binary() | undefined,
|
|
peername :: {inet:ip_address(), inet:port_number()},
|
|
clean_sess :: boolean(),
|
|
proto_ver :: 3 | 4,
|
|
keepalive = 0,
|
|
will_topic :: undefined | binary(),
|
|
ws_initial_headers :: list({ws_header_key(), ws_header_val()}),
|
|
connected_at :: erlang:timestamp()
|
|
}).
|
|
|
|
-type(mqtt_client() :: #mqtt_client{}).
|
|
|
|
%%--------------------------------------------------------------------
|
|
%% MQTT Session
|
|
%%--------------------------------------------------------------------
|
|
|
|
-record(mqtt_session,
|
|
{ client_id :: binary(),
|
|
sess_pid :: pid(),
|
|
clean_sess :: boolean()
|
|
}).
|
|
|
|
-type(mqtt_session() :: #mqtt_session{}).
|
|
|
|
%%--------------------------------------------------------------------
|
|
%% MQTT Message
|
|
%%--------------------------------------------------------------------
|
|
|
|
-type(mqtt_msgid() :: binary() | undefined).
|
|
|
|
-type(mqtt_pktid() :: 1..16#ffff | undefined).
|
|
|
|
-record(mqtt_message,
|
|
{ %% Global unique message ID
|
|
id :: mqtt_msgid(),
|
|
%% PacketId
|
|
pktid :: mqtt_pktid(),
|
|
%% ClientId and Username
|
|
from :: {binary(), undefined | binary()},
|
|
%% Topic that the message is published to
|
|
topic :: binary(),
|
|
%% Message QoS
|
|
qos = 0 :: 0 | 1 | 2,
|
|
%% Message Flags
|
|
flags = [] :: [retain | dup | sys],
|
|
%% Retain flag
|
|
retain = false :: boolean(),
|
|
%% Dup flag
|
|
dup = false :: boolean(),
|
|
%% $SYS flag
|
|
sys = false :: boolean(),
|
|
headers = [] :: list(),
|
|
%% Payload
|
|
payload :: binary(),
|
|
%% Timestamp
|
|
timestamp :: erlang:timestamp()
|
|
}).
|
|
|
|
-type(mqtt_message() :: #mqtt_message{}).
|
|
|
|
%%--------------------------------------------------------------------
|
|
%% MQTT Delivery
|
|
%%--------------------------------------------------------------------
|
|
|
|
-record(mqtt_delivery,
|
|
{ sender :: pid(), %% Pid of the sender/publisher
|
|
message :: mqtt_message(), %% Message
|
|
flows :: list()
|
|
}).
|
|
|
|
-type(mqtt_delivery() :: #mqtt_delivery{}).
|
|
|
|
%%--------------------------------------------------------------------
|
|
%% MQTT Route
|
|
%%--------------------------------------------------------------------
|
|
|
|
-record(mqtt_route,
|
|
{ topic :: binary(),
|
|
node :: node()
|
|
}).
|
|
|
|
-type(mqtt_route() :: #mqtt_route{}).
|
|
|
|
%%--------------------------------------------------------------------
|
|
%% MQTT Alarm
|
|
%%--------------------------------------------------------------------
|
|
|
|
-record(mqtt_alarm,
|
|
{ id :: binary(),
|
|
severity :: warning | error | critical,
|
|
title :: iolist() | binary(),
|
|
summary :: iolist() | binary(),
|
|
timestamp :: erlang:timestamp() %% Timestamp
|
|
}).
|
|
|
|
-type(mqtt_alarm() :: #mqtt_alarm{}).
|
|
|
|
%%--------------------------------------------------------------------
|
|
%% MQTT Plugin
|
|
%%--------------------------------------------------------------------
|
|
|
|
-record(mqtt_plugin, { name, version, descr, active = false }).
|
|
|
|
-type(mqtt_plugin() :: #mqtt_plugin{}).
|
|
|
|
%%--------------------------------------------------------------------
|
|
%% MQTT CLI Command
|
|
%% For example: 'broker metrics'
|
|
%%--------------------------------------------------------------------
|
|
|
|
-record(mqtt_cli, { name, action, args = [], opts = [], usage, descr }).
|
|
|
|
-type(mqtt_cli() :: #mqtt_cli{}).
|
|
|