Module locus

Data Types

database_entry()

database_entry() = #{prefix => ip_address_prefix(), binary() => term()}

database_error()

database_error() = database_unknown | database_not_loaded

database_info()

database_info() = #{metadata => database_metadata(), source => database_source(), version => database_version()}

database_metadata()

database_metadata() = #{binary() => term()}

database_source()

database_source() = {cache, string()} | {remote, string()} | {filesystem, string()}

database_version()

database_version() = calendar:datetime()

ip_address_prefix()

ip_address_prefix() = {inet:ip4_address(), 0..32} | {inet:ip6_address(), 0..128}

Function Index

get_info/1Returns the properties of a currently loaded database.
get_info/2Returns a specific property of a currently loaded database.
get_version/1(Deprecated.) Returns the currently loaded database version.
lookup/2Looks-up info on IPv4 and IPv6 addresses.
start_loader/2Like :start_loader/3 but with default options.
start_loader/3Starts a database loader under id DatabaseId with options Opts.
stop_loader/1Stops the database loader under id DatabaseId.
wait_for_loader/1Blocks caller execution until either readiness is achieved or a database load attempt fails.
wait_for_loader/2Like wait_for_loader/1 but it can time-out.

Function Details

get_info/1

get_info(DatabaseId) -> {ok, Info} | {error, Error}

Returns the properties of a currently loaded database.

Returns:

See also: get_info/2.

get_info/2

get_info(DatabaseId, Property) -> {ok, Value} | {error, Error}

Returns a specific property of a currently loaded database.

Returns:

See also: get_info/1.

get_version/1

get_version(DatabaseId) -> {ok, LoadedVersion} | {error, Error}

This function is deprecated:

Please use get_info/2 instead.

Returns:

Returns the currently loaded database version.

lookup/2

lookup(DatabaseId, Address) -> {ok, Entry} | {error, Error}

Looks-up info on IPv4 and IPv6 addresses.

Returns:

start_loader/2

start_loader(DatabaseId, DatabaseURL) -> ok | {error, Error}

Like :start_loader/3 but with default options

Returns:

See also: start_loader/3, wait_for_loader/1, wait_for_loader/2.

start_loader/3

start_loader(DatabaseId, DatabaseURL, Opts) -> ok | {error, Error}

Starts a database loader under id DatabaseId with options Opts.

Returns:

See also: start_loader/2, wait_for_loader/1, wait_for_loader/2.

stop_loader/1

stop_loader(DatabaseId) -> ok | {error, Error}

Stops the database loader under id DatabaseId.

Returns ok in case of success, {error, not_found} otherwise.

wait_for_loader/1

wait_for_loader(DatabaseId) -> {ok, LoadedVersion} | {error, Error}

Blocks caller execution until either readiness is achieved or a database load attempt fails.

Returns:

See also: start_loader/2, wait_for_loader/2.

wait_for_loader/2

wait_for_loader(DatabaseId, Timeout) -> {ok, LoadedVersion} | {error, Error}

Like wait_for_loader/1 but it can time-out.

Returns:

See also: start_loader/2, wait_for_loader/1.


Generated by EDoc, May 4 2018, 21:11:20.