I noticed an inconsistency between the code and its comments.
I updated the comments to reflect the current code.

-- 
Ivo Danihelka
From 1d8b132d368119cd0cb8219e8cd90d8d35f0d647 Mon Sep 17 00:00:00 2001
From: Ivo Danihelka <[email protected]>
Date: Wed, 21 Dec 2011 16:21:55 +0100
Subject: [PATCH] Updated connector open() doc strings.

Signed-off-by: Ivo Danihelka <[email protected]>
---
 src/ipc_connecter.cpp |    2 +-
 src/ipc_connecter.hpp |    6 +++---
 src/tcp_connecter.cpp |    2 +-
 src/tcp_connecter.hpp |    4 ++--
 4 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/src/ipc_connecter.cpp b/src/ipc_connecter.cpp
index 58dccf4..eeb070d 100644
--- a/src/ipc_connecter.cpp
+++ b/src/ipc_connecter.cpp
@@ -126,7 +126,7 @@ void zmq::ipc_connecter_t::start_connecting ()
         return;
     }
 
-    //  Connection establishment may be dealyed. Poll for its completion.
+    //  Connection establishment may be delayed. Poll for its completion.
     else if (rc == -1 && errno == EAGAIN) {
         handle = add_fd (s);
         handle_valid = true;
diff --git a/src/ipc_connecter.hpp b/src/ipc_connecter.hpp
index d2d1752..a2cb4db 100644
--- a/src/ipc_connecter.hpp
+++ b/src/ipc_connecter.hpp
@@ -75,9 +75,9 @@ namespace zmq
         //  Set address to connect to.
         int set_address (const char *addr_);
 
-        //  Open TCP connecting socket. Returns -1 in case of error,
-        //  0 if connect was successfull immediately and 1 if async connect
-        //  was launched.
+        //  Open IPC connecting socket. Returns -1 in case of error,
+        //  0 if connect was successfull immediately. Returns -1 with
+        //  EAGAIN errno if async connect was launched.
         int open ();
 
         //  Close the connecting socket.
diff --git a/src/tcp_connecter.cpp b/src/tcp_connecter.cpp
index 042e82a..1d05b1e 100644
--- a/src/tcp_connecter.cpp
+++ b/src/tcp_connecter.cpp
@@ -137,7 +137,7 @@ void zmq::tcp_connecter_t::start_connecting ()
         return;
     }
 
-    //  Connection establishment may be dealyed. Poll for its completion.
+    //  Connection establishment may be delayed. Poll for its completion.
     else if (rc == -1 && errno == EAGAIN) {
         handle = add_fd (s);
         handle_valid = true;
diff --git a/src/tcp_connecter.hpp b/src/tcp_connecter.hpp
index fc3b9f2..19b6ec5 100644
--- a/src/tcp_connecter.hpp
+++ b/src/tcp_connecter.hpp
@@ -73,8 +73,8 @@ namespace zmq
         int set_address (const char *addr_);
 
         //  Open TCP connecting socket. Returns -1 in case of error,
-        //  0 if connect was successfull immediately and 1 if async connect
-        //  was launched.
+        //  0 if connect was successfull immediately. Returns -1 with
+        //  EAGAIN errno if async connect was launched.
         int open ();
 
         //  Close the connecting socket.
-- 
1.7.1

_______________________________________________
zeromq-dev mailing list
[email protected]
http://lists.zeromq.org/mailman/listinfo/zeromq-dev

Reply via email to