View Source locus_mmdb_tree (locus v2.3.10)

API for working with MMDB - tree section

Summary

Types

bad_tree_error/0
index/0
ip4_address_prefix/0
ip6_address_prefix/0
ip_address_prefix/0
t/0

Functions

lookup(Address, Tree)
Looks up for a DataIndex for Address within Tree
new(TreeData, NodeCount, RecordSize, IpVersion, DataSectionSize)
Instantiates a new Tree out of TreeData, a few metadata properties and DataSectionSize

Types

Link to this type

bad_tree_error/0

View Source 
-type bad_tree_error() ::
    {invalid_node_index_for_ipv4_root, map()} | {ipv4_root_data_index_out_of_range, map()}.
Link to this type

index/0

View Source 
-type index() :: non_neg_integer().
Link to this type

ip4_address_prefix/0

View Source 
-type ip4_address_prefix() :: {inet:ip4_address(), 0..32}.
Link to this type

ip6_address_prefix/0

View Source 
-type ip6_address_prefix() :: {inet:ip6_address(), 0..128}.
Link to this type

ip_address_prefix/0

View Source 
-type ip_address_prefix() :: ip4_address_prefix() | ip6_address_prefix().
Link to this opaque

t/0

View Source 
-opaque t()

Functions

Link to this function

lookup(Address, Tree)

View Source 
-spec lookup(Address, Tree) -> {ok, DataIndex} | not_found | {error, Reason}
          when
              Address :: inet:ip_address(),
              Tree :: t(),
              DataIndex :: locus_mmdb_data_codec:index(),
              Reason :: ipv4_database | not_found.
Looks up for a DataIndex for Address within Tree
Link to this function

new(TreeData, NodeCount, RecordSize, IpVersion, DataSectionSize)

View Source 
-spec new(TreeData, NodeCount, RecordSize, IpVersion, DataSectionSize) -> {ok, Tree} | {error, Reason}
       when
           TreeData :: binary(),
           NodeCount :: non_neg_integer(),
           RecordSize :: non_neg_integer(),
           IpVersion :: 4 | 6,
           DataSectionSize :: non_neg_integer(),
           Tree :: t(),
           Reason :: term().
Instantiates a new Tree out of TreeData, a few metadata properties and DataSectionSize