Merge pull request #1136 from emqtt/develop

Update functions spec
This commit is contained in:
Feng Lee 2017-07-06 19:36:38 +08:00 committed by GitHub
commit a7434f27b9
5 changed files with 8 additions and 10 deletions

View File

@ -122,7 +122,7 @@ topics() -> emqttd_router:topics().
subscribers(Topic) ->
emqttd_server:subscribers(iolist_to_binary(Topic)).
-spec(subscriptions(subscriber()) -> [{binary(), suboption()}]).
-spec(subscriptions(subscriber()) -> [{binary(), binary(), list(suboption())}]).
subscriptions(Subscriber) ->
emqttd_server:subscriptions(Subscriber).

View File

@ -249,8 +249,6 @@ subscriptions(["add", ClientId, Topic, QoS]) ->
case emqttd:subscribe(bin(Topic), bin(ClientId), [{qos, IntQos}]) of
ok ->
?PRINT_MSG("ok~n");
{error, already_existed} ->
?PRINT_MSG("Error: already existed~n");
{error, Reason} ->
?PRINT("Error: ~p~n", [Reason])
end

View File

@ -102,7 +102,7 @@ start_link() ->
gen_server:start_link({local, ?SERVER}, ?MODULE, [], []).
%% @doc Count packets received.
-spec(received(mqtt_packet()) -> ok).
-spec(received(mqtt_packet()) -> ignore | non_neg_integer()).
received(Packet) ->
inc('packets/received'),
received1(Packet).
@ -140,7 +140,7 @@ qos_received(?QOS_2) ->
inc('messages/qos2/received').
%% @doc Count packets received. Will not count $SYS PUBLISH.
-spec(sent(mqtt_packet()) -> ok).
-spec(sent(mqtt_packet()) -> ignore | non_neg_integer()).
sent(?PUBLISH_PACKET(_Qos, <<"$SYS/", _/binary>>, _, _)) ->
ignore;
sent(Packet) ->
@ -169,7 +169,7 @@ sent2(?UNSUBACK) ->
sent2(?PINGRESP) ->
inc('packets/pingresp');
sent2(_Type) ->
ingore.
ignore.
qos_sent(?QOS_0) ->
inc('messages/qos0/sent');
qos_sent(?QOS_1) ->

View File

@ -130,7 +130,7 @@ async_unsubscribe(Topic, Subscriber) when is_binary(Topic) ->
setqos(Topic, Subscriber, Qos) when is_binary(Topic) ->
call(pick(Subscriber), {setqos, Topic, Subscriber, Qos}).
-spec(subscriptions(emqttd:subscriber()) -> [{binary(), list(emqttd:suboption())}]).
-spec(subscriptions(emqttd:subscriber()) -> [{binary(), binary(), list(emqttd:suboption())}]).
subscriptions(Subscriber) ->
lists:map(fun({_, {_Share, Topic}}) ->
subscription(Topic, Subscriber);

View File

@ -120,7 +120,7 @@
retry_interval = 20000 :: timeout(),
%% Retry Timer
retry_timer :: reference(),
retry_timer :: reference() | undefined,
%% All QoS1, QoS2 messages published to when client is disconnected.
%% QoS 1 and QoS 2 messages pending transmission to the Client.
@ -138,13 +138,13 @@
await_rel_timeout = 20000 :: timeout(),
%% Awaiting PUBREL timer
await_rel_timer :: reference(),
await_rel_timer :: reference() | undefined,
%% Session Expiry Interval
expiry_interval = 7200000 :: timeout(),
%% Expired Timer
expiry_timer :: reference(),
expiry_timer :: reference() | undefined,
%% Enable Stats
enable_stats :: boolean(),