Module cluster_info

Behaviours: application.

Data Types

dump_option()

dump_option() = {modules, [atom()]}

dump_return()

dump_return() = ok | error

filename()

filename() = string()

lnlimit()

lnlimit() = undefined | pos_integer()

lnlimits()

lnlimits() = {lnlimit(), lnlimit()}

Function Index

capture_io/2This is an untidy hack.
config_change/3
dump_all_connected/1Dump the cluster_info on all connected nodes to the specified File.
dump_all_connected/2
dump_local_node/1Dump the cluster_info on local node to the specified File.
dump_local_node/2
dump_node/2Dump the cluster_info on Node to the specified local File.
dump_node/3
dump_nodes/2Dump the cluster_info on all specified nodes to the specified File.
dump_nodes/3
format/2
format/3
format_noescape/2
format_noescape/3
get_limits/0
list_reports/0
list_reports/1
prep_stop/1
register_app/1"Register" an application with the cluster_info app.
reset_limits/0
send/2
start/0
start/2
start_phase/3
stop/1

Function Details

capture_io/2

capture_io(Timeout::integer(), Fun::function()) -> [term()]

This is an untidy hack.

config_change/3

config_change(Changed::term(), New::term(), Removed::term()) -> ok

dump_all_connected/1

dump_all_connected(Path::filename()) -> [dump_return()]

Dump the cluster_info on all connected nodes to the specified File.

dump_all_connected/2

dump_all_connected(Path, Opts) -> any()

dump_local_node/1

dump_local_node(Path::filename()) -> [dump_return()]

Dump the cluster_info on local node to the specified File.

dump_local_node/2

dump_local_node(Path, Opts) -> any()

dump_node/2

dump_node(Node::atom(), Path::filename()) -> dump_return()

Dump the cluster_info on Node to the specified local File.

dump_node/3

dump_node(Node::atom(), Path::string(), Opts::[dump_option()]) -> dump_return()

dump_nodes/2

dump_nodes(Nodes::[atom()], Path::filename()) -> [dump_return()]

Dump the cluster_info on all specified nodes to the specified File.

dump_nodes/3

dump_nodes(Nodes0, Path, Opts) -> any()

format/2

format(Pid, Fmt) -> any()

format/3

format(Pid, Fmt, Args) -> any()

format_noescape/2

format_noescape(Pid, Fmt) -> any()

format_noescape/3

format_noescape(Pid, Fmt, Args) -> any()

get_limits/0

get_limits() -> lnlimits()

list_reports/0

list_reports() -> any()

list_reports/1

list_reports(Mod) -> any()

prep_stop/1

prep_stop(State::term()) -> any()

register_app/1

register_app(CallbackMod::atom()) -> ok | undef

"Register" an application with the cluster_info app.

"Registration" is a misnomer: we're really interested only in having the code server load the callback module, and it's that side-effect with the code server that we rely on later.

reset_limits/0

reset_limits() -> any()

send/2

send(Pid, IoData) -> any()

start/0

start() -> {ok, pid()}

start/2

start(Type::term(), StartArgs::term()) -> {ok, pid()}

start_phase/3

start_phase(Phase::term(), StartType::term(), PhaseArgs::term()) -> ok

stop/1

stop(State::term()) -> ok


Generated by EDoc