Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(keep alive): remove force ping handling #116

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+1 −35
Open

fix(keep alive): remove force ping handling #116

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 1 addition & 35 deletions src/emqtt.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,6 @@
| {will_props, properties()}
| {auto_ack, boolean()}
| {ack_timeout, pos_integer()}
| {force_ping, boolean()}
| {properties, properties()}).

-type(maybe(T) :: undefined | T).
Expand Down Expand Up @@ -187,7 +186,6 @@
proto_name :: iodata(),
keepalive :: non_neg_integer(),
keepalive_timer :: maybe(reference()),
force_ping :: boolean(),
paused :: boolean(),
will_flag :: boolean(),
will_msg :: mqtt_msg(),
Expand Down Expand Up @@ -469,7 +467,6 @@ init([Options]) ->
proto_ver = ?MQTT_PROTO_V4,
proto_name = <<"MQTT">>,
keepalive = ?DEFAULT_KEEPALIVE,
force_ping = false,
paused = false,
will_flag = false,
will_msg = #mqtt_msg{},
Expand Down Expand Up @@ -572,10 +569,6 @@ init([{connect_timeout, Timeout}| Opts], State) ->
init(Opts, State#state{connect_timeout = timer:seconds(Timeout)});
init([{ack_timeout, Timeout}| Opts], State) ->
init(Opts, State#state{ack_timeout = timer:seconds(Timeout)});
init([force_ping | Opts], State) ->
init(Opts, State#state{force_ping = true});
init([{force_ping, ForcePing} | Opts], State) when is_boolean(ForcePing) ->
init(Opts, State#state{force_ping = ForcePing});
init([{properties, Properties} | Opts], State = #state{properties = InitProps}) ->
init(Opts, State#state{properties = maps:merge(InitProps, Properties)});
init([{max_inflight, infinity} | Opts], State) ->
Expand Down Expand Up @@ -903,31 +896,13 @@ connected(cast, ?PACKET(?PINGRESP), State) ->
connected(cast, ?DISCONNECT_PACKET(ReasonCode, Properties), State) ->
{stop, {disconnected, ReasonCode, Properties}, State};

connected(info, {timeout, _TRef, keepalive}, State = #state{force_ping = true}) ->
connected(info, {timeout, _TRef, keepalive}, State) ->
case send(?PACKET(?PINGREQ), State) of
{ok, NewState} ->
{keep_state, ensure_keepalive_timer(NewState)};
Error -> {stop, Error}
end;

connected(info, {timeout, TRef, keepalive},
State = #state{conn_mod = ConnMod, socket = Sock,
paused = Paused, keepalive_timer = TRef}) ->
case (not Paused) andalso should_ping(ConnMod, Sock) of
true ->
case send(?PACKET(?PINGREQ), State) of
{ok, NewState} ->
{ok, [{send_oct, Val}]} = ConnMod:getstat(Sock, [send_oct]),
put(send_oct, Val),
{keep_state, ensure_keepalive_timer(NewState), [hibernate]};
Error -> {stop, Error}
end;
false ->
{keep_state, ensure_keepalive_timer(State), [hibernate]};
{error, Reason} ->
{stop, Reason}
end;

connected(info, {timeout, TRef, ack}, State = #state{ack_timer = TRef,
ack_timeout = Timeout,
pending_calls = Calls}) ->
Expand Down Expand Up @@ -1027,15 +1002,6 @@ code_change(_Vsn, State, Data, _Extra) ->
%% Internal functions
%%--------------------------------------------------------------------

should_ping(ConnMod, Sock) ->
case ConnMod:getstat(Sock, [send_oct]) of
{ok, [{send_oct, Val}]} ->
OldVal = get(send_oct), put(send_oct, Val),
OldVal == undefined orelse OldVal == Val;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

since PING is a one-byte request the correct fix should be to check if OldVal < Val -1 ?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PINGREQ has more than one byte. If we insist on subtracting the length of the PINGREQ ourselves, it is okay, but the force_ping mechanism is useless. It is simplest to send PINGREQ at a fixed time.

Error = {error, _Reason} ->
Error
end.

is_inflight_full(#state{max_inflight = infinity}) ->
false;
is_inflight_full(#state{max_inflight = MaxLimit, inflight = Inflight}) ->
Expand Down