ecrn_reg (erlcron v1.3.8)

Job registry that maps job references to their agent PIDs.

ecrn_reg maintains a bidirectional mapping between erlcron:job_ref/0 values and the pid/0 of the corresponding ecrn_agent process. It is used by ecrn_control:cancel/1 and erlcron:get_all_jobs/0.

Summary

Functions

Cancel the job registered under Key by sending a shutdown to its process.

Look up the PID registered under Key. Returns undefined if not found.

Return all {Ref, Pid} pairs currently registered.

Return the PIDs of all registered job agents.

Return all registered job references.

Return all job references registered under the given Pid.

Register a job's PID under the given reference key.

Remove the registration for the given reference key.

Functions

cancel(Key)

-spec cancel(term()) -> boolean().

Cancel the job registered under Key by sending a shutdown to its process.

code_change(OldVsn, State, Extra)

get(Key)

-spec get(erlcron:job_ref()) -> pid() | undefined.

Look up the PID registered under Key. Returns undefined if not found.

get_all()

-spec get_all() -> [{term(), term()}].

Return all {Ref, Pid} pairs currently registered.

get_all_pids()

-spec get_all_pids() -> [pid()].

Return the PIDs of all registered job agents.

get_all_refs()

-spec get_all_refs() -> [erlcron:job_ref()].

Return all registered job references.

get_refs(Pid)

-spec get_refs(pid()) -> [erlcron:job_ref()].

Return all job references registered under the given Pid.

handle_call/3

handle_cast/2

handle_info/2

init/1

register(Key, Pid)

-spec register(erlcron:job_ref(), term()) -> boolean().

Register a job's PID under the given reference key.

start_link()

-spec start_link() -> {ok, Pid :: pid()} | ignore | {error, Error :: term()}.

terminate(Reason, State)

unregister(Key)

-spec unregister(erlcron:job_ref()) -> ok.

Remove the registration for the given reference key.