Cowboy 源码分析(十八)
在上一篇中,我們整理了下cowboy_http_protocol:header/3函數,在文章的末尾留下2個沒有講到的函數,今天,我們先看下cowboy_http_protocol:error_terminate/2函數,另一個函數下一篇,我們再看。cowboy_http_protocol:error_terminate/2函數定義如下:
%% Only send an error reply if there is no resp_sent message. -spec error_terminate(cowboy_http:status(), #state{}) -> ok. error_terminate(Code, State=#state{socket=Socket, transport=Transport,onresponse=OnResponse}) ->receive{cowboy_http_req, resp_sent} -> okafter 0 ->_ = cowboy_http_req:reply(Code, #http_req{socket=Socket, transport=Transport, onresponse=OnResponse,connection=close, pid=self(), resp_state=waiting}),okend,terminate(State).-spec terminate(#state{}) -> ok. terminate(#state{socket=Socket, transport=Transport}) ->Transport:close(Socket),ok.這個函數,僅僅是給客戶端一個錯誤答復。Code是代表返回的HTTP狀態碼,具體每個值代表什么意思,大家可以參考下維基百科的HTTP狀態碼 這個需要大家了解下HTTP協議的相關內容。真的很有必要,了解底層的一些協議。建議大家買幾本相關的書看看。
好了,回到邏輯本身,這里有個知識點,摘自《Erlang程序設計》 109頁:
超時時間為0的receive
? 一個超時時間為0的語句會立即觸發一個超時,但在此之前,系統會嘗試對郵箱進行模式匹配,我們可以利用這個特性來定一個flush_buffer函數,它可以完全清空進程郵箱中的所有消息:
flush_buffer() ->receive_Any ->flush_buffer()after 0 ->trueend.好了,回到邏輯中,這個函數會檢查進程的郵箱中是否存在 {cowboy_http_req, resp_sent} 消息,如果存在,則返回 ok,緊接著馬上觸發一個超時,我們來看下,超時中的處理代碼:
_ = cowboy_http_req:reply(Code, #http_req{socket=Socket, transport=Transport, onresponse=OnResponse,connection=close, pid=self(), resp_state=waiting}),ok這里調用 cowboy_http_req:reply/2 函數,并且忽略返回值,緊接著返回 ok,這里我們來重點看下這個函數:
%% @equiv reply(Status, [], [], Req) -spec reply(cowboy_http:status(), #http_req{}) -> {ok, #http_req{}}. reply(Status, Req=#http_req{resp_body=Body}) ->reply(Status, [], Body, Req).%% @equiv reply(Status, Headers, [], Req) -spec reply(cowboy_http:status(), cowboy_http:headers(), #http_req{})-> {ok, #http_req{}}. reply(Status, Headers, Req=#http_req{resp_body=Body}) ->reply(Status, Headers, Body, Req).%% @doc Send a reply to the client. -spec reply(cowboy_http:status(), cowboy_http:headers(), iodata(), #http_req{})-> {ok, #http_req{}}. reply(Status, Headers, Body, Req=#http_req{socket=Socket, transport=Transport,version=Version, connection=Connection,method=Method, resp_state=waiting, resp_headers=RespHeaders}) ->RespConn = response_connection(Headers, Connection),ContentLen = case Body of {CL, _} -> CL; _ -> iolist_size(Body) end,HTTP11Headers = case Version of{1, 1} -> [{<<"Connection">>, atom_to_connection(Connection)}];_ -> []end,{ReplyType, Req2} = response(Status, Headers, RespHeaders, [{<<"Content-Length">>, integer_to_list(ContentLen)},{<<"Date">>, cowboy_clock:rfc1123()},{<<"Server">>, <<"Cowboy">>}|HTTP11Headers], Req),if Method =:= 'HEAD' -> ok;ReplyType =:= hook -> ok; %% Hook replied for us, stop there.true ->case Body of{_, StreamFun} -> StreamFun();_ -> Transport:send(Socket, Body)endend,{ok, Req2#http_req{connection=RespConn, resp_state=done,resp_headers=[], resp_body= <<>>}}.不管是 reply/2,還是reply/3最后都是調用reply/4函數,這個函數是給客戶端發一個回復,代碼量相對多些,我們來詳細看下:
我們看下,函數參數:參數Status就是Code,也就是HTTP狀態碼,Headers為空列表 [],Req=#http_req{resp_body=Body},這里的Body為默認值 resp_body? = <<>>,Sokcet的值為連接到服務器的連接,Transport 為cowboy_tcp_transport,Version 值為 {1,1},其他:Connection = keepalive,Method = 'GET',RespHeaders = [],有些值是默認值,大家可以看下記錄的定義。
來看具體邏輯:
RespConn = response_connection(Headers, Connection), 這里調用cowboy_http_req:response_connection/2函數,函數代碼如下:
-spec response_connection(cowboy_http:headers(), keepalive | close)-> keepalive | close. response_connection([], Connection) ->Connection; response_connection([{Name, Value}|Tail], Connection) ->case Name of'Connection' -> response_connection_parse(Value);Name when is_atom(Name) -> response_connection(Tail, Connection);Name ->Name2 = cowboy_bstr:to_lower(Name),case Name2 of<<"connection">> -> response_connection_parse(Value);_Any -> response_connection(Tail, Connection)endend.這里Headers為空列表 [],所以這里只返回了Connection狀態,也就是keepalive,當參數Headers不為空列表時,會走下面的分支,這里判斷Name的值,如果為'Connection',則調用cowboy_http_req:response_connection_parse/1函數,代碼如下:
-spec response_connection_parse(binary()) -> keepalive | close. response_connection_parse(ReplyConn) ->Tokens = cowboy_http:nonempty_list(ReplyConn, fun cowboy_http:token/2),cowboy_http:connection_to_atom(Tokens).我在Cowboy 源碼分析(十三)和Cowboy 源碼分析(十四) 很詳細的看了cowboy_http:nonempty_list/2和cowboy_http:token/2這兩個函數,同樣的,我們在Cowboy 源碼分析(十六) 也講過ConnAtom = cowboy_http:connection_to_atom(ConnTokens)這個函數,這里就不重復看了,大家如果忘了,可以點鏈接回憶下,溫故而知新,還有個函數cowboy_bstr:to_lower/1更簡單,也不打算講。
我們接著看 ContentLen = case Body of {CL, _} -> CL; _ -> iolist_size(Body) end, 這里如果Body的值為{CL, _}格式,則ContentLen的值為CL,否則為iolist_size(Body)。這個函數我們第一次遇到,看下 erlang doc,地址:http://www.erlang.org/doc/man/erlang.html#iolist_size-1。比較簡單,大家也可以看下這篇文章,堅強2002同學,很詳細的講解了iolist:http://www.cnblogs.com/me-sa/archive/2012/01/31/erlang0034.html,我自己也做了些簡單的練習,如圖:
好了,這個函數,大家也好好理解下,我們接著往下看:
HTTP11Headers = case Version of{1, 1} -> [{<<"Connection">>, atom_to_connection(Connection)}];_ -> []end,構建,HTTP 1.1 Header,如果HTTP協議版本為{1, 1},則返回,[{<<"Connection">>, atom_to_connection(Connection)}];這里,我們看下cowboy_http_req:atom_to_connection/1函數:
-spec atom_to_connection(keepalive) -> <<_:80>>;(close) -> <<_:40>>. atom_to_connection(keepalive) -><<"keep-alive">>; atom_to_connection(close) -><<"close">>.一看就能明白,不解釋了,HTTP11Headers這個變量值可能為[{<<"Connection">>, <<"keep-alive">>}]或者[{<<"Connection">>, <<"close">>}]。
由于篇幅太長,今天我們就看到這里,下一篇,我們繼續從下面這一行開始:
{ReplyType, Req2} = response(Status, Headers, RespHeaders, [{<<"Content-Length">>, integer_to_list(ContentLen)},{<<"Date">>, cowboy_clock:rfc1123()},{<<"Server">>, <<"Cowboy">>}|HTTP11Headers], Req),? 最后,謝謝大家支持,晚安。
2012-06-25補充:
在翻看這篇文章和之后的文章時,發現漏講了cowboy_http_req:reply/4 函數部分代碼,故補充在這里:
if Method =:= 'HEAD' -> ok;ReplyType =:= hook -> ok; %% Hook replied for us, stop there.true ->case Body of{_, StreamFun} -> StreamFun();_ -> Transport:send(Socket, Body)endend,{ok, Req2#http_req{connection=RespConn, resp_state=done,resp_headers=[], resp_body= <<>>}}.這其實也比較簡單,這里判斷Method 是否全等于 'HEAD',如果是返回 ok;ReplyType 是否全等于hook,如果是返回ok;否則,根據Body情況進行匹配,這里如果是返回HTTP狀態碼,也就是Body為[],則都不匹配,如果 Body = <<"Hello world!">>,則把Body發送給連接到服務器的Socket。
最后,修改了connection的值為RespConn,resp_state為done,其他就不解釋了,都能看的懂。
很抱歉,之前寫完,并沒有很好的檢查。
總結
以上是生活随笔為你收集整理的Cowboy 源码分析(十八)的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 各自用一句话来概括MVC、MVP、MVV
- 下一篇: 关于jquery ajax发送以及php