]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/wx/socket.h
Move code removing "-psn_xxx" command line arguments to common code.
[wxWidgets.git] / interface / wx / socket.h
index 7e0d4ca014ee8eff57f0238ab4425346cdd0d78d..e78e484abd167a19739b1a75a066bb6486cd873b 100644 (file)
@@ -2,11 +2,20 @@
 // Name:        socket.h
 // Purpose:     interface of wxIP*address, wxSocket* classes
 // Author:      wxWidgets team
 // Name:        socket.h
 // Purpose:     interface of wxIP*address, wxSocket* classes
 // Author:      wxWidgets team
-// RCS-ID:      $Id$
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 
+/**
+    The type of the native socket.
+
+    Notice that the definition below is simplified and this type is not always
+    int, e.g. it is a 64 bit integer type under Win64.
+
+    @since 2.9.5
+  */
+typedef int wxSOCKET_T;
+
 /**
     @class wxIPaddress
 
 /**
     @class wxIPaddress
 
@@ -14,7 +23,7 @@
     objects. Currently, only wxIPV4address is implemented. An experimental
     implementation for IPV6, wxIPV6address, is being developed.
 
     objects. Currently, only wxIPV4address is implemented. An experimental
     implementation for IPV6, wxIPV6address, is being developed.
 
-    @library{wxbase}
+    @library{wxnet}
     @category{net}
 */
 class wxIPaddress : public wxSockAddress
     @category{net}
 */
 class wxIPaddress : public wxSockAddress
@@ -103,7 +112,7 @@ public:
 
     A class for working with IPv4 network addresses.
 
 
     A class for working with IPv4 network addresses.
 
-    @library{wxbase}
+    @library{wxnet}
     @category{net}
 */
 class wxIPV4address : public wxIPaddress
     @category{net}
 */
 class wxIPV4address : public wxIPaddress
@@ -400,7 +409,7 @@ public:
 
     You are unlikely to need to use this class: only wxSocketBase uses it.
 
 
     You are unlikely to need to use this class: only wxSocketBase uses it.
 
-    @library{wxbase}
+    @library{wxnet}
     @category{net}
 
     @see wxSocketBase, wxIPaddress, wxIPV4address
     @category{net}
 
     @see wxSocketBase, wxIPaddress, wxIPV4address
@@ -1387,6 +1396,25 @@ public:
     */
     void SetNotify(wxSocketEventFlags flags);
 
     */
     void SetNotify(wxSocketEventFlags flags);
 
+    /**
+        Returns the native socket descriptor.
+
+        This is intended to use with rarely used specific platform features
+        that can only be accessed via the actual socket descriptor.
+
+        Do not use this for reading or writing data from or to the socket as
+        this would almost surely interfere with wxSocket code logic and result
+        in unexpected behaviour.
+
+        The socket must be successfully initialized, e.g. connected for client
+        sockets, before this method can be called.
+
+        @return Returns the native socket descriptor.
+
+        @since 2.9.5
+    */
+    wxSOCKET_T GetSocket() const;
+
     //@}
 };
 
     //@}
 };