Module director_table_mnesia

API functions for interacting with Mnesia table as backend children table.

Version: 18.2.20

Behaviours: director_table.

Authors: Pouriya Jahanbakhsh (pouriya.jahanbakhsh@gmail.com).

Description

API functions for interacting with Mnesia table as backend children table.

Function Index

count_children/1 Returns count of children.
get_childspec/2 Returns childspec of child id or child pid.
get_pid/2 Returns pid of child id if child is running.
get_pids/1 Returns list of {id, pid}s for all running children.
get_restart_count/2 Returns restart count of child id.
options/0 Returns mandatory options of Mnesia table for creating table for a director process.
which_children/1 Returns information about each child.

Function Details

count_children/1

count_children(Tab::atom()) -> [{specs, non_neg_integer()} | {active, non_neg_integer()} | {supervisors, non_neg_integer()} | {workers, non_neg_integer()}] | {error, term()}

Returns count of children.
Error is for reading from table.

get_childspec/2

get_childspec(Tab::atom(), Id::director:id() | pid()) -> {ok, director:childspec()} | {error, not_found | term()}

Returns childspec of child id or child pid.
Error maybe occur for reading from table.

get_pid/2

get_pid(Tab::atom(), Id::director:id()) -> {ok, pid()} | {error, not_found | restarting | undefined | term()}

Returns pid of child id if child is running.
Error maybe occur for reading from table.

get_pids/1

get_pids(Tab::atom()) -> {ok, [{director:id(), pid()}] | []} | {error, term()}

Returns list of {id, pid}s for all running children.
Error is for reading from table.

get_restart_count/2

get_restart_count(Tab::atom(), Id::director:id()) -> {ok, non_neg_integer()} | {error, not_found | term()}

Returns restart count of child id.
Error maybe occur for reading from table.

options/0

options() -> list()

Returns mandatory options of Mnesia table for creating table for a director process.

which_children/1

which_children(Tab::atom()) -> [{director:id(), director:type(), pid() | restarting | undefined, director:modules()}] | [] | {error, term()}

Returns information about each child.
Error maybe occur for reading from table.


Generated by EDoc