yuanbiao
/
emqx
1
0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

chore(willmsg): add come comments

This commit is contained in:
William Yang 2023-11-21 13:35:46 +01:00
parent e5a3574d89
commit 2ff33f98ef
1 changed files with 11 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
apps/emqx/src/emqx_channel.erl
View File

@ -2248,23 +2248,26 @@ session_disconnect(_ClientInfo, _ConnInfo, undefined) ->
%% - EMQX operations on the client %% - EMQX operations on the client
%% @NOTE: %% @NOTE:
%% Connection close with session expiry interval = 0 means session close. %% Connection close with session expiry interval = 0 means session close.
%% @NOTE:
%% The caller does not need to take care of the case when process terminates while will_msg is published
%% as it is designed by the spec.
-spec maybe_publish_will_msg(Reason, channel()) -> channel() when -spec maybe_publish_will_msg(Reason, channel()) -> channel() when
Reason :: Reason ::
%% Connection will terminate because session is taken over by another process. %% Connection is terminating because session is taken over by another process.
takenover takenover
%% Connection will terminate because of EMQX mgmt operation, also delete the session. %% Connection is terminating because of EMQX mgmt operation, also delete the session.
| kicked | kicked
%% Connection will terminate because session is taken over by another process. %% Connection is terminating because session is taken over by another process.
| discarded | discarded
%% Connection will terminate because session is expired %% Connection is terminating because session is expired
| expired | expired
%% Connection will terminate because of socket close/error %% Connection is terminating because of socket close/error
| sock_closed | sock_closed
%% Connection will terminate with Reasons %% Connection is terminating with Reasons
| {shutdown, atom()} | {shutdown, atom()}
%% Connection will terminate soon, delay willmsg publish is impossible. %% Connection is terminating, delay willmsg publish is impossible.
| ?chan_terminating | ?chan_terminating
%% Connection will terminate because of normal MQTT disconnection, implies delete the session. %% Connection is terminating because of normal MQTT disconnection, implies delete the session.
| normal. | normal.
maybe_publish_will_msg(normal, Channel) -> maybe_publish_will_msg(normal, Channel) ->
%% [MQTT-3.1.2-8] %% [MQTT-3.1.2-8]