Permalink
Browse files

Documentation fixed to discuss send flags.

  • Loading branch information...
sustrik committed Aug 19, 2010
1 parent d6d0206 commit 10b27d402d4edbafcda1e8623a63102fe289b60d
Showing with 6 additions and 2 deletions.
  1. +6 −2 src/zmq.erl
View
@@ -30,6 +30,9 @@
%%% to the process owner's mailbox instead of explicitely
%%% requiring recv/1 call.
%%% @end
+%%% @type zmq_sendopt() = sndmore.
+%%% Send options. See 0MQ man pages for details.
+%%% @end
%%%-------------------------------------------------------------------
-module(zmq).
-author("dhammika@gmail.com").
@@ -161,15 +164,16 @@ connect({Port, S}, Address) when is_binary(Address) ->
driver(Port, Msg).
%%--------------------------------------------------------------------
-%% @equiv send(Socket::zmq_socket(), Msg::binary(), [])
+%% @equiv send(S, Msg, [])
%% @end
%%--------------------------------------------------------------------
send(Socket, Data) ->
send(Socket, Data, []).
%%--------------------------------------------------------------------
%% @doc Send a message to a given 0MQ socket.
-%% @spec (Socket::zmq_socket(), Msg::binary()) -> ok | {error, Reason}
+%% @spec (Socket::zmq_socket(), Msg::binary(), Flags) -> ok | {error, Reason}
+%% Flags = [zmq_sendopt()]
%% @end
%%--------------------------------------------------------------------
send(Socket, Data, Flags)

0 comments on commit 10b27d4

Please sign in to comment.