commit 3cf38f3e89b0a0dc9ac9cc204cabc8151803d197 Author: anlicheng <244108715@qq.com> Date: Fri Jun 26 23:19:32 2026 +0800 init project diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..df53f7d --- /dev/null +++ b/.gitignore @@ -0,0 +1,20 @@ +.rebar3 +_build +_checkouts +_vendor +.eunit +*.o +*.beam +*.plt +*.swp +*.swo +.erlang.cookie +ebin +log +erl_crash.dump +.rebar +logs +.idea +*.iml +rebar3.crashdump +*~ diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..c5443b5 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,186 @@ +# Apache License +Version 2.0, January 2004 + +http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +## 1. Definitions. + +"License" shall mean the terms and conditions for use, reproduction, and +distribution as defined by Sections 1 through 9 of this document. + +"Licensor" shall mean the copyright owner or entity authorized by the copyright +owner that is granting the License. + +"Legal Entity" shall mean the union of the acting entity and all other entities +that control, are controlled by, or are under common control with that entity. +For the purposes of this definition, "control" means (i) the power, direct or +indirect, to cause the direction or management of such entity, whether by +contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the +outstanding shares, or (iii) beneficial ownership of such entity. + +"You" (or "Your") shall mean an individual or Legal Entity exercising +permissions granted by this License. + +"Source" form shall mean the preferred form for making modifications, including +but not limited to software source code, documentation source, and configuration +files. + +"Object" form shall mean any form resulting from mechanical transformation or +translation of a Source form, including but not limited to compiled object code, +generated documentation, and conversions to other media types. + +"Work" shall mean the work of authorship, whether in Source or Object form, made +available under the License, as indicated by a copyright notice that is included +in or attached to the work (an example is provided in the Appendix below). + +"Derivative Works" shall mean any work, whether in Source or Object form, that +is based on (or derived from) the Work and for which the editorial revisions, +annotations, elaborations, or other modifications represent, as a whole, an +original work of authorship. For the purposes of this License, Derivative Works +shall not include works that remain separable from, or merely link (or bind by +name) to the interfaces of, the Work and Derivative Works thereof. + +"Contribution" shall mean any work of authorship, including the original version +of the Work and any modifications or additions to that Work or Derivative Works +thereof, that is intentionally submitted to Licensor for inclusion in the Work +by the copyright owner or by an individual or Legal Entity authorized to submit +on behalf of the copyright owner. For the purposes of this definition, +"submitted" means any form of electronic, verbal, or written communication sent +to the Licensor or its representatives, including but not limited to +communication on electronic mailing lists, source code control systems, and +issue tracking systems that are managed by, or on behalf of, the Licensor for +the purpose of discussing and improving the Work, but excluding communication +that is conspicuously marked or otherwise designated in writing by the copyright +owner as "Not a Contribution." + +"Contributor" shall mean Licensor and any individual or Legal Entity on behalf +of whom a Contribution has been received by Licensor and subsequently +incorporated within the Work. + +## 2. Grant of Copyright License. + +Subject to the terms and conditions of this License, each Contributor hereby +grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, +irrevocable copyright license to reproduce, prepare Derivative Works of, +publicly display, publicly perform, sublicense, and distribute the Work and such +Derivative Works in Source or Object form. + +## 3. Grant of Patent License. + +Subject to the terms and conditions of this License, each Contributor hereby +grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, +irrevocable (except as stated in this section) patent license to make, have +made, use, offer to sell, sell, import, and otherwise transfer the Work, where +such license applies only to those patent claims licensable by such Contributor +that are necessarily infringed by their Contribution(s) alone or by combination +of their Contribution(s) with the Work to which such Contribution(s) was +submitted. If You institute patent litigation against any entity (including a +cross-claim or counterclaim in a lawsuit) alleging that the Work or a +Contribution incorporated within the Work constitutes direct or contributory +patent infringement, then any patent licenses granted to You under this License +for that Work shall terminate as of the date such litigation is filed. + +## 4. Redistribution. + +You may reproduce and distribute copies of the Work or Derivative Works thereof +in any medium, with or without modifications, and in Source or Object form, +provided that You meet the following conditions: + +1. You must give any other recipients of the Work or Derivative Works a copy of + this License; and + +2. You must cause any modified files to carry prominent notices stating that + You changed the files; and + +3. You must retain, in the Source form of any Derivative Works that You + distribute, all copyright, patent, trademark, and attribution notices from + the Source form of the Work, excluding those notices that do not pertain to + any part of the Derivative Works; and + +4. If the Work includes a "NOTICE" text file as part of its distribution, then + any Derivative Works that You distribute must include a readable copy of the + attribution notices contained within such NOTICE file, excluding those + notices that do not pertain to any part of the Derivative Works, in at least + one of the following places: within a NOTICE text file distributed as part + of the Derivative Works; within the Source form or documentation, if + provided along with the Derivative Works; or, within a display generated by + the Derivative Works, if and wherever such third-party notices normally + appear. The contents of the NOTICE file are for informational purposes only + and do not modify the License. You may add Your own attribution notices + within Derivative Works that You distribute, alongside or as an addendum to + the NOTICE text from the Work, provided that such additional attribution + notices cannot be construed as modifying the License. + +You may add Your own copyright statement to Your modifications and may provide +additional or different license terms and conditions for use, reproduction, or +distribution of Your modifications, or for any such Derivative Works as a whole, +provided Your use, reproduction, and distribution of the Work otherwise complies +with the conditions stated in this License. + +## 5. Submission of Contributions. + +Unless You explicitly state otherwise, any Contribution intentionally submitted +for inclusion in the Work by You to the Licensor shall be under the terms and +conditions of this License, without any additional terms or conditions. +Notwithstanding the above, nothing herein shall supersede or modify the terms of +any separate license agreement you may have executed with Licensor regarding +such Contributions. + +## 6. Trademarks. + +This License does not grant permission to use the trade names, trademarks, +service marks, or product names of the Licensor, except as required for +reasonable and customary use in describing the origin of the Work and +reproducing the content of the NOTICE file. + +## 7. Disclaimer of Warranty. + +Unless required by applicable law or agreed to in writing, Licensor provides the +Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, +including, without limitation, any warranties or conditions of TITLE, NON- +INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are +solely responsible for determining the appropriateness of using or +redistributing the Work and assume any risks associated with Your exercise of +permissions under this License. + +## 8. Limitation of Liability. + +In no event and under no legal theory, whether in tort (including negligence), +contract, or otherwise, unless required by applicable law (such as deliberate +and grossly negligent acts) or agreed to in writing, shall any Contributor be +liable to You for damages, including any direct, indirect, special, incidental, +or consequential damages of any character arising as a result of this License or +out of the use or inability to use the Work (including but not limited to +damages for loss of goodwill, work stoppage, computer failure or malfunction, or +any and all other commercial damages or losses), even if such Contributor has +been advised of the possibility of such damages. + +## 9. Accepting Warranty or Additional Liability. + +While redistributing the Work or Derivative Works thereof, You may choose to +offer, and charge a fee for, acceptance of support, warranty, indemnity, or +other liability obligations and/or rights consistent with this License. However, +in accepting such obligations, You may act only on Your own behalf and on Your +sole responsibility, not on behalf of any other Contributor, and only if You +agree to indemnify, defend, and hold each Contributor harmless for any liability +incurred by, or claims asserted against, such Contributor by reason of your +accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +Copyright 2026, anlicheng <244108715@qq.com>. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + +http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..4f0447b --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +relay_server +===== + +An OTP application with an esockd-based UDP server. + +Build +----- + + $ rebar3 compile + +Run +--- + + $ rebar3 shell + +The UDP listener is configured in `config/sys.config` and listens on port `7000` +by default. It echoes received datagrams. + +Test +---- + + $ echo "ping" | nc -u -w1 127.0.0.1 7000 diff --git a/apps/relay_server/src/relay_server.app.src b/apps/relay_server/src/relay_server.app.src new file mode 100644 index 0000000..a30f2dd --- /dev/null +++ b/apps/relay_server/src/relay_server.app.src @@ -0,0 +1,19 @@ +{application, relay_server, [ + {description, "An OTP application"}, + {vsn, "0.1.0"}, + {registered, [ + relay_server_sup, + relay_server_udp_listener + ]}, + {mod, {relay_server_app, []}}, + {applications, [ + kernel, + stdlib, + esockd, + sync + ]}, + {env, []}, + {modules, []}, + {licenses, ["Apache-2.0"]}, + {links, []} + ]}. diff --git a/apps/relay_server/src/relay_server_app.erl b/apps/relay_server/src/relay_server_app.erl new file mode 100644 index 0000000..d94f568 --- /dev/null +++ b/apps/relay_server/src/relay_server_app.erl @@ -0,0 +1,18 @@ +%%%------------------------------------------------------------------- +%% @doc relay_server public API +%% @end +%%%------------------------------------------------------------------- + +-module(relay_server_app). + +-behaviour(application). + +-export([start/2, stop/1]). + +start(_StartType, _StartArgs) -> + relay_server_sup:start_link(). + +stop(_State) -> + ok. + +%% internal functions diff --git a/apps/relay_server/src/relay_server_sup.erl b/apps/relay_server/src/relay_server_sup.erl new file mode 100644 index 0000000..155c2a4 --- /dev/null +++ b/apps/relay_server/src/relay_server_sup.erl @@ -0,0 +1,46 @@ +%%%------------------------------------------------------------------- +%% @doc relay_server top level supervisor. +%% @end +%%%------------------------------------------------------------------- + +-module(relay_server_sup). + +-behaviour(supervisor). + +-export([start_link/0]). + +-export([init/1]). + +-define(SERVER, ?MODULE). + +start_link() -> + supervisor:start_link({local, ?SERVER}, ?MODULE, []). + +%% sup_flags() = #{strategy => strategy(), % optional +%% intensity => non_neg_integer(), % optional +%% period => pos_integer()} % optional +%% child_spec() = #{id => child_id(), % mandatory +%% start => mfargs(), % mandatory +%% restart => restart(), % optional +%% shutdown => shutdown(), % optional +%% type => worker(), % optional +%% modules => modules()} % optional +init([]) -> + SupFlags = #{ + strategy => one_for_one, + intensity => 5, + period => 10 + }, + ChildSpecs = [ + #{ + id => relay_server_udp_listener, + start => {relay_server_udp_listener, start_link, []}, + restart => permanent, + shutdown => 5000, + type => worker, + modules => [relay_server_udp_listener] + } + ], + {ok, {SupFlags, ChildSpecs}}. + +%% internal functions diff --git a/apps/relay_server/src/relay_server_udp_handler.erl b/apps/relay_server/src/relay_server_udp_handler.erl new file mode 100644 index 0000000..bb32513 --- /dev/null +++ b/apps/relay_server/src/relay_server_udp_handler.erl @@ -0,0 +1,32 @@ +%%%------------------------------------------------------------------- +%% @doc Per-peer UDP packet handler. +%% @end +%%%------------------------------------------------------------------- + +-module(relay_server_udp_handler). + +-export([start_link/3, init/3, loop/3, handle_packet/2]). + +start_link(Transport, Peer, IdleTimeout) -> + {ok, spawn_link(?MODULE, init, [Transport, Peer, IdleTimeout])}. + +init(Transport, Peer, IdleTimeout) -> + logger:debug("UDP peer connected: ~s", [esockd:format(Peer)]), + loop(Transport, Peer, IdleTimeout). + +loop(Transport = {udp, Server, _Sock}, Peer, IdleTimeout) -> + receive + {datagram, Server, <<"stop">>} -> + logger:debug("UDP peer stopped: ~s", [esockd:format(Peer)]), + exit(normal); + {datagram, Server, Packet} -> + Reply = handle_packet(Peer, Packet), + Server ! {datagram, Peer, Reply}, + loop(Transport, Peer, IdleTimeout) + after IdleTimeout -> + logger:debug("UDP peer idle timeout: ~s", [esockd:format(Peer)]), + exit(normal) + end. + +handle_packet(_Peer, Packet) -> + Packet. diff --git a/apps/relay_server/src/relay_server_udp_listener.erl b/apps/relay_server/src/relay_server_udp_listener.erl new file mode 100644 index 0000000..2b62a1a --- /dev/null +++ b/apps/relay_server/src/relay_server_udp_listener.erl @@ -0,0 +1,97 @@ +%%%------------------------------------------------------------------- +%% @doc UDP listener lifecycle management. +%% @end +%%%------------------------------------------------------------------- + +-module(relay_server_udp_listener). + +-behaviour(gen_server). + +-export([start_link/0, status/0]). + +-export([init/1, handle_call/3, handle_cast/2, handle_info/2, terminate/2, code_change/3]). + +-define(SERVER, ?MODULE). +-define(DEFAULT_LISTENER, 'relay_server/udp'). +-define(DEFAULT_LISTEN_ON, 7000). +-define(DEFAULT_IDLE_TIMEOUT, 30000). +-define(DEFAULT_MAX_CONNECTIONS, 1024). +-define(DEFAULT_UDP_OPTIONS, [binary, {reuseaddr, true}]). + +-record(state, { + listener :: atom(), + listen_on :: esockd:listen_on(), + listener_pid :: pid() +}). + +start_link() -> + gen_server:start_link({local, ?SERVER}, ?MODULE, [], []). + +status() -> + gen_server:call(?SERVER, status). + +init([]) -> + Props = application:get_env(relay_server, udp_server, []), + + Listener = proplists:get_value(listener, Props, ?DEFAULT_LISTENER), + ListenOn = proplists:get_value(port, Props, ?DEFAULT_LISTEN_ON), + + IdleTimeout = proplists:get_value(idle_timeout, Props, ?DEFAULT_IDLE_TIMEOUT), + UdpOptions = proplists:get_value(udp_options, Props, ?DEFAULT_UDP_OPTIONS), + MaxConnections = proplists:get_value(max_connections, Props, ?DEFAULT_MAX_CONNECTIONS), + AccessRules = proplists:get_value(access_rules, Props, [{allow, all}]), + + BaseOpts = [ + {udp_options, UdpOptions}, + {max_connections, MaxConnections}, + {access_rules, AccessRules} + ], + Opts = maybe_add(max_conn_rate, Props, BaseOpts), + + MFA = {relay_server_udp_handler, start_link, [IdleTimeout]}, + case esockd:open_udp(Listener, ListenOn, Opts, MFA) of + {ok, Pid} -> + logger:info("UDP listener ~p started on ~s", + [Listener, esockd:to_string(ListenOn)]), + {ok, #state{ + listener = Listener, + listen_on = ListenOn, + listener_pid = Pid + }}; + {error, {already_started, Pid}} -> + logger:warning("UDP listener ~p already started on ~s", + [Listener, esockd:to_string(ListenOn)]), + {ok, #state{ + listener = Listener, + listen_on = ListenOn, + listener_pid = Pid + }}; + {error, Reason} -> + logger:error("Failed to start UDP listener ~p on ~s: ~p", + [Listener, esockd:to_string(ListenOn), Reason]), + {stop, Reason} + end. + +handle_call(status, _From, State = #state{listener_pid = Pid}) -> + {reply, {ok, Pid}, State}; +handle_call(_Request, _From, State) -> + {reply, {error, bad_request}, State}. + +handle_cast(_Request, State) -> + {noreply, State}. + +handle_info(_Info, State) -> + {noreply, State}. + +terminate(_Reason, #state{listener = Listener, listen_on = ListenOn}) -> + _ = esockd:close(Listener, ListenOn), + ok. + +code_change(_OldVsn, State, _Extra) -> + {ok, State}. + +maybe_add(Key, Props, Opts) -> + case proplists:get_value(Key, Props) of + undefined -> Opts; + Value -> [{Key, Value} | Opts] + end. \ No newline at end of file diff --git a/config/sys.config b/config/sys.config new file mode 100644 index 0000000..048d9b8 --- /dev/null +++ b/config/sys.config @@ -0,0 +1,40 @@ +[ + {relay_server, [ + {udp_server, [ + {enabled, true}, + {listener, 'relay_server/udp'}, + {port, 7000}, + {idle_timeout, 30000}, + {max_connections, 1024}, + {udp_options, [binary, {reuseaddr, true}]} + ]} + ]}, + + %% 系统日志配置，使用 OTP logger + {kernel, [ + %% 设置 Logger 的 primary log level + {logger_level, debug}, + {logger, [ + {handler, default, logger_std_h, + #{ + level => debug, + formatter => {logger_formatter, #{template => [time, " [", level, "] ", msg, "\n"]}} + } + }, + + {handler, disk, logger_disk_log_h, + #{ + level => debug, + config => #{ + file => "log/debug.log", + max_no_files => 10, + max_no_bytes => 524288000 + }, + formatter => {logger_formatter, #{template => [time, " [", level, "] ", msg, "\n"]}} + } + } + + ]} + ]} + +]. \ No newline at end of file diff --git a/config/vm.args b/config/vm.args new file mode 100644 index 0000000..2521708 --- /dev/null +++ b/config/vm.args @@ -0,0 +1,6 @@ +-sname relay_server + +-setcookie relay_server_cookie + ++K true ++A30 diff --git a/rebar.config b/rebar.config new file mode 100644 index 0000000..7ce4137 --- /dev/null +++ b/rebar.config @@ -0,0 +1,40 @@ +{erl_opts, [debug_info]}. +{deps, [ + {esockd, {git, "https://github.com/emqx/esockd", {tag, "5.17.0"}}}, + {sync, ".*", {git, "https://github.com/rustyio/sync.git", {branch, "master"}}} +]}. + +{relx, [ + {release, {relay_server, "0.1.0"}, [ + relay_server, + sasl + ]}, + + {mode, dev}, + + %% automatically picked up if the files + %% exist but can be set manually, which + %% is required if the names aren't exactly + %% sys.config and vm.args + {sys_config, "./config/sys.config"}, + {vm_args, "./config/vm.args"} + + %% the .src form of the configuration files do + %% not require setting RELX_REPLACE_OS_VARS + %% {sys_config_src, "./config/sys.config.src"}, + %% {vm_args_src, "./config/vm.args.src"} +]}. + +{profiles, [ + %% prod is the default mode when prod + %% profile is used, so does not have + %% to be explicitly included like this + {prod, [ + {relx, [ + {mode, prod} + + %% use minimal mode to exclude ERTS + %% {mode, minimal} + ]} + ]} +]}. diff --git a/rebar.lock b/rebar.lock new file mode 100644 index 0000000..3208a59 --- /dev/null +++ b/rebar.lock @@ -0,0 +1,16 @@ +{"1.2.0", +[{<<"esockd">>, + {git,"https://github.com/emqx/esockd", + {ref,"13e15271aed0ac402aeb49b43785e9fffa226bff"}}, + 0}, + {<<"fs">>,{pkg,<<"fs">>,<<"6.1.1">>},1}, + {<<"sync">>, + {git,"https://github.com/rustyio/sync.git", + {ref,"4e909f69d3d0db21a6d7128b20748819e415c9eb"}}, + 0}]}. +[ +{pkg_hash,[ + {<<"fs">>, <<"9D147B944D60CFA48A349F12D06C8EE71128F610C90870BDF9A6773206452ED0">>}]}, +{pkg_hash_ext,[ + {<<"fs">>, <<"EF94E95FFE79916860649FED80AC62B04C322B0BB70F5128144C026B4D171F8B">>}]} +].