From e008d149d3900940dfb07807bf85b63fdfb14f63 Mon Sep 17 00:00:00 2001
From: Feng Lee <feng@emqtt.io>
Date: Mon, 6 Mar 2017 18:57:29 +0800
Subject: [PATCH] Update comments and misc fix

---
 src/emqttd_broker.erl        | 2 +-
 src/emqttd_client.erl        | 2 +-
 src/emqttd_serializer.erl    | 2 +-
 src/emqttd_session.erl       | 8 ++++----
 src/emqttd_ws.erl            | 4 ++--
 src/emqttd_ws_client.erl     | 5 +++--
 src/emqttd_ws_client_sup.erl | 2 +-
 7 files changed, 13 insertions(+), 12 deletions(-)

diff --git a/src/emqttd_broker.erl b/src/emqttd_broker.erl
index ce2e4210c..4f8ade17d 100644
--- a/src/emqttd_broker.erl
+++ b/src/emqttd_broker.erl
@@ -113,7 +113,7 @@ stop_tick(TRef) ->
     timer:cancel(TRef).
 
 %%--------------------------------------------------------------------
-%% gen_server callbacks
+%% gen_server Callbacks
 %%--------------------------------------------------------------------
 
 init([]) ->
diff --git a/src/emqttd_client.erl b/src/emqttd_client.erl
index e3e68b8e4..70a9729fa 100644
--- a/src/emqttd_client.erl
+++ b/src/emqttd_client.erl
@@ -291,7 +291,7 @@ code_change(_OldVsn, State, _Extra) ->
 %% Internal functions
 %%--------------------------------------------------------------------
 
-%% Receive and parse tcp data
+%% Receive and Parse TCP Data
 received(<<>>, State) ->
     {noreply, gc(State), hibernate};
 
diff --git a/src/emqttd_serializer.erl b/src/emqttd_serializer.erl
index a47a23c8b..079cfbb3c 100644
--- a/src/emqttd_serializer.erl
+++ b/src/emqttd_serializer.erl
@@ -28,7 +28,7 @@
 
 %% @doc Serialise MQTT Packet
 -spec(serialize(mqtt_packet()) -> iolist()).
-serialize(#mqtt_packet{header = Header = #mqtt_packet_header{type = Type},
+serialize(#mqtt_packet{header   = Header = #mqtt_packet_header{type = Type},
                        variable = Variable,
                        payload  = Payload}) ->
     serialize_header(Header,
diff --git a/src/emqttd_session.erl b/src/emqttd_session.erl
index 288565a3a..85b027781 100644
--- a/src/emqttd_session.erl
+++ b/src/emqttd_session.erl
@@ -129,12 +129,12 @@
          %% Client -> Broker: Inflight QoS2 messages received from client and waiting for pubrel.
          awaiting_rel :: map(),
 
-         %% Awaiting PUBREL timeout
-         await_rel_timeout = 20000 :: timeout(),
-
          %% Max Packets that Awaiting PUBREL
          max_awaiting_rel = 100 :: non_neg_integer(),
 
+         %% Awaiting PUBREL timeout
+         await_rel_timeout = 20000 :: timeout(),
+
          %% Awaiting PUBREL timer
          await_rel_timer :: reference(),
 
@@ -580,7 +580,7 @@ code_change(_OldVsn, Session, _Extra) ->
     {ok, Session}.
 
 %%--------------------------------------------------------------------
-%% Kick old client
+%% Kickout old client
 %%--------------------------------------------------------------------
 kick(_ClientId, undefined, _Pid) ->
     ignore;
diff --git a/src/emqttd_ws.erl b/src/emqttd_ws.erl
index b292c39bc..c6a68150d 100644
--- a/src/emqttd_ws.erl
+++ b/src/emqttd_ws.erl
@@ -37,8 +37,8 @@
 
 %% @doc Handle WebSocket Request.
 handle_request(Req) ->
-    {ok, Env} = emqttd:env(protocol),
-    PacketSize = get_value(max_packet_size, Env, ?MAX_PACKET_SIZE),
+    {ok, ProtoEnv} = emqttd:env(protocol),
+    PacketSize = get_value(max_packet_size, ProtoEnv, ?MAX_PACKET_SIZE),
     Parser = emqttd_parser:initial_state(PacketSize),
     %% Upgrade WebSocket.
     {ReentryWs, ReplyChannel} = mochiweb_websocket:upgrade_connection(Req, fun ?MODULE:ws_loop/3),
diff --git a/src/emqttd_ws_client.erl b/src/emqttd_ws_client.erl
index bde322dcf..c89fae7e4 100644
--- a/src/emqttd_ws_client.erl
+++ b/src/emqttd_ws_client.erl
@@ -92,14 +92,15 @@ init([Env, WsPid, Req, ReplyChannel]) ->
     {ok, Peername} = Req:get(peername),
     Headers = mochiweb_headers:to_list(
                 mochiweb_request:get(headers, Req)),
+    Conn = Req:get(connection),
     ProtoState = emqttd_protocol:init(Peername, send_fun(ReplyChannel),
                                       [{ws_initial_headers, Headers} | Env]),
     IdleTimeout = get_value(client_idle_timeout, Env, 30000),
     EnableStats = get_value(client_enable_stats, Env, false),
     ForceGcCount = emqttd_gc:conn_max_gc_count(),
-    {ok, #wsclient_state{ws_pid         = WsPid,
+    {ok, #wsclient_state{connection     = Conn,
+                         ws_pid         = WsPid,
                          peername       = Peername,
-                         connection     = Req:get(connection),
                          proto_state    = ProtoState,
                          enable_stats   = EnableStats,
                          force_gc_count = ForceGcCount},
diff --git a/src/emqttd_ws_client_sup.erl b/src/emqttd_ws_client_sup.erl
index 1375ac036..21f683eaa 100644
--- a/src/emqttd_ws_client_sup.erl
+++ b/src/emqttd_ws_client_sup.erl
@@ -29,7 +29,7 @@
 start_link() ->
     supervisor:start_link({local, ?MODULE}, ?MODULE, []).
 
-%% @doc Start a WebSocket Client
+%% @doc Start a WebSocket Connection.
 -spec(start_client(pid(), mochiweb_request:request(), fun()) -> {ok, pid()}).
 start_client(WsPid, Req, ReplyChannel) ->
     supervisor:start_child(?MODULE, [WsPid, Req, ReplyChannel]).