Module ejabberd_config [erl svg]

Data Types

macro()

macro() = {macro_key(), macro_value()}

macro_key()

macro_key() = atom()

The atom must have all characters in uppercase.

macro_value()

macro_value() = term()

Function Index

add_global_option/2
add_hosts_to_option/2*
add_local_option/2
add_option/3*
compact/4*
configure_host/2
del_global_option/1
del_local_option/1
delete_disallowed/2*Filter from the list of terms the disallowed.
delete_disallowed2/2*
delete_host/1
describe_config_problem/2*
describe_config_problem/3*
ensure_localhost_is_first/1*Return the list where the first is surely "localhost".
ensure_localhost_is_first1/1*
exit_or_halt/1*
for_host/1
get_absolute_path/1*Convert configuration filename to absolute path.
get_config_lines/4*
get_config_lines2/5*
get_ejabberd_config_path/0*Get the filename of the ejabberd configuration file.
get_global_option/1
get_host_option/2
get_local_option/1
get_plain_terms_file/1*Read an ejabberd configuration file and return the terms.
get_vh_by_auth_method/1
host_term_to_record/3*
host_terms_to_records/2*
include_config_files/1*Include additional configuration files in the list of terms.
include_config_files/2*
is_all_uppercase/1*
is_file_readable/1
keep_only_allowed/2*Keep from the list only the allowed terms.
load_file/1Load the ejabberd configuration file.
mne_add_local_option/2
mne_del_local_option/1
mnesia_delete_objects/1*
mnesia_write_objects/1*
normalize_hosts/1*
normalize_hosts/2*
process_host_term/3*
process_term/2*
replace/2*Recursively replace in Terms macro usages with the defined value.
replace_macros/1*Replace the macros with their defined values.
replace_storage_auth/2*
replace_storage_auth/4*
replace_term/2*
search/1
search_hosts/2*
set_opts/1*
split_terms_macros/1*Split Terms into normal terms and macro definitions.
start/0

Function Details

add_global_option/2

add_global_option(Opt, Val) -> any()

add_hosts_to_option/2 *

add_hosts_to_option(Hosts, State) -> any()

add_local_option/2

add_local_option(Opt, Val) -> any()

add_option/3 *

add_option(Opt, Val, State) -> any()

compact/4 *

compact(Opt, Val, Os1, Os) -> any()

configure_host/2

configure_host(Host, Config) -> any()

del_global_option/1

del_global_option(Opt) -> any()

del_local_option/1

del_local_option(Opt) -> any()

delete_disallowed/2 *

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/2 *

delete_disallowed2(Disallowed, T) -> any()

delete_host/1

delete_host(Host) -> any()

describe_config_problem/2 *

describe_config_problem(Filename, Reason) -> any()

describe_config_problem/3 *

describe_config_problem(Filename, Reason, LineNumber) -> any()

ensure_localhost_is_first/1 *

ensure_localhost_is_first(Hosts::[string()]) -> [Localhost::string() | [string()]]

Return the list where the first is surely "localhost".

ensure_localhost_is_first1/1 *

ensure_localhost_is_first1(Hosts) -> any()

exit_or_halt/1 *

exit_or_halt(ExitText) -> any()

for_host/1

for_host(Host) -> any()

get_absolute_path/1 *

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/4 *

get_config_lines(Filename, TargetNumber, PreContext, PostContext) -> any()

get_config_lines2/5 *

get_config_lines2(Fd, NewLine, CurrLine, LNumbers, R) -> any()

get_ejabberd_config_path/0 *

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/1

get_global_option(Opt) -> any()

get_host_option/2

get_host_option(Host, Option) -> any()

get_local_option/1

get_local_option(Opt) -> any()

get_plain_terms_file/1 *

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/1

get_vh_by_auth_method(AuthMethod) -> any()

host_term_to_record/3 *

host_term_to_record(X1, Host, Acc) -> any()

host_terms_to_records/2 *

host_terms_to_records(Host, Terms) -> any()

include_config_files/1 *

include_config_files(Terms::[term()]) -> [term()]

Include additional configuration files in the list of terms.

include_config_files/2 *

include_config_files(Terms, Res) -> any()

is_all_uppercase/1 *

is_all_uppercase(Atom) -> any()

is_file_readable/1

is_file_readable(Path::string()) -> true | false

keep_only_allowed/2 *

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/1

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/2

mne_add_local_option(Opt, Val) -> any()

mne_del_local_option/1

mne_del_local_option(Opt) -> any()

mnesia_delete_objects/1 *

mnesia_delete_objects(List) -> any()

mnesia_write_objects/1 *

mnesia_write_objects(List) -> any()

normalize_hosts/1 *

normalize_hosts(Hosts) -> any()

normalize_hosts/2 *

normalize_hosts(Hosts, PrepHosts) -> any()

process_host_term/3 *

process_host_term(Term, Host, State) -> any()

process_term/2 *

process_term(Term, State) -> any()

replace/2 *

replace(Terms, Macros) -> Terms

Recursively replace in Terms macro usages with the defined value.

replace_macros/1 *

replace_macros(Terms::[term()]) -> [term()]

Replace the macros with their defined values.

replace_storage_auth/2 *

replace_storage_auth(Host, Val) -> any()

replace_storage_auth/4 *

replace_storage_auth(Host, ValT, Val2, Storage) -> any()

replace_term/2 *

replace_term(Key, Macros) -> any()

search/1

search(Pattern) -> any()

search_hosts/2 *

search_hosts(Term, State) -> any()

set_opts/1 *

set_opts(State) -> any()

split_terms_macros/1 *

split_terms_macros(Terms) -> {Terms, Macros}

Split Terms into normal terms and macro definitions.

start/0

start() -> any()


Generated by EDoc, May 23 2012, 07:15:16.