macro() = {macro_key(), macro_value()}
macro_key() = atom()
The atom must have all characters in uppercase.
macro_value() = term()
add_global_option(Opt, Val) -> any()
add_hosts_to_option(Hosts, State) -> any()
add_local_option(Opt, Val) -> any()
add_option(Opt, Val, State) -> any()
compact(Opt, Val, Os1, Os) -> any()
configure_host(Host, Config) -> any()
del_global_option(Opt) -> any()
del_local_option(Opt) -> any()
delete_disallowed(Disallowed::[atom()], Terms::[term()]) -> [term()]
Filter from the list of terms the disallowed. Returns a sublist of Terms without the ones which first element is included in Disallowed.
delete_disallowed2(Disallowed, T) -> any()
delete_host(Host) -> any()
describe_config_problem(Filename, Reason) -> any()
describe_config_problem(Filename, Reason, LineNumber) -> any()
ensure_localhost_is_first(Hosts::[string()]) -> [Localhost::string() | [string()]]
Return the list where the first is surely "localhost".
ensure_localhost_is_first1(Hosts) -> any()
exit_or_halt(ExitText) -> any()
for_host(Host) -> any()
get_absolute_path(File::string()) -> string()
Convert configuration filename to absolute path. Input is an absolute or relative path to an ejabberd configuration file. And returns an absolute path to the configuration file.
get_config_lines(Filename, TargetNumber, PreContext, PostContext) -> any()
get_config_lines2(Fd, NewLine, CurrLine, LNumbers, R) -> any()
get_ejabberd_config_path() -> string()
Get the filename of the ejabberd configuration file. The filename can be specified with: erl -config "/path/to/ejabberd.cfg". It can also be specified with the environtment variable EJABBERD_CONFIG_PATH. If not specified, the default value 'ejabberd.cfg' is assumed.
get_global_option(Opt) -> any()
get_host_option(Host, Option) -> any()
get_local_option(Opt) -> any()
get_plain_terms_file(File1) -> any()
Read an ejabberd configuration file and return the terms. Input is an absolute or relative path to an ejabberd config file. Returns a list of plain terms, in which the options 'include_config_file' were parsed and the terms in those files were included.
get_vh_by_auth_method(AuthMethod) -> any()
host_term_to_record(X1, Host, Acc) -> any()
host_terms_to_records(Host, Terms) -> any()
include_config_files(Terms::[term()]) -> [term()]
Include additional configuration files in the list of terms.
include_config_files(Terms, Res) -> any()
is_all_uppercase(Atom) -> any()
is_file_readable(Path::string()) -> true | false
keep_only_allowed(Allowed::[atom()], Terms::[term()]) -> [term()]
Keep from the list only the allowed terms. Returns a sublist of Terms with only the ones which first element is included in Allowed.
load_file(File::string()) -> ok
Load the ejabberd configuration file. It also includes additional configuration files and replaces macros. This function will crash if finds some error in the configuration file.
mne_add_local_option(Opt, Val) -> any()
mne_del_local_option(Opt) -> any()
mnesia_delete_objects(List) -> any()
mnesia_write_objects(List) -> any()
normalize_hosts(Hosts) -> any()
normalize_hosts(Hosts, PrepHosts) -> any()
process_host_term(Term, Host, State) -> any()
process_term(Term, State) -> any()
replace(Terms, Macros) -> Terms
Recursively replace in Terms macro usages with the defined value.
replace_macros(Terms::[term()]) -> [term()]
Replace the macros with their defined values.
replace_storage_auth(Host, Val) -> any()
replace_storage_auth(Host, ValT, Val2, Storage) -> any()
replace_term(Key, Macros) -> any()
search(Pattern) -> any()
search_hosts(Term, State) -> any()
set_opts(State) -> any()
split_terms_macros(Terms) -> {Terms, Macros}
Split Terms into normal terms and macro definitions.
start() -> any()
Generated by EDoc, May 23 2012, 07:15:16.