179 lines
6.1 KiB
Erlang
179 lines
6.1 KiB
Erlang
%%%-----------------------------------------------------------------------------
|
|
%%% Copyright (c) 2012-2015 eMQTT.IO, All Rights Reserved.
|
|
%%%
|
|
%%% Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
%%% of this software and associated documentation files (the "Software"), to deal
|
|
%%% in the Software without restriction, including without limitation the rights
|
|
%%% to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
%%% copies of the Software, and to permit persons to whom the Software is
|
|
%%% furnished to do so, subject to the following conditions:
|
|
%%%
|
|
%%% The above copyright notice and this permission notice shall be included in all
|
|
%%% copies or substantial portions of the Software.
|
|
%%%
|
|
%%% THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
%%% IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
%%% FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
%%% AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
%%% LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
%%% OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
%%% SOFTWARE.
|
|
%%%-----------------------------------------------------------------------------
|
|
%%% @doc
|
|
%%% MQTT Broker Header.
|
|
%%%
|
|
%%% @end
|
|
%%%-----------------------------------------------------------------------------
|
|
|
|
%%------------------------------------------------------------------------------
|
|
%% Banner
|
|
%%------------------------------------------------------------------------------
|
|
-define(COPYRIGHT, "Copyright (C) 2012-2015, Feng Lee <feng@emqtt.io>").
|
|
|
|
-define(LICENSE_MESSAGE, "Licensed under MIT").
|
|
|
|
-define(PROTOCOL_VERSION, "MQTT/3.1.1").
|
|
|
|
-define(ERTS_MINIMUM, "6.0").
|
|
|
|
%% System Topics.
|
|
-define(SYSTOP, <<"$SYS">>).
|
|
|
|
%% Queue Topics.
|
|
-define(QTop, <<"$Q">>).
|
|
|
|
%%------------------------------------------------------------------------------
|
|
%% PubSub
|
|
%%------------------------------------------------------------------------------
|
|
-type pubsub() :: publish | subscribe.
|
|
|
|
-define(IS_PUBSUB(PS), (PS =:= publish orelse PS =:= subscribe)).
|
|
|
|
%%------------------------------------------------------------------------------
|
|
%% MQTT Topic
|
|
%%------------------------------------------------------------------------------
|
|
-record(mqtt_topic, {
|
|
topic :: binary(),
|
|
node :: node()
|
|
}).
|
|
|
|
-type mqtt_topic() :: #mqtt_topic{}.
|
|
|
|
%%------------------------------------------------------------------------------
|
|
%% MQTT Subscriber
|
|
%%------------------------------------------------------------------------------
|
|
-record(mqtt_subscriber, {
|
|
topic :: binary(),
|
|
subpid :: pid(),
|
|
qos = 0 :: 0 | 1 | 2
|
|
}).
|
|
|
|
-type mqtt_subscriber() :: #mqtt_subscriber{}.
|
|
|
|
%%------------------------------------------------------------------------------
|
|
%% P2P Queue Subscriber
|
|
%%------------------------------------------------------------------------------
|
|
-record(mqtt_queue, {
|
|
name :: binary(),
|
|
qpid :: pid(),
|
|
qos = 0 :: 0 | 1 | 2
|
|
}).
|
|
|
|
-type mqtt_queue() :: #mqtt_queue{}.
|
|
|
|
%%------------------------------------------------------------------------------
|
|
%% MQTT Client
|
|
%%------------------------------------------------------------------------------
|
|
|
|
-type header_key() :: atom() | binary() | string().
|
|
-type header_val() :: atom() | binary() | string() | integer().
|
|
|
|
-record(mqtt_client, {
|
|
client_id :: binary() | undefined,
|
|
client_pid :: pid(),
|
|
username :: binary() | undefined,
|
|
peername :: {inet:ip_address(), integer()},
|
|
clean_sess :: boolean(),
|
|
proto_ver :: 3 | 4,
|
|
keepalive = 0,
|
|
will_topic :: undefined | binary(),
|
|
ws_initial_headers :: list({header_key(), header_val()}),
|
|
connected_at :: erlang:timestamp()
|
|
}).
|
|
|
|
-type mqtt_client() :: #mqtt_client{}.
|
|
|
|
%%------------------------------------------------------------------------------
|
|
%% MQTT Session
|
|
%%------------------------------------------------------------------------------
|
|
-record(mqtt_session, {
|
|
client_id :: binary(),
|
|
sess_pid :: pid(),
|
|
persistent :: boolean()
|
|
}).
|
|
|
|
-type mqtt_session() :: #mqtt_session{}.
|
|
|
|
%%------------------------------------------------------------------------------
|
|
%% MQTT Message
|
|
%%------------------------------------------------------------------------------
|
|
-type mqtt_msgid() :: binary() | undefined.
|
|
-type mqtt_pktid() :: 1..16#ffff | undefined.
|
|
|
|
-record(mqtt_message, {
|
|
msgid :: mqtt_msgid(), %% Global unique message ID
|
|
pktid :: mqtt_pktid(), %% PacketId
|
|
topic :: binary(), %% Topic that the message is published to
|
|
from :: binary() | atom(), %% ClientId of publisher
|
|
qos = 0 :: 0 | 1 | 2, %% Message QoS
|
|
retain = false :: boolean(), %% Retain flag
|
|
dup = false :: boolean(), %% Dup flag
|
|
sys = false :: boolean(), %% $SYS flag
|
|
payload :: binary(), %% Payload
|
|
timestamp :: erlang:timestamp() %% os:timestamp
|
|
}).
|
|
|
|
-type mqtt_message() :: #mqtt_message{}.
|
|
|
|
%%------------------------------------------------------------------------------
|
|
%% MQTT Alarm
|
|
%%------------------------------------------------------------------------------
|
|
-record(mqtt_alarm, {
|
|
id :: binary(),
|
|
severity :: warning | error | critical,
|
|
title :: binary(),
|
|
summary :: binary(),
|
|
timestamp :: erlang:timestamp() %% Timestamp
|
|
}).
|
|
|
|
-type mqtt_alarm() :: #mqtt_alarm{}.
|
|
|
|
%%------------------------------------------------------------------------------
|
|
%% MQTT Plugin
|
|
%%------------------------------------------------------------------------------
|
|
-record(mqtt_plugin, {
|
|
name,
|
|
version,
|
|
descr,
|
|
config,
|
|
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{}.
|
|
|