Skip to content

Commit

Permalink
Minor update for brecv documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
yrashk committed Mar 4, 2011
1 parent c617936 commit 2fbe755
Showing 1 changed file with 1 addition and 3 deletions.
4 changes: 1 addition & 3 deletions src/ezmq.erl
Original file line number Diff line number Diff line change
Expand Up @@ -90,17 +90,15 @@ send(Socket, Binary, Flags) when is_list(Flags) ->
ezmq_result(ezmq_nif:send(Socket, Binary, sendrecv_flags(Flags))).

%% @equiv brecv(Socket, 0)
%% @deprecated
%% @spec brecv(ezmq_socket()) -> {ok, ezmq_data()} | ezmq_error()
-spec brecv(Socket :: ezmq_socket()) -> {ok, ezmq_data()} | ezmq_error().

brecv(Socket) ->
ezmq_result(brecv(Socket, [])).

%% @doc Receive a message from a socket in a blocking way.
%% This function can block the current VM thread. <b>DO NOT USE</b>.
%% This function can block the current VM scheduler. <b>DO NOT USE IT UNLESS YOU REALLY KNOW WHAT YOU ARE DOING</b>.
%% @end
%% @deprecated
%% @spec brecv(ezmq_socket(), ezmq_send_recv_flags()) -> {ok, ezmq_data()} | ezmq_error()
-spec brecv(Socket :: ezmq_socket(), Flags :: ezmq_send_recv_flags()) -> {ok, ezmq_data()} | ezmq_error().

Expand Down

0 comments on commit 2fbe755

Please sign in to comment.