Packages
gleam_erlang
0.22.0
1.3.0
1.2.0
1.1.0
1.0.0
1.0.0-rc1
0.34.0
0.33.0
0.32.0
0.31.0
0.30.0
0.29.0
0.28.0
0.27.0
0.26.0
0.25.0
0.24.0
0.23.1
0.23.0
0.22.0
0.21.0
0.20.0
0.19.0
0.18.1
0.18.0
0.18.0-rc1
retired
0.17.1
0.17.0
0.16.0
0.15.0
0.14.0
0.13.0
0.12.0
0.11.0
0.10.0
0.9.3
0.9.2
0.9.1
0.9.0
0.8.0
0.7.0
0.6.0
0.5.0
0.4.0
0.3.0
0.2.0
0.1.0
Types and functions for programs running on Erlang!
Current section
Files
Jump to
Current section
Files
src/gleam@erlang@process.erl
-module(gleam@erlang@process).
-compile([no_auto_import, nowarn_unused_vars]).
-export([self/0, start/2, new_subject/0, subject_owner/1, send/2, new_selector/0, select/2, select_forever/1, map_selector/2, merge_selector/2, flush_messages/0, selecting_trapped_exits/2, selecting/3, 'receive'/2, selecting_record2/3, selecting_record3/3, selecting_record4/3, selecting_record5/3, selecting_record6/3, selecting_record7/3, selecting_record8/3, selecting_anything/2, sleep/1, sleep_forever/0, is_alive/1, monitor_process/1, selecting_process_down/3, demonitor_process/1, try_call/3, call/3, link/1, unlink/1, send_after/3, cancel_timer/1, kill/1, send_exit/1, send_abnormal_exit/2, trap_exits/1, register/2, unregister/1, named/1]).
-export_type([pid_/0, subject/1, do_not_leak/0, selector/1, exit_message/0, exit_reason/0, anything_selector_tag/0, process_monitor_flag/0, process_monitor/0, process_down/0, call_error/1, timer/0, cancelled/0, kill_flag/0]).
-type pid_() :: any().
-opaque subject(FKU) :: {subject, pid_(), gleam@erlang:reference_()} |
{gleam_phantom, FKU}.
-type do_not_leak() :: any().
-type selector(FKV) :: any() | {gleam_phantom, FKV}.
-type exit_message() :: {exit_message, pid_(), exit_reason()}.
-type exit_reason() :: normal | killed | {abnormal, binary()}.
-type anything_selector_tag() :: anything.
-type process_monitor_flag() :: process.
-opaque process_monitor() :: {process_monitor, gleam@erlang:reference_()}.
-type process_down() :: {process_down, pid_(), gleam@dynamic:dynamic_()}.
-type call_error(FKW) :: {callee_down, gleam@dynamic:dynamic_()} |
call_timeout |
{gleam_phantom, FKW}.
-type timer() :: any().
-type cancelled() :: timer_not_found | {cancelled, integer()}.
-type kill_flag() :: kill.
-spec self() -> pid_().
self() ->
erlang:self().
-spec start(fun(() -> any()), boolean()) -> pid_().
start(Implementation, Link) ->
case Link of
true ->
erlang:spawn_link(Implementation);
false ->
erlang:spawn(Implementation)
end.
-spec new_subject() -> subject(any()).
new_subject() ->
{subject, erlang:self(), erlang:make_ref()}.
-spec subject_owner(subject(any())) -> pid_().
subject_owner(Subject) ->
erlang:element(2, Subject).
-spec send(subject(FLF), FLF) -> nil.
send(Subject, Message) ->
erlang:send(
erlang:element(2, Subject),
{erlang:element(3, Subject), Message}
),
nil.
-spec new_selector() -> selector(any()).
new_selector() ->
gleam_erlang_ffi:new_selector().
-spec select(selector(FLN), integer()) -> {ok, FLN} | {error, nil}.
select(From, Within) ->
gleam_erlang_ffi:select(From, Within).
-spec select_forever(selector(FLR)) -> FLR.
select_forever(From) ->
gleam_erlang_ffi:select(From).
-spec map_selector(selector(FLT), fun((FLT) -> FLV)) -> selector(FLV).
map_selector(A, B) ->
gleam_erlang_ffi:map_selector(A, B).
-spec merge_selector(selector(FLX), selector(FLX)) -> selector(FLX).
merge_selector(A, B) ->
gleam_erlang_ffi:merge_selector(A, B).
-spec flush_messages() -> nil.
flush_messages() ->
gleam_erlang_ffi:flush_messages().
-spec selecting_trapped_exits(selector(FMB), fun((exit_message()) -> FMB)) -> selector(FMB).
selecting_trapped_exits(Selector, Handler) ->
Tag = erlang:binary_to_atom(<<"EXIT"/utf8>>),
Handler@1 = fun(Message) ->
Reason = erlang:element(3, Message),
Normal = gleam@dynamic:from(normal),
Killed = gleam@dynamic:from(killed),
Reason@2 = case gleam@dynamic:string(Reason) of
_ when Reason =:= Normal ->
normal;
_ when Reason =:= Killed ->
killed;
{ok, Reason@1} ->
{abnormal, Reason@1};
{error, _} ->
{abnormal, gleam@string:inspect(Reason)}
end,
Handler({exit_message, erlang:element(2, Message), Reason@2})
end,
gleam_erlang_ffi:insert_selector_handler(Selector, {Tag, 3}, Handler@1).
-spec selecting(selector(FME), subject(FMG), fun((FMG) -> FME)) -> selector(FME).
selecting(Selector, Subject, Transform) ->
Handler = fun(Message) -> Transform(erlang:element(2, Message)) end,
gleam_erlang_ffi:insert_selector_handler(
Selector,
{erlang:element(3, Subject), 2},
Handler
).
-spec 'receive'(subject(FLH), integer()) -> {ok, FLH} | {error, nil}.
'receive'(Subject, Milliseconds) ->
_pipe = gleam_erlang_ffi:new_selector(),
_pipe@1 = selecting(_pipe, Subject, fun(X) -> X end),
gleam_erlang_ffi:select(_pipe@1, Milliseconds).
-spec selecting_record2(
selector(FMJ),
any(),
fun((gleam@dynamic:dynamic_()) -> FMJ)
) -> selector(FMJ).
selecting_record2(Selector, Tag, Transform) ->
Handler = fun(Message) -> Transform(erlang:element(2, Message)) end,
gleam_erlang_ffi:insert_selector_handler(Selector, {Tag, 2}, Handler).
-spec selecting_record3(
selector(FMN),
any(),
fun((gleam@dynamic:dynamic_(), gleam@dynamic:dynamic_()) -> FMN)
) -> selector(FMN).
selecting_record3(Selector, Tag, Transform) ->
Handler = fun(Message) ->
Transform(erlang:element(2, Message), erlang:element(3, Message))
end,
gleam_erlang_ffi:insert_selector_handler(Selector, {Tag, 3}, Handler).
-spec selecting_record4(
selector(FMR),
any(),
fun((gleam@dynamic:dynamic_(), gleam@dynamic:dynamic_(), gleam@dynamic:dynamic_()) -> FMR)
) -> selector(FMR).
selecting_record4(Selector, Tag, Transform) ->
Handler = fun(Message) ->
Transform(
erlang:element(2, Message),
erlang:element(3, Message),
erlang:element(4, Message)
)
end,
gleam_erlang_ffi:insert_selector_handler(Selector, {Tag, 4}, Handler).
-spec selecting_record5(
selector(FMV),
any(),
fun((gleam@dynamic:dynamic_(), gleam@dynamic:dynamic_(), gleam@dynamic:dynamic_(), gleam@dynamic:dynamic_()) -> FMV)
) -> selector(FMV).
selecting_record5(Selector, Tag, Transform) ->
Handler = fun(Message) ->
Transform(
erlang:element(2, Message),
erlang:element(3, Message),
erlang:element(4, Message),
erlang:element(5, Message)
)
end,
gleam_erlang_ffi:insert_selector_handler(Selector, {Tag, 5}, Handler).
-spec selecting_record6(
selector(FMZ),
any(),
fun((gleam@dynamic:dynamic_(), gleam@dynamic:dynamic_(), gleam@dynamic:dynamic_(), gleam@dynamic:dynamic_(), gleam@dynamic:dynamic_()) -> FMZ)
) -> selector(FMZ).
selecting_record6(Selector, Tag, Transform) ->
Handler = fun(Message) ->
Transform(
erlang:element(2, Message),
erlang:element(3, Message),
erlang:element(4, Message),
erlang:element(5, Message),
erlang:element(6, Message)
)
end,
gleam_erlang_ffi:insert_selector_handler(Selector, {Tag, 6}, Handler).
-spec selecting_record7(
selector(FND),
any(),
fun((gleam@dynamic:dynamic_(), gleam@dynamic:dynamic_(), gleam@dynamic:dynamic_(), gleam@dynamic:dynamic_(), gleam@dynamic:dynamic_(), gleam@dynamic:dynamic_()) -> FND)
) -> selector(FND).
selecting_record7(Selector, Tag, Transform) ->
Handler = fun(Message) ->
Transform(
erlang:element(2, Message),
erlang:element(3, Message),
erlang:element(4, Message),
erlang:element(5, Message),
erlang:element(6, Message),
erlang:element(7, Message)
)
end,
gleam_erlang_ffi:insert_selector_handler(Selector, {Tag, 7}, Handler).
-spec selecting_record8(
selector(FNH),
any(),
fun((gleam@dynamic:dynamic_(), gleam@dynamic:dynamic_(), gleam@dynamic:dynamic_(), gleam@dynamic:dynamic_(), gleam@dynamic:dynamic_(), gleam@dynamic:dynamic_(), gleam@dynamic:dynamic_()) -> FNH)
) -> selector(FNH).
selecting_record8(Selector, Tag, Transform) ->
Handler = fun(Message) ->
Transform(
erlang:element(2, Message),
erlang:element(3, Message),
erlang:element(4, Message),
erlang:element(5, Message),
erlang:element(6, Message),
erlang:element(7, Message),
erlang:element(8, Message)
)
end,
gleam_erlang_ffi:insert_selector_handler(Selector, {Tag, 8}, Handler).
-spec selecting_anything(selector(FNL), fun((gleam@dynamic:dynamic_()) -> FNL)) -> selector(FNL).
selecting_anything(Selector, Handler) ->
gleam_erlang_ffi:insert_selector_handler(Selector, anything, Handler).
-spec sleep(integer()) -> nil.
sleep(A) ->
gleam_erlang_ffi:sleep(A).
-spec sleep_forever() -> nil.
sleep_forever() ->
gleam_erlang_ffi:sleep_forever().
-spec is_alive(pid_()) -> boolean().
is_alive(A) ->
erlang:is_process_alive(A).
-spec monitor_process(pid_()) -> process_monitor().
monitor_process(Pid) ->
_pipe = process,
_pipe@1 = erlang:monitor(_pipe, Pid),
{process_monitor, _pipe@1}.
-spec selecting_process_down(
selector(FNT),
process_monitor(),
fun((process_down()) -> FNT)
) -> selector(FNT).
selecting_process_down(Selector, Monitor, Mapping) ->
gleam_erlang_ffi:insert_selector_handler(
Selector,
erlang:element(2, Monitor),
Mapping
).
-spec demonitor_process(process_monitor()) -> nil.
demonitor_process(Monitor) ->
gleam_erlang_ffi:demonitor(Monitor).
-spec try_call(subject(FNW), fun((subject(FNY)) -> FNW), integer()) -> {ok, FNY} |
{error, call_error(FNY)}.
try_call(Subject, Make_request, Timeout) ->
Reply_subject = new_subject(),
Monitor = monitor_process(subject_owner(Subject)),
send(Subject, Make_request(Reply_subject)),
Result = begin
_pipe = gleam_erlang_ffi:new_selector(),
_pipe@1 = selecting(
_pipe,
Reply_subject,
fun(Field@0) -> {ok, Field@0} end
),
_pipe@2 = selecting_process_down(
_pipe@1,
Monitor,
fun(Down) -> {error, {callee_down, erlang:element(3, Down)}} end
),
gleam_erlang_ffi:select(_pipe@2, Timeout)
end,
gleam_erlang_ffi:demonitor(Monitor),
case Result of
{error, nil} ->
{error, call_timeout};
{ok, Res} ->
Res
end.
-spec call(subject(FOD), fun((subject(FOF)) -> FOD), integer()) -> FOF.
call(Subject, Make_request, Timeout) ->
_assert_subject = try_call(Subject, Make_request, Timeout),
{ok, Resp} = case _assert_subject of
{ok, _} -> _assert_subject;
_assert_fail ->
erlang:error(#{gleam_error => let_assert,
message => <<"Assertion pattern match failed"/utf8>>,
value => _assert_fail,
module => <<"gleam/erlang/process"/utf8>>,
function => <<"call"/utf8>>,
line => 593})
end,
Resp.
-spec link(pid_()) -> boolean().
link(Pid) ->
gleam_erlang_ffi:link(Pid).
-spec unlink(pid_()) -> nil.
unlink(Pid) ->
erlang:unlink(Pid),
nil.
-spec send_after(subject(FOI), integer(), FOI) -> timer().
send_after(Subject, Delay, Message) ->
erlang:send_after(
Delay,
erlang:element(2, Subject),
{erlang:element(3, Subject), Message}
).
-spec cancel_timer(timer()) -> cancelled().
cancel_timer(Timer) ->
case gleam@dynamic:int(erlang:cancel_timer(Timer)) of
{ok, I} ->
{cancelled, I};
{error, _} ->
timer_not_found
end.
-spec kill(pid_()) -> nil.
kill(Pid) ->
erlang:exit(Pid, kill),
nil.
-spec send_exit(pid_()) -> nil.
send_exit(Pid) ->
erlang:exit(Pid, normal),
nil.
-spec send_abnormal_exit(pid_(), binary()) -> nil.
send_abnormal_exit(Pid, Reason) ->
erlang:exit(Pid, {abnormal, Reason}),
nil.
-spec trap_exits(boolean()) -> nil.
trap_exits(A) ->
gleam_erlang_ffi:trap_exits(A).
-spec register(pid_(), gleam@erlang@atom:atom_()) -> {ok, nil} | {error, nil}.
register(Pid, Name) ->
gleam_erlang_ffi:register_process(Pid, Name).
-spec unregister(gleam@erlang@atom:atom_()) -> {ok, nil} | {error, nil}.
unregister(Name) ->
gleam_erlang_ffi:unregister_process(Name).
-spec named(gleam@erlang@atom:atom_()) -> {ok, pid_()} | {error, nil}.
named(Name) ->
gleam_erlang_ffi:process_named(Name).