Packages

cowmachine

1.17.0
1.17.0 1.16.1 1.16.0 1.15.1 1.15.0 1.14.0 1.13.1 1.13.0 1.12.1 1.12.0 1.11.1 1.11.0 1.10.3 1.10.2 1.10.0 1.9.0 1.8.3 1.8.2 1.8.1 1.8.0 1.7.1 1.7.0 1.6.3 1.6.2 1.6.1 1.6.0 1.5.4 1.5.3 1.5.2 1.5.1 1.5.0 1.4.0 1.3.0 1.2.2 1.2.1 1.2.0 1.1.1 1.1.0 1.0.2 1.0.1 1.0.0 1.0.0-alpha4 0.0.0

Webmachine for Cowboy and Zotonic

HexDocs

Current section

Files

Jump to
Readme
43 Versions
4 Dependencies
Dependants
Files
Activity
cowmachine src cowmachine_websocket_upgrade.erl
Raw

src/cowmachine_websocket_upgrade.erl 

-module(cowmachine_websocket_upgrade).



-export([

    upgrade/2

    ]).



%% @doc Upgrade the request to a websocket request



-spec upgrade(Handler, Context) -> Result when

	Handler :: atom(), 

	Context :: cowmachine_req:context(),

	Result :: {ok, cowboy_req:req(), cowboy_middleware:env()}.

upgrade(Handler, Context) ->

    Req = cowmachine_req:req(Context),

    Env = cowmachine_req:env(Context),

    Opts = ws_opts(Context),



    % Ensure the handler module is loaded. Cowboy uses erlang:function_exported/3 to

    % check if optional callbacks are available. When the handler module is not loaded

    % yet it will not call the optional callbacks for the first request. This ensures

    % the module will be loaded.

    {module, Handler} = code:ensure_loaded(Handler),



    cowboy_websocket:upgrade(Req, Env, Handler, Context, Opts).



% Reasonably safe websocket config.

ws_opts(Context) ->

    case cowmachine_req:get_metadata(ws_opts, Context) of

        M when is_map(M) ->

            maps:merge(ws_defaults(), M);

        _ ->

            ws_defaults()

    end.



ws_defaults() ->

    #{

      idle_timeout => 120000, % For slow clients while also preventing slow client DoS

      max_frame_size => 524288, % 512kb

      compress => true

     }.