eturnal_ctl (eturnal v1.12.2+1)

View Source

Summary

Types

addr/0

-type addr() :: inet:ip_address().

addr_port/0

-type addr_port() :: {inet:ip_address(), inet:port_number()}.

eturnal_node_info/0

-type eturnal_node_info() ::
          #eturnal_node_info{eturnal_vsn :: binary(),
                             otp_vsn :: {string(), string()},
                             uptime :: non_neg_integer(),
                             num_sessions :: non_neg_integer(),
                             num_processes :: non_neg_integer(),
                             num_reductions :: non_neg_integer(),
                             total_queue_len :: non_neg_integer(),
                             total_memory :: non_neg_integer()}.

session/0

-type session() ::
          #session{pid :: pid(),
                   sid :: binary(),
                   user :: binary(),
                   sock_mod :: sock_mod(),
                   client_addr :: addr_port(),
                   relay_addr :: addr_port(),
                   perm_addrs :: [addr()],
                   peer_addrs :: [addr_port()],
                   sent_bytes :: non_neg_integer(),
                   sent_pkts :: non_neg_integer(),
                   rcvd_bytes :: non_neg_integer(),
                   rcvd_pkts :: non_neg_integer(),
                   start_time :: integer()}.

sock_mod/0

-type sock_mod() :: gen_udp | gen_tcp | fast_tls.

Functions

disconnect(Username0)

-spec disconnect(term()) -> {ok, string()} | {error, string()}.

get_credentials(Expiry, Suffix)

-spec get_credentials(term(), term()) -> {ok, string()} | {error, string()}.

get_info()

-spec get_info() -> {ok, string()} | {error, string()}.

get_loglevel()

-spec get_loglevel() -> {ok, string()} | {error, string()}.

get_password(Username0)

-spec get_password(term()) -> {ok, string()} | {error, string()}.

get_sessions()

-spec get_sessions() -> {ok, string()} | {error, string()}.

get_sessions(Username0)

-spec get_sessions(term()) -> {ok, string()} | {error, string()}.

get_status()

-spec get_status() -> {ok, string()} | {error, string()}.

get_version()

-spec get_version() -> {ok, string()} | {error, string()}.

reload()

-spec reload() -> ok | {error, string()}.

set_loglevel(Level)

-spec set_loglevel(term()) -> ok | {error, string()}.