Browse Source

Fix specs.

Roberto Ostinelli 9 years ago
parent
commit
8b017e794a
3 changed files with 6 additions and 6 deletions
  1. 2 2
      src/syn.erl
  2. 3 3
      src/syn_groups.erl
  3. 1 1
      src/syn_registry.erl

+ 2 - 2
src/syn.erl

@@ -98,11 +98,11 @@ registry_count() ->
 registry_count(Node) ->
     syn_registry:count(Node).
 
--spec join(Name :: any(), Pid :: pid()) -> ok | {error, pid_already_in_group}.
+-spec join(Name :: any(), Pid :: pid()) -> ok.
 join(Name, Pid) ->
     syn_groups:join(Name, Pid).
 
--spec leave(Name :: any(), Pid :: pid()) -> ok | {error, undefined | pid_not_in_group}.
+-spec leave(Name :: any(), Pid :: pid()) -> ok | {error, pid_not_in_group}.
 leave(Name, Pid) ->
     syn_groups:leave(Name, Pid).
 

+ 3 - 3
src/syn_groups.erl

@@ -60,12 +60,12 @@ start_link() ->
     Options = [],
     gen_server:start_link({local, ?MODULE}, ?MODULE, [], Options).
 
--spec join(Name :: any(), Pid :: pid()) -> ok | {error, pid_already_in_group}.
+-spec join(Name :: any(), Pid :: pid()) -> ok.
 join(Name, Pid) when is_pid(Pid) ->
     Node = node(Pid),
     gen_server:call({?MODULE, Node}, {join, Name, Pid}).
 
--spec leave(Name :: any(), Pid :: pid()) -> ok | {error, undefined | pid_not_in_group}.
+-spec leave(Name :: any(), Pid :: pid()) -> ok | {error, pid_not_in_group}.
 leave(Name, Pid) when is_pid(Pid) ->
     Node = node(Pid),
     gen_server:call({?MODULE, Node}, {leave, Name, Pid}).
@@ -245,7 +245,7 @@ find_by_pid_and_name(Pid, Name) when is_tuple(Name) ->
 find_by_pid_and_name(Pid, Name) ->
     i_find_by_pid_and_name(Pid, {'=:=', '$1', Name}).
 
--spec i_find_by_pid_and_name(Pid :: pid(), NameGuard :: any()) -> boolean().
+-spec i_find_by_pid_and_name(Pid :: pid(), NameGuard :: any()) -> Process :: #syn_groups_table{} | undefined.
 i_find_by_pid_and_name(Pid, NameGuard) ->
     %% build match specs
     MatchHead = #syn_groups_table{name = '$1', pid = '$2', _ = '_'},

+ 1 - 1
src/syn_registry.erl

@@ -338,7 +338,7 @@ return_if_on_connected_node(Process) ->
 remove_process_by_key(Key) ->
     mnesia:dirty_delete(syn_registry_table, Key).
 
--spec register_on_node(Key :: any(), Pid :: pid(), Node :: atom(), Meta :: any()) -> ok.
+-spec register_on_node(Key :: any(), Pid :: pid(), Node :: atom(), Meta :: any()) -> true.
 register_on_node(Key, Pid, Node, Meta) ->
     %% add to table
     mnesia:dirty_write(#syn_registry_table{