yuanbiao
/
emqx
1
0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(emqx_trie): no doc for internal functions

This commit is contained in:
Zaiming Shi 2021-04-18 21:08:07 +02:00 committed by Zaiming (Stone) Shi
parent 6be28cecab
commit 5569c86319
1 changed files with 5 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/emqx_trie.erl
View File

@ -133,7 +133,7 @@ lock_tables() ->
%% Internal functions %% Internal functions
%%-------------------------------------------------------------------- %%--------------------------------------------------------------------
%% @doc Topic to triples. %% Topic to triples.
-spec(triples(emqx_topic:topic()) -> list(triple())). -spec(triples(emqx_topic:topic()) -> list(triple())).
triples(Topic) when is_binary(Topic) -> triples(Topic) when is_binary(Topic) ->
triples(emqx_topic:words(Topic), root, []). triples(emqx_topic:words(Topic), root, []).
@ -149,8 +149,7 @@ join(root, W) ->
join(Parent, W) -> join(Parent, W) ->
emqx_topic:join([Parent, W]). emqx_topic:join([Parent, W]).
%% @private %% Add a path to the trie.
%% @doc Add a path to the trie.
add_path({Node, Word, Child}) -> add_path({Node, Word, Child}) ->
Edge = #trie_edge{node_id = Node, word = Word}, Edge = #trie_edge{node_id = Node, word = Word},
case mnesia:wread({?TRIE_NODE_TAB, Node}) of case mnesia:wread({?TRIE_NODE_TAB, Node}) of
@ -166,8 +165,7 @@ add_path({Node, Word, Child}) ->
write_trie(#trie{edge = Edge, node_id = Child}) write_trie(#trie{edge = Edge, node_id = Child})
end. end.
%% @private %% Match node with word or '+'.
%% @doc Match node with word or '+'.
match_node(root, [NodeId = <<$$, _/binary>>|Words]) -> match_node(root, [NodeId = <<$$, _/binary>>|Words]) ->
match_node(NodeId, Words, []); match_node(NodeId, Words, []);
@ -185,8 +183,7 @@ match_node(NodeId, [W|Words], ResAcc) ->
end end
end, 'match_#'(NodeId, ResAcc), [W, '+']). end, 'match_#'(NodeId, ResAcc), [W, '+']).
%% @private %% Match node with '#'.
%% @doc Match node with '#'.
'match_#'(NodeId, ResAcc) -> 'match_#'(NodeId, ResAcc) ->
case mnesia:read(?TRIE_TAB, #trie_edge{node_id = NodeId, word = '#'}) of case mnesia:read(?TRIE_TAB, #trie_edge{node_id = NodeId, word = '#'}) of
[#trie{node_id = ChildId}] -> [#trie{node_id = ChildId}] ->
@ -194,8 +191,7 @@ match_node(NodeId, [W|Words], ResAcc) ->
[] -> ResAcc [] -> ResAcc
end. end.
%% @private %% Delete paths from the trie.
%% @doc Delete paths from the trie.
delete_path([]) -> delete_path([]) ->
ok; ok;
delete_path([{NodeId, Word, _} | RestPath]) -> delete_path([{NodeId, Word, _} | RestPath]) ->
@ -212,11 +208,9 @@ delete_path([{NodeId, Word, _} | RestPath]) ->
mnesia:abort({node_not_found, NodeId}) mnesia:abort({node_not_found, NodeId})
end. end.
%% @private
write_trie(Trie) -> write_trie(Trie) ->
mnesia:write(?TRIE_TAB, Trie, write). mnesia:write(?TRIE_TAB, Trie, write).
%% @private
write_trie_node(TrieNode) -> write_trie_node(TrieNode) ->
mnesia:write(?TRIE_NODE_TAB, TrieNode, write). mnesia:write(?TRIE_NODE_TAB, TrieNode, write).