mc_gen_rpc

%%% -*-mode:erlang;coding:utf-8;tab-width:4;c-basic-offset:4;indent-tabs-mode:()-*-
%%% ex: set ft=erlang fenc=utf-8 sts=4 ts=4 sw=4 et:
%%%
%%% Copyright 2015 Panagiotis Papadomitsos. All Rights Reserved.
%%% Copyright 2021 Miniclip. All Rights Reserved.
%%%
%%% Original concept inspired and some code copied from
%%% https://erlangcentral.org/wiki/index.php?title=Building_a_Non-blocking_TCP_server_using_OTP_principles

-module(gen_rpc_server).
-author("Panagiotis Papadomitsos <pj@ezgr.net>").

%%% Behaviour
-behaviour(gen_statem).

%%% Include the HUT library
-include_lib("hut/include/hut.hrl").
%%% Include this library's name macro
-include("app.hrl").

%%% Local state
%%% Local state
-record(state, {socket :: port(),
        driver :: atom(),
        driver_mod :: atom()}).
-elvis([{elvis_style, state_record_and_type, disable}]).

%%% Server functions
-export([start_link/1, stop/1]).

%% gen_statem callbacks
-export([init/1, handle_event/4, callback_mode/0, terminate/3, code_change/4]).

%% State machine states
-export([waiting_for_connection/3]).

-ignore_xref(start_link/1).
-ignore_xref(stop/1).
-ignore_xref(waiting_for_connection/3).

%%% ===================================================
%%% Supervisor functions
%%% ===================================================
-spec start_link(atom()) -> gen_statem:start_ret().
start_link(Driver) when is_atom(Driver) ->
    case gen_rpc_helper:is_driver_enabled(Driver) of
        false -> ignore;
        true -> gen_statem:start_link({local,gen_rpc_helper:make_process_name("server", Driver)}, ?MODULE, {Driver}, [])
    end.

-spec stop(atom()) -> ok.
stop(Driver) when is_atom(Driver) ->
    gen_statem:stop(gen_rpc_helper:make_process_name("server", Driver), normal, infinity).

%%% ===================================================
%%% Behaviour callbacks
%%% ===================================================
init({Driver}) ->
    ok = gen_rpc_helper:set_optimal_process_flags(),
    _ = erlang:process_flag(trap_exit, false),
    {DriverMod, DriverPort, _ClosedMsg, _ErrorMsg} = gen_rpc_helper:get_server_driver_options(Driver),
    case DriverMod:listen(DriverPort) of
        {ok, Socket} ->
            %% Launch a new acceptor with a new accept socket
            ?log(info, "event=server_setup_successfully driver=~s socket=\"~s\"", [Driver, gen_rpc_helper:socket_to_string(Socket)]),
            {ok, waiting_for_connection, #state{socket=Socket, driver=Driver, driver_mod=DriverMod}, {next_event,internal,accept}};
        {error, Reason} ->
            ?log(error, "event=failed_to_setup_server driver=~s reason=\"~p\"", [Driver, Reason]),
            {stop, Reason}
    end.

callback_mode() ->
    state_functions.

waiting_for_connection(internal, accept, #state{socket=ListSock, driver=Driver, driver_mod=DriverMod} = State) ->
    case DriverMod:accept(ListSock) of
        {ok, AccSock} ->
            ?log(info, "event=client_connection_received driver=~s socket=\"~s\" action=starting_acceptor",
                 [Driver, gen_rpc_helper:socket_to_string(ListSock)]),
            Peer = DriverMod:get_peer(AccSock),
            {ok, AccPid} = gen_rpc_acceptor_sup:start_child(Driver, Peer),
            case DriverMod:copy_sock_opts(ListSock, AccSock) of
                ok -> ok;
                {error, Reason} -> exit({set_sock_opt, Reason})
            end,
            ok = DriverMod:set_controlling_process(AccSock, AccPid),
            ok = gen_rpc_acceptor:set_socket(AccPid, AccSock),
            {keep_state_and_data, {next_event,internal,accept}};
        {error, Reason} ->
            ?log(error, "event=socket_error_event driver=~s socket=\"~s\" event=\"~p\" action=stopping",
                 [Driver, gen_rpc_helper:socket_to_string(ListSock), Reason]),
            {stop, {socket_error, Reason}, State}
    end.

handle_event(EventType, Event, StateName, #state{socket=Socket, driver=Driver} = State) ->
    ?log(error, "event=uknown_event driver=~s socket=\"~s\" event_type=\"~p\" payload=\"~p\" action=stopping",
         [Driver, gen_rpc_helper:socket_to_string(Socket), EventType, Event]),
    {stop, {StateName, undefined_event, Event}, State}.

terminate(_Reason, _StateName, _State) ->
    ok.

code_change(_OldVsn, StateName, State, _Extra) ->
    {ok, StateName, State}.

%%% ===================================================
%%% Private functions
%%% ===================================================