document that under wxMSW slant == italic

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

diff --git a/interface/wx/socket.h b/interface/wx/socket.h
index 286c05cd00000111e5bfd7b077523e2d4ba33834..a0ada831198ac521cbe7c7a768cef749889a8b3d 100644 (file)
--- a/interface/wx/socket.h
+++ b/interface/wx/socket.h
@@ -210,7 +210,7 @@ public:
         accepted, it will wait for the next incoming connection to
         arrive.
 
-        @warning: This method will block the GUI.
+        @warning This method will block the GUI.
 
         If @a wait is @false, it will try to accept a pending connection
         if there is one, but it will always return immediately without blocking
@@ -296,7 +296,7 @@ public:
         If @a wait is @true, Connect() will wait until the connection
         completes.
 
-        @warning: This method will block the GUI.
+        @warning This method will block the GUI.
 
         If @a wait is @false, Connect() will try to establish the connection
         and return immediately, without blocking the GUI. When used this way,
@@ -427,6 +427,26 @@ public:
         Returns the length of the socket address.
     */
     int SockAddrLen();
+
+    /**
+        Returns the pointer to the low-level representation of the address.
+
+        This can be used to pass socket address information to a 3rd party
+        library.
+
+        @return
+            Pointer to a sockaddr-derived struct.
+    */
+    const sockaddr *GetAddressData() const;
+
+    /**
+        Returns the length of the buffer retrieved by GetAddressData().
+
+        @return
+            The size of the sockaddr-derived struct corresponding to this
+            address.
+    */
+    int GetAddressDataLen() const;
 };
 
 
@@ -435,10 +455,12 @@ public:
     @class wxSocketEvent
 
     This event class contains information about socket events.
+    This kind of events are sent to the event handler specified with
+    wxSocketBase::SetEventHandler.
 
     @beginEventTable{wxSocketEvent}
     @event{EVT_SOCKET(id, func)}
-           Process a socket event, supplying the member function.
+        Process a socket event, supplying the member function.
     @endEventTable
 
     @library{wxnet}
@@ -603,7 +625,7 @@ enum
     wxSOCKET_NOWAIT = 1,    ///< Read/write as much data as possible and return immediately.
     wxSOCKET_WAITALL = 2,   ///< Wait for all required data to be read/written unless an error occurs.
     wxSOCKET_BLOCK = 4,     ///< Block the GUI (do not yield) while reading/writing data.
-    wxSOCKET_REUSEADDR = 8, ///< Allows the use of an in-use port (wxServerSocket only)
+    wxSOCKET_REUSEADDR = 8, ///< Allows the use of an in-use port.
     wxSOCKET_BROADCAST = 16, ///< Switches the socket to broadcast mode
     wxSOCKET_NOBIND = 32    ///< Stops the socket from being bound to a specific
                             ///< adapter (normally used in conjunction with
@@ -622,7 +644,7 @@ enum
     wxFTP or wxHTTP in another thread) you must initialize the sockets from the
     main thread by calling Initialize() before creating the other ones.
 
-    @beginEventTable{wxSocketEvent}
+    @beginEventEmissionTable{wxSocketEvent}
     @event{EVT_SOCKET(id, func)}
         Process a @c wxEVT_SOCKET event.
         See @ref wxSocketEventFlags and @ref wxSocketFlags for more info.
@@ -657,7 +679,7 @@ public:
         Do not destroy a socket using the delete operator directly;
         use Destroy() instead. Also, do not create socket objects in the stack.
     */
-    ~wxSocketBase();
+    virtual ~wxSocketBase();
 
     /**
         Destroys the socket safely.
@@ -723,14 +745,14 @@ public:
 
         @return @true if no error happened, @false otherwise.
     */
-    bool GetLocal(wxSockAddress& addr) const;
+    virtual bool GetLocal(wxSockAddress& addr) const;
 
     /**
         Return the peer address field of the socket.
 
         @return @true if no error happened, @false otherwise.
     */
-    bool GetPeer(wxSockAddress& addr) const;
+    virtual bool GetPeer(wxSockAddress& addr) const;
 
     /**
         Return the socket timeout in seconds.
@@ -752,7 +774,7 @@ public:
         complete immediately without blocking (unless the @b wxSOCKET_WAITALL flag
         is set, in which case the operation might still block).
     */
-    bool IsData() const;
+    bool IsData();
 
     /**
         Returns @true if the socket is not connected.
@@ -837,7 +859,7 @@ public:
         The application must therefore be prepared to handle socket event messages even
         after calling Close().
     */
-    void Close();
+    virtual bool Close();
 
     /**
         Shuts down the writing end of the socket.
@@ -1002,7 +1024,7 @@ public:
         be called for client sockets, if it is, @b bind() is called before @b
         connect().
     */
-    bool SetLocal(const wxIPV4address& local);
+    virtual bool SetLocal(const wxIPV4address& local);
 
     /**
         Set the default socket timeout in seconds.
@@ -1011,7 +1033,7 @@ public:
         functions if you don't specify a wait interval. Initially, the default
         timeout is 10 minutes.
     */
-    void SetTimeout(int seconds);
+    void SetTimeout(long seconds);
 
     /**
         Put the specified data into the input queue.