no real changes, just some minor cleanup to fix a few compile- and run-time warnings...

[wxWidgets.git] / interface / wx / socket.h

diff --git a/interface/wx/socket.h b/interface/wx/socket.h
index 4248752b6db11d0d49e680c78a5109eaecf20659..5edc0cf3063958d158091fed91dbe19989411fc6 100644 (file)
--- a/interface/wx/socket.h
+++ b/interface/wx/socket.h
@@ -499,6 +499,10 @@ public:
         Returns @true if an error occurred in the last IO operation.
         Use this function to check for an error condition after one of the
         following calls: Discard, Peek, Read, ReadMsg, Unread, Write, WriteMsg.
+
+        Notice that this function will return @true even if the other end of a
+        (connected, i.e. TCP) socket was orderly closed by the peer. Use
+        IsClosed() to check for this.
     */
     bool Error() const;
 
@@ -567,6 +571,13 @@ public:
     */
     bool IsConnected() const;
 
+    /**
+        Return @true if the other end of the socket was closed by the peer.
+
+        Notice that Error() will return @true as well when this happens.
+     */
+    bool IsClosed() const;
+
     /**
         This function waits until the socket is readable. This might mean that
         queued data is available for reading or, for streamed sockets, that