A fix for attribrute sorting, but it's still broken if there are

[wxWidgets.git] / docs / latex / wx / socket.tex

diff --git a/docs/latex/wx/socket.tex b/docs/latex/wx/socket.tex
index 3247717456ec9d83ea0668483f4c6a9a4879ad1b..56959fca5efc98732452cf5201f561f2e51848bf 100644 (file)
--- a/docs/latex/wx/socket.tex
+++ b/docs/latex/wx/socket.tex
@@ -6,7 +6,7 @@
 %% Created:     1999
 %% RCS-ID:      $Id$
 %% Copyright:   (c) wxWindows team
 %% Created:     1999
 %% RCS-ID:      $Id$
 %% Copyright:   (c) wxWindows team

-%% Licence:     wxWindows licence
+%% License:     wxWindows license

 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxSocketBase}}\label{wxsocketbase}
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxSocketBase}}\label{wxsocketbase}


@@ -44,7 +44,7 @@ defines all basic IO functionality.
 \begin{twocollist}\itemsep=0pt
 \twocolitem{{\bf wxSOCKET\_INPUT}}{There is data available for reading.}
 \twocolitem{{\bf wxSOCKET\_OUTPUT}}{The socket is ready to be written to.}
 \begin{twocollist}\itemsep=0pt
 \twocolitem{{\bf wxSOCKET\_INPUT}}{There is data available for reading.}
 \twocolitem{{\bf wxSOCKET\_OUTPUT}}{The socket is ready to be written to.}

-\twocolitem{{\bf wxSOCKET\_CONNECTION}}{Incoming connection (server), or connection establishment (client).}
+\twocolitem{{\bf wxSOCKET\_CONNECTION}}{Incoming connection request (server), or successful connection establishment (client).}

 \twocolitem{{\bf wxSOCKET\_LOST}}{The connection has been closed.}
 \end{twocollist}
 
 \twocolitem{{\bf wxSOCKET\_LOST}}{The connection has been closed.}
 \end{twocollist}
 


@@ -54,7 +54,7 @@ The {\bf wxSOCKET\_INPUT} event will be issued whenever there is data
 available for reading. This will be the case if the input queue was
 empty and new data arrives, or if the application has read some data
 yet there is still more data available. This means that the application
 available for reading. This will be the case if the input queue was
 empty and new data arrives, or if the application has read some data
 yet there is still more data available. This means that the application

-does not need to read all available data in response to a
+does not need to read all available data in response to a 

 {\bf wxSOCKET\_INPUT} event, as more events will be produced as
 necessary.
 
 {\bf wxSOCKET\_INPUT} event, as more events will be produced as
 necessary.
 


@@ -64,9 +64,9 @@ with \helpref{Accept}{wxsocketserveraccept}. After that, new
 events will be generated only after an output operation fails
 with {\bf wxSOCKET\_WOULDBLOCK} and buffer space becomes available
 again. This means that the application should assume that it
 events will be generated only after an output operation fails
 with {\bf wxSOCKET\_WOULDBLOCK} and buffer space becomes available
 again. This means that the application should assume that it

-can write data to the socket until an {\bf wxSOCKET\_WOULDBLOCK}
+can write data to the socket until an {\bf wxSOCKET\_WOULDBLOCK} 

 error occurs; after this, whenever the socket becomes writable
 error occurs; after this, whenever the socket becomes writable

-again the application will be notified with another
+again the application will be notified with another 

 {\bf wxSOCKET\_OUTPUT} event.
 
 The {\bf wxSOCKET\_CONNECTION} event is issued when a delayed connection
 {\bf wxSOCKET\_OUTPUT} event.
 
 The {\bf wxSOCKET\_CONNECTION} event is issued when a delayed connection


@@ -76,13 +76,13 @@ at the incoming queue (server).
 The {\bf wxSOCKET\_LOST} event is issued when a close indication is
 received for the socket. This means that the connection broke down or
 that it was closed by the peer. Also, this event will be issued if
 The {\bf wxSOCKET\_LOST} event is issued when a close indication is
 received for the socket. This means that the connection broke down or
 that it was closed by the peer. Also, this event will be issued if

-a delayed connection request fails.
+a connection request fails.

 
 \wxheading{Event handling}
 
 To process events coming from a socket object, use the following event
 
 \wxheading{Event handling}
 
 To process events coming from a socket object, use the following event

-handler macro to direct events to member functions that take a
-\helpref{wxSocketEvent}{wxsocketevent} argument.
+handler macro to direct events to member functions that take
+a \helpref{wxSocketEvent}{wxsocketevent} argument.

 
 \twocolwidtha{7cm}%
 \begin{twocollist}\itemsep=0pt
 
 \twocolwidtha{7cm}%
 \begin{twocollist}\itemsep=0pt


@@ -93,7 +93,7 @@ handler macro to direct events to member functions that take a
 
 \helpref{wxSocketEvent}{wxsocketevent}, 
 \helpref{wxSocketClient}{wxsocketclient}, 
 
 \helpref{wxSocketEvent}{wxsocketevent}, 
 \helpref{wxSocketClient}{wxsocketclient}, 

-\helpref{wxSocketServer}{wxsocketserver},
+\helpref{wxSocketServer}{wxsocketserver}, 

 \helpref{Sockets sample}{samplesockets}
 
 % ---------------------------------------------------------------------------
 \helpref{Sockets sample}{samplesockets}
 
 % ---------------------------------------------------------------------------


@@ -106,7 +106,7 @@ handler macro to direct events to member functions that take a
 
 \helpref{wxSocketBase}{wxsocketbaseconstruct}\\
 \helpref{\destruct{wxSocketBase}}{wxsocketbasedestruct}\\
 
 \helpref{wxSocketBase}{wxsocketbaseconstruct}\\
 \helpref{\destruct{wxSocketBase}}{wxsocketbasedestruct}\\

-\helpref{wxDestroy}{wxsocketbasedestroy}
+\helpref{Destroy}{wxsocketbasedestroy}

 
 \membersection{Socket state}
 
 
 \membersection{Socket state}
 


@@ -189,8 +189,8 @@ releases of wxWindows.
 
 \func{}{wxSocketBase}{\void}
 
 
 \func{}{wxSocketBase}{\void}
 

-Default constructor. Don't use it directly; instead, use
-\helpref{wxSocketClient}{wxsocketclient} to construct a socket client, or
+Default constructor. Don't use it directly; instead, use 
+\helpref{wxSocketClient}{wxsocketclient} to construct a socket client, or 

 \helpref{wxSocketServer}{wxsocketserver} to construct a socket server.
 
 \membersection{wxSocketBase::\destruct{wxSocketBase}}\label{wxsocketbasedestruct}
 \helpref{wxSocketServer}{wxsocketserver} to construct a socket server.
 
 \membersection{wxSocketBase::\destruct{wxSocketBase}}\label{wxsocketbasedestruct}


@@ -210,7 +210,7 @@ socket objects in the stack.
 
 You can setup a callback function to be called when an event occurs.
 The function will be called only for those events for which notification
 
 You can setup a callback function to be called when an event occurs.
 The function will be called only for those events for which notification

-has been enabled with \helpref{Notify}{wxsocketbasenotify} and
+has been enabled with \helpref{Notify}{wxsocketbasenotify} and 

 \helpref{SetNotify}{wxsocketbasesetnotify}. The prototype of the
 callback must be as follows:
 
 \helpref{SetNotify}{wxsocketbasesetnotify}. The prototype of the
 callback must be as follows:
 


@@ -219,16 +219,19 @@ void SocketCallback(wxSocketBase& sock, wxSocketNotify evt, char *cdata);
 \end{verbatim}
 
 The first parameter is a reference to the socket object in which the
 \end{verbatim}
 
 The first parameter is a reference to the socket object in which the

-event occured. The second parameter tells you which event occured.
+event occurred. The second parameter tells you which event occurred.

 (See \helpref{wxSocket events}{wxsocketbase}). The third parameter
 is the user data you specified using \helpref{CallbackData}{wxsocketbasecallbackdata}.
 
 (See \helpref{wxSocket events}{wxsocketbase}). The third parameter
 is the user data you specified using \helpref{CallbackData}{wxsocketbasecallbackdata}.
 

-Note that events are preferred over callbacks where possible.
-

 \wxheading{Return value}
 
 A pointer to the previous callback.
 
 \wxheading{Return value}
 
 A pointer to the previous callback.
 

+\wxheading{Remark/Warning}
+
+Note that callbacks are now deprecated and unsupported, and they remain
+for backwards compatibility only. Use events instead.
+

 \wxheading{See also}
 
 \helpref{wxSocketBase::CallbackData}{wxsocketbasecallbackdata}, 
 \wxheading{See also}
 
 \helpref{wxSocketBase::CallbackData}{wxsocketbasecallbackdata}, 


@@ -245,12 +248,17 @@ A pointer to the previous callback.
 This function sets the the user data which will be passed to a
 callback function set via \helpref{Callback}{wxsocketbasecallback}.
 
 This function sets the the user data which will be passed to a
 callback function set via \helpref{Callback}{wxsocketbasecallback}.
 

-Note that events are preferred over callbacks where possible.
-

 \wxheading{Return value}
 
 A pointer to the previous user data.
 
 \wxheading{Return value}
 
 A pointer to the previous user data.
 

+\wxheading{Remark/Warning}
+
+Note that callbacks are now deprecated and unsupported, and they remain
+for backwards compatibility only. Use events instead.
+
+\wxheading{See also}
+

 \helpref{wxSocketBase::Callback}{wxsocketbasecallback}, 
 \helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify}, 
 \helpref{wxSocketBase::Notify}{wxsocketbasenotify}
 \helpref{wxSocketBase::Callback}{wxsocketbasecallback}, 
 \helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify}, 
 \helpref{wxSocketBase::Notify}{wxsocketbasenotify}


@@ -265,8 +273,9 @@ A pointer to the previous user data.
 This function shuts down the socket, disabling further transmission and
 reception of data; it also disables events for the socket and frees the
 associated system resources. Upon socket destruction, Close is automatically
 This function shuts down the socket, disabling further transmission and
 reception of data; it also disables events for the socket and frees the
 associated system resources. Upon socket destruction, Close is automatically

-called. This means that you don't need to do it yourself, unless you
-explicitly want to disable further operation.
+called, so in most cases you won't need to do it yourself, unless you
+explicitly want to shut down the socket, typically to notify the peer
+that you are closing the connection.

 
 \wxheading{Remark/Warning}
 
 
 \wxheading{Remark/Warning}
 


@@ -316,7 +325,7 @@ If you use \helpref{Error}{wxsocketbaseerror}, it will always return FALSE.
 
 \constfunc{bool}{Error}{\void}
 
 
 \constfunc{bool}{Error}{\void}
 

-Returns TRUE if an error occured in the last IO operation.
+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.
 
 Use this function to check for an error condition after one of the
 following calls: Discard, Peek, Read, ReadMsg, Unread, Write, WriteMsg.


@@ -328,7 +337,7 @@ following calls: Discard, Peek, Read, ReadMsg, Unread, Write, WriteMsg.
 
 \constfunc{void *}{GetClientData}{\void}
 
 
 \constfunc{void *}{GetClientData}{\void}
 

-Returns a pointer of the client data for this socket, as set with
+Returns a pointer of the client data for this socket, as set with 

 \helpref{SetClientData}{wxsocketbasesetclientdata}
 
 %
 \helpref{SetClientData}{wxsocketbasesetclientdata}
 
 %


@@ -336,7 +345,7 @@ Returns a pointer of the client data for this socket, as set with
 %
 \membersection{wxSocketBase::GetLocal}\label{wxsocketbasegetlocal}
 
 %
 \membersection{wxSocketBase::GetLocal}\label{wxsocketbasegetlocal}
 

-\constfunc{bool}{GetLocal}{\param{wxSockAddress\& }{addr\_man}}
+\constfunc{bool}{GetLocal}{\param{wxSockAddress\& }{addr}}

 
 This function returns the local address field of the socket. The local
 address field contains the complete local address of the socket (local
 
 This function returns the local address field of the socket. The local
 address field contains the complete local address of the socket (local


@@ -344,7 +353,7 @@ address, local port, ...).
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-It returns TRUE if no errors happened, FALSE otherwise.
+TRUE if no error happened, FALSE otherwise.

 
 %
 % GetFlags
 
 %
 % GetFlags


@@ -360,7 +369,7 @@ Returns current IO flags, as set with \helpref{SetFlags}{wxsocketbasesetflags}
 %
 \membersection{wxSocketBase::GetPeer}\label{wxsocketbasegetpeer}
 
 %
 \membersection{wxSocketBase::GetPeer}\label{wxsocketbasegetpeer}
 

-\constfunc{bool}{GetPeer}{\param{wxSockAddress\& }{addr\_man}}
+\constfunc{bool}{GetPeer}{\param{wxSockAddress\& }{addr}}

 
 This function returns the peer address field of the socket. The peer 
 address field contains the complete peer host address of the socket
 
 This function returns the peer address field of the socket. The peer 
 address field contains the complete peer host address of the socket


@@ -368,7 +377,7 @@ address field contains the complete peer host address of the socket
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-It returns TRUE if no errors happened, FALSE otherwise.
+TRUE if no error happened, FALSE otherwise.

 
 %
 % InterruptWait
 
 %
 % InterruptWait


@@ -385,11 +394,11 @@ some exception or abnormal problem. InterruptWait is automatically called
 when you \helpref{Close}{wxsocketbaseclose} a socket (and thus also upon
 socket destruction), so you don't need to use it in these cases.
 
 when you \helpref{Close}{wxsocketbaseclose} a socket (and thus also upon
 socket destruction), so you don't need to use it in these cases.
 

-\helpref{wxSocketBase::Wait}{wxsocketbasewait},
-\helpref{wxSocketServer::WaitForAccept}{wxsocketserverwaitforaccept},
-\helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost},
-\helpref{wxSocketBase::WaitForRead}{wxsocketbasewaitforread},
-\helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite},
+\helpref{wxSocketBase::Wait}{wxsocketbasewait}, 
+\helpref{wxSocketServer::WaitForAccept}{wxsocketserverwaitforaccept}, 
+\helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost}, 
+\helpref{wxSocketBase::WaitForRead}{wxsocketbasewaitforread}, 
+\helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite}, 

 \helpref{wxSocketClient::WaitOnConnect}{wxsocketclientwaitonconnect}
 
 %
 \helpref{wxSocketClient::WaitOnConnect}{wxsocketclientwaitonconnect}
 
 %


@@ -446,7 +455,7 @@ ReadMsg, Unread, Write, WriteMsg.
 Returns the last wxSocket error. See \helpref{wxSocket errors}{wxsocketbase}.
 
 Please note that this function merely returns the last error code,
 Returns the last wxSocket error. See \helpref{wxSocket errors}{wxsocketbase}.
 
 Please note that this function merely returns the last error code,

-but it should not be used to determine if an error has occured (this
+but it should not be used to determine if an error has occurred (this

 is because successful operations do not change the LastError value).
 Use \helpref{Error}{wxsocketbaseerror} first, in order to determine
 if the last IO call failed. If this returns TRUE, use LastError
 is because successful operations do not change the LastError value).
 Use \helpref{Error}{wxsocketbaseerror} first, in order to determine
 if the last IO call failed. If this returns TRUE, use LastError


@@ -484,8 +493,8 @@ For \helpref{wxSocketServer}{wxsocketserver}, Ok will return TRUE if the
 server could bind to the specified address and is already listening for
 new connections.
 
 server could bind to the specified address and is already listening for
 new connections.
 

-Ok does not check for IO errors; use \helpref{Error}{wxsocketbaseerror}
-instead for that purpose.
+Ok does not check for IO errors;
+use \helpref{Error}{wxsocketbaseerror} instead for that purpose.

 
 %
 % RestoreState
 
 %
 % RestoreState


@@ -512,10 +521,10 @@ Calls to SaveState and RestoreState can be nested.
 
 This function saves the current state of the socket in a stack. Socket
 state includes flags, as set with \helpref{SetFlags}{wxsocketbasesetflags},
 
 This function saves the current state of the socket in a stack. Socket
 state includes flags, as set with \helpref{SetFlags}{wxsocketbasesetflags},

-event mask, as set with \helpref{SetNotify}{wxsocketbasesetnotify} and
-\helpref{Notify}{wxsocketbasenotify}, user data, as set with
+event mask, as set with \helpref{SetNotify}{wxsocketbasesetnotify} and 
+\helpref{Notify}{wxsocketbasenotify}, user data, as set with 

 \helpref{SetClientData}{wxsocketbasesetclientdata}, and asynchronous
 \helpref{SetClientData}{wxsocketbasesetclientdata}, and asynchronous

-callback settings, as set with \helpref{Callback}{wxsocketbasecallback}
+callback settings, as set with \helpref{Callback}{wxsocketbasecallback} 

 and \helpref{CallbackData}{wxsocketbasecallbackdata}.
 
 Calls to SaveState and RestoreState can be nested.
 and \helpref{CallbackData}{wxsocketbasecallbackdata}.
 
 Calls to SaveState and RestoreState can be nested.


@@ -532,25 +541,24 @@ Calls to SaveState and RestoreState can be nested.
 \func{void}{SetClientData}{\param{void *}{data}}
 
 Sets user-supplied client data for this socket. All socket events will
 \func{void}{SetClientData}{\param{void *}{data}}
 
 Sets user-supplied client data for this socket. All socket events will

-contain a pointer to this data, which can be retrieved with the
-\helpref{wxSocketEvent::GetClientData}{wxsocketeventgetclientdata}
-function.
+contain a pointer to this data, which can be retrieved with
+the \helpref{wxSocketEvent::GetClientData}{wxsocketeventgetclientdata} function.

 
 %
 % SetEventHandler
 %
 \membersection{wxSocketBase::SetEventHandler}\label{wxsocketbaseseteventhandler}
 
 
 %
 % SetEventHandler
 %
 \membersection{wxSocketBase::SetEventHandler}\label{wxsocketbaseseteventhandler}
 

-\func{void}{SetEventHandler}{\param{wxEvtHandler\&}{ evt\_hdlr}, \param{int}{ id = -1}}
+\func{void}{SetEventHandler}{\param{wxEvtHandler\&}{ handler}, \param{int}{ id = -1}}

 
 Sets an event handler to be called when a socket event occurs. The
 handler will be called for those events for which notification is
 
 Sets an event handler to be called when a socket event occurs. The
 handler will be called for those events for which notification is

-enabled with \helpref{SetNotify}{wxsocketbasesetnotify} and
+enabled with \helpref{SetNotify}{wxsocketbasesetnotify} and 

 \helpref{Notify}{wxsocketbasenotify}.
 
 \wxheading{Parameters}
 
 \helpref{Notify}{wxsocketbasenotify}.
 
 \wxheading{Parameters}
 

-\docparam{evt\_hdlr}{Specifies the event handler you want to use.}
+\docparam{handler}{Specifies the event handler you want to use.}

 
 \docparam{id}{The id of socket event.}
 
 
 \docparam{id}{The id of socket event.}
 


@@ -559,18 +567,18 @@ enabled with \helpref{SetNotify}{wxsocketbasesetnotify} and
 \helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify}, 
 \helpref{wxSocketBase::Notify}{wxsocketbasenotify}, 
 \helpref{wxSocketEvent}{wxsocketevent}, 
 \helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify}, 
 \helpref{wxSocketBase::Notify}{wxsocketbasenotify}, 
 \helpref{wxSocketEvent}{wxsocketevent}, 

-\helpref{wxEvtHandler}{wxevthandler}, 
+\helpref{wxEvtHandler}{wxevthandler}

 
 %
 % SetFlags
 %
 \membersection{wxSocketBase::SetFlags}\label{wxsocketbasesetflags}
 
 
 %
 % SetFlags
 %
 \membersection{wxSocketBase::SetFlags}\label{wxsocketbasesetflags}
 

-\func{void}{SetFlags}{\param{wxSocketBase::wxSocketFlags}{ flags}}
+\func{void}{SetFlags}{\param{wxSocketFlags}{ flags}}

 
 

-Use SetFlags to customize IO operation for this socket. The {\it flags}
-parameter is a combination of flags ORed toghether. The following flags
-can be used:
+Use SetFlags to customize IO operation for this socket.
+The {\it flags} parameter may be a combination of flags ORed toghether.
+The following flags can be used:

 
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt
 
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt


@@ -585,9 +593,9 @@ A brief overview on how to use these flags follows.
 If no flag is specified (this is the same as {\bf wxSOCKET\_NONE}),
 IO calls will return after some data has been read or written, even
 when the transfer might not be complete. This is the same as issuing
 If no flag is specified (this is the same as {\bf wxSOCKET\_NONE}),
 IO calls will return after some data has been read or written, even
 when the transfer might not be complete. This is the same as issuing

-exactly one blocking low-level call to recv() or send(). Note that
-{\it blocking} here refers to when the function returns, not to whether
-the GUI blocks during this time.
+exactly one blocking low-level call to recv() or send(). Note
+that {\it blocking} here refers to when the function returns, not
+to whether the GUI blocks during this time.

 
 If {\bf wxSOCKET\_NOWAIT} is specified, IO calls will return immediately.
 Read operations will retrieve only available data. Write operations will
 
 If {\bf wxSOCKET\_NOWAIT} is specified, IO calls will return immediately.
 Read operations will retrieve only available data. Write operations will


@@ -601,9 +609,9 @@ If {\bf wxSOCKET\_WAITALL} is specified, IO calls won't return until ALL
 the data has been read or written (or until an error occurs), blocking if
 necessary, and issuing several low level calls if necessary. This is the
 same as having a loop which makes as many blocking low-level calls to
 the data has been read or written (or until an error occurs), blocking if
 necessary, and issuing several low level calls if necessary. This is the
 same as having a loop which makes as many blocking low-level calls to

-recv() or send() as needed so as to transfer all the data. Note that
-{\it blocking} here refers to when the function returns, not to whether
-the GUI blocks during this time.
+recv() or send() as needed so as to transfer all the data. Note
+that {\it blocking} here refers to when the function returns, not
+to whether the GUI blocks during this time.

 
 The {\bf wxSOCKET\_BLOCK} flag controls whether the GUI blocks during
 IO operations. If this flag is specified, the socket will not yield
 
 The {\bf wxSOCKET\_BLOCK} flag controls whether the GUI blocks during
 IO operations. If this flag is specified, the socket will not yield


@@ -632,7 +640,7 @@ it controls whether the GUI blocks.
 \func{void}{SetNotify}{\param{wxSocketEventFlags}{ flags}}
 
 SetNotify specifies which socket events are to be sent to the event handler.
 \func{void}{SetNotify}{\param{wxSocketEventFlags}{ flags}}
 
 SetNotify specifies which socket events are to be sent to the event handler.

-The {\it flags} parameter is a combination of flags ORed toghether. The
+The {\it flags} parameter may be combination of flags ORed toghether. The

 following flags can be used:
 
 \twocolwidtha{7cm}
 following flags can be used:
 
 \twocolwidtha{7cm}


@@ -663,9 +671,9 @@ For more information on socket events see \helpref{wxSocket events}{wxsocketbase
 \func{void}{SetTimeout}{\param{int }{seconds}}
 
 This function sets the default socket timeout in seconds. This timeout
 \func{void}{SetTimeout}{\param{int }{seconds}}
 
 This function sets the default socket timeout in seconds. This timeout

-applies to all IO calls, and also to the \helpref{Wait}{wxsocketbasewait}
-family of functions if you don't specify a wait interval. Initially, the
-default is set to 10 minutes.
+applies to all IO calls, and also to the \helpref{Wait}{wxsocketbasewait} family
+of functions if you don't specify a wait interval. Initially, the default
+timeout is 10 minutes.

 
 %
 % Peek
 
 %
 % Peek


@@ -745,7 +753,7 @@ of flags being used. For a detailed explanation, see \helpref{wxSocketBase::SetF
 
 \func{wxSocketBase\&}{ReadMsg}{\param{void *}{ buffer}, \param{wxUint32}{ nbytes}}
 
 
 \func{wxSocketBase\&}{ReadMsg}{\param{void *}{ buffer}, \param{wxUint32}{ nbytes}}
 

-This function reads a buffer sent by \helpref{WriteMsg}{wxsocketbasewritemsg}
+This function reads a buffer sent by \helpref{WriteMsg}{wxsocketbasewritemsg} 

 on a socket. If the buffer passed to the function isn't big enough, the
 remaining bytes will be discarded. This function always waits for the
 buffer to be entirely filled, unless an error occurs.
 on a socket. If the buffer passed to the function isn't big enough, the
 remaining bytes will be discarded. This function always waits for the
 buffer to be entirely filled, unless an error occurs.


@@ -816,18 +824,19 @@ Returns a reference to the current object.
 
 \func{bool}{Wait}{\param{long}{ seconds = -1}, \param{long}{ millisecond = 0}}
 
 
 \func{bool}{Wait}{\param{long}{ seconds = -1}, \param{long}{ millisecond = 0}}
 

-This function waits until one of the following conditions is TRUE. Note
-that it is recommended to use the individual Wait functions to wait for
-the required condition, instead of this one.
+This function waits until any of the following conditions is TRUE:

                                             
 \begin{itemize}
 \item The socket becomes readable.
 \item The socket becomes writable.
                                             
 \begin{itemize}
 \item The socket becomes readable.
 \item The socket becomes writable.

-\item An ongoing connection request has completed (only for clients)
-\item An incoming connection request has arrived (only for servers)
+\item An ongoing connection request has completed (\helpref{wxSocketClient}{wxsocketclient} only)
+\item An incoming connection request has arrived (\helpref{wxSocketServer}{wxsocketserver} only)

 \item The connection has been closed.
 \end{itemize}
 
 \item The connection has been closed.
 \end{itemize}
 

+Note that it is recommended to use the individual Wait functions
+to wait for the required condition, instead of this one.
+

 \wxheading{Parameters}
 
 \docparam{seconds}{Number of seconds to wait.
 \wxheading{Parameters}
 
 \docparam{seconds}{Number of seconds to wait.


@@ -843,11 +852,11 @@ FALSE if the timeout was reached.
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxSocketBase::InterruptWait}{wxsocketbaseinterruptwait},
-\helpref{wxSocketServer::WaitForAccept}{wxsocketserverwaitforaccept},
-\helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost},
+\helpref{wxSocketBase::InterruptWait}{wxsocketbaseinterruptwait}, 
+\helpref{wxSocketServer::WaitForAccept}{wxsocketserverwaitforaccept}, 
+\helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost}, 

 \helpref{wxSocketBase::WaitForRead}{wxsocketbasewaitforread}, 
 \helpref{wxSocketBase::WaitForRead}{wxsocketbasewaitforread}, 

-\helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite},
+\helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite}, 

 \helpref{wxSocketClient::WaitOnConnect}{wxsocketclientwaitonconnect}
 
 %
 \helpref{wxSocketClient::WaitOnConnect}{wxsocketclientwaitonconnect}
 
 %


@@ -904,7 +913,7 @@ Returns TRUE if the socket becomes readable, FALSE on timeout.
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxSocketBase::InterruptWait}{wxsocketbaseinterruptwait},
+\helpref{wxSocketBase::InterruptWait}{wxsocketbaseinterruptwait}, 

 \helpref{wxSocketBase::Wait}{wxsocketbasewait}
 
 %
 \helpref{wxSocketBase::Wait}{wxsocketbasewait}
 
 %


@@ -934,7 +943,7 @@ Returns TRUE if the socket becomes writable, FALSE on timeout.
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxSocketBase::InterruptWait}{wxsocketbaseinterruptwait},
+\helpref{wxSocketBase::InterruptWait}{wxsocketbaseinterruptwait}, 

 \helpref{wxSocketBase::Wait}{wxsocketbasewait}
 
 %
 \helpref{wxSocketBase::Wait}{wxsocketbasewait}
 
 %


@@ -980,8 +989,8 @@ of flags being used. For a detailed explanation, see \helpref{wxSocketBase::SetF
 \func{wxSocketBase\&}{WriteMsg}{\param{const void *}{ buffer}, \param{wxUint32}{ nbytes}}
 
 This function writes a buffer of {\it nbytes} bytes from the socket, but it
 \func{wxSocketBase\&}{WriteMsg}{\param{const void *}{ buffer}, \param{wxUint32}{ nbytes}}
 
 This function writes a buffer of {\it nbytes} bytes from the socket, but it

-writes a short header before so that \helpref{ReadMsg}{wxsocketbasereadmsg}
-knows how much data should it actually read. So, a buffer sent with WriteMsg
+writes a short header before so that \helpref{ReadMsg}{wxsocketbasereadmsg} 
+knows how much data should it actually read. So, a buffer sent with WriteMsg 

 {\bf must} be read with ReadMsg. This function always waits for the entire
 buffer to be sent, unless an error occurs.
 
 {\bf must} be read with ReadMsg. This function always waits for the entire
 buffer to be sent, unless an error occurs.
 


@@ -1029,6 +1038,8 @@ For a detailed explanation, see \helpref{wxSocketBase::SetFlags}{wxsocketbaseset
 
 <wx/socket.h>
 
 
 <wx/socket.h>
 

+\latexignore{\rtfignore{\wxheading{Members}}}
+

 % ---------------------------------------------------------------------------
 % Members
 % ---------------------------------------------------------------------------
 % ---------------------------------------------------------------------------
 % Members
 % ---------------------------------------------------------------------------


@@ -1037,7 +1048,7 @@ For a detailed explanation, see \helpref{wxSocketBase::SetFlags}{wxsocketbaseset
 %
 \membersection{wxSocketClient::wxSocketClient}
 
 %
 \membersection{wxSocketClient::wxSocketClient}
 

-\func{}{wxSocketClient}{\param{wxSocketFlags}{ flags = wxSOCKET_NONE}}
+\func{}{wxSocketClient}{\param{wxSocketFlags}{ flags = wxSOCKET\_NONE}}

 
 Constructor.
 
 
 Constructor.
 


@@ -1052,7 +1063,7 @@ Constructor.
 
 \func{}{\destruct{wxSocketClient}}{\void}
 
 
 \func{}{\destruct{wxSocketClient}}{\void}
 

-Destructor.
+Destructor. Please see \helpref{wxSocketBase::Destroy}{wxsocketbasedestroy}.

 
 %
 % Connect
 
 %
 % Connect


@@ -1063,8 +1074,8 @@ Destructor.
 
 Connects to a server using the specified address.
 
 
 Connects to a server using the specified address.
 

-If {\it wait} is TRUE, Connect will wait until the connection completes.
-{\bf Warning:} This will block the GUI.
+If {\it wait} is TRUE, Connect will wait until the connection
+completes. {\bf Warning:} This will block the GUI.

 
 If {\it wait} is FALSE, Connect will try to establish the connection and
 return immediately, without blocking the GUI. When used this way, even if
 
 If {\it wait} is FALSE, Connect will try to establish the connection and
 return immediately, without blocking the GUI. When used this way, even if


@@ -1083,13 +1094,13 @@ and {\bf wxSOCKET\_LOST} events (for connection failure).
 
 Returns TRUE if the connection is established and no error occurs.
 
 
 Returns TRUE if the connection is established and no error occurs.
 

-If {\it wait} was TRUE, and Connect returns FALSE, an error occured
+If {\it wait} was TRUE, and Connect returns FALSE, an error occurred

 and the connection failed.
 
 If {\it wait} was FALSE, and Connect returns FALSE, you should still
 be prepared to handle the completion of this connection request, either
 and the connection failed.
 
 If {\it wait} was FALSE, and Connect returns FALSE, you should still
 be prepared to handle the completion of this connection request, either

-with \helpref{WaitOnConnect}{wxsocketclientwaitonconnect} or by watching
-{\bf wxSOCKET\_CONNECTION} and {\bf wxSOCKET\_LOST} events.
+with \helpref{WaitOnConnect}{wxsocketclientwaitonconnect} or by
+watching {\bf wxSOCKET\_CONNECTION} and {\bf wxSOCKET\_LOST} events.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -1105,8 +1116,8 @@ with \helpref{WaitOnConnect}{wxsocketclientwaitonconnect} or by watching
 \func{bool}{WaitOnConnect}{\param{long}{ seconds = -1}, \param{long}{ milliseconds = 0}}
 
 Wait until a connection request completes, or until the specified timeout
 \func{bool}{WaitOnConnect}{\param{long}{ seconds = -1}, \param{long}{ milliseconds = 0}}
 
 Wait until a connection request completes, or until the specified timeout

-elapses. Use this function after issuing a call to \helpref{Connect}{wxsocketclientconnect}
-with {\it wait} set to FALSE.
+elapses. Use this function after issuing a call
+to \helpref{Connect}{wxsocketclientconnect} with {\it wait} set to FALSE.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 


@@ -1120,7 +1131,7 @@ as set with \helpref{SetTimeout}{wxsocketbasesettimeout}.}
 
 WaitOnConnect returns TRUE if the connection request completes. This
 does not necessarily mean that the connection was succesfully established;
 
 WaitOnConnect returns TRUE if the connection request completes. This
 does not necessarily mean that the connection was succesfully established;

-it might also happen that the connection was refused by the peer. Use
+it might also happen that the connection was refused by the peer. Use 

 \helpref{IsConnected}{wxsocketbaseisconnected} to distinguish between
 these two situations.
 
 \helpref{IsConnected}{wxsocketbaseisconnected} to distinguish between
 these two situations.
 


@@ -1137,15 +1148,15 @@ bool waitmore = TRUE;
 while ( !client->WaitOnConnect(seconds, millis) && waitmore )
 {
     // possibly give some feedback to the user,
 while ( !client->WaitOnConnect(seconds, millis) && waitmore )
 {
     // possibly give some feedback to the user,

-    // and update waitmore if needed.
+    // and update waitmore as needed.

 }
 bool success = client->IsConnected();
 \end{verbatim}
 
 \wxheading{See also}
 
 }
 bool success = client->IsConnected();
 \end{verbatim}
 
 \wxheading{See also}
 

-\helpref{wxSocketClient::Connect}{wxsocketclientconnect},
-\helpref{wxSocketBase::InterruptWait}{wxsocketbaseinterruptwait},
+\helpref{wxSocketClient::Connect}{wxsocketclientconnect}, 
+\helpref{wxSocketBase::InterruptWait}{wxsocketbaseinterruptwait}, 

 \helpref{wxSocketBase::IsConnected}{wxsocketbaseisconnected}
 
 % ---------------------------------------------------------------------------
 \helpref{wxSocketBase::IsConnected}{wxsocketbaseisconnected}
 
 % ---------------------------------------------------------------------------


@@ -1165,8 +1176,8 @@ This event class contains information about socket events.
 
 \wxheading{Event table macros}
 
 
 \wxheading{Event table macros}
 

-To process a socket event, use these event handler macros to direct input to member
-functions that take a wxSocketEvent argument.
+To process a socket event, use these event handler macros to direct input
+to member functions that take a wxSocketEvent argument.

 
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt
 
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt


@@ -1230,10 +1241,10 @@ Returns the socket event type.
 %
 \membersection{wxSocketServer::wxSocketServer}\label{wxsocketserverconstr}
 
 %
 \membersection{wxSocketServer::wxSocketServer}\label{wxsocketserverconstr}
 

-\func{}{wxSocketServer}{\param{wxSockAddress\&}{ address}, \param{wxSocketFlags}{ flags = wxSOCKET_NONE}}
+\func{}{wxSocketServer}{\param{wxSockAddress\&}{ address}, \param{wxSocketFlags}{ flags = wxSOCKET\_NONE}}

 
 Constructs a new server and tries to bind to the specified {\it address}.
 
 Constructs a new server and tries to bind to the specified {\it address}.

-Before trying to accept new connections, test whether it succeeded with
+Before trying to accept new connections, test whether it succeeded with 

 \helpref{wxSocketBase::Ok}{wxsocketbaseok}.
 
 \wxheading{Parameters}
 \helpref{wxSocketBase::Ok}{wxsocketbaseok}.
 
 \wxheading{Parameters}


@@ -1258,24 +1269,24 @@ Destructor (it doesn't close the accepted connections).
 
 \func{wxSocketBase *}{Accept}{\param{bool}{ wait = TRUE}}
 
 
 \func{wxSocketBase *}{Accept}{\param{bool}{ wait = TRUE}}
 

-Accepts an incoming connection request, and creates a new
+Accepts an incoming connection request, and creates a new 

 \helpref{wxSocketBase}{wxsocketbase} object which represents
 the server-side of the connection.
 
 If {\it wait} is TRUE and there are no pending connections to be
 \helpref{wxSocketBase}{wxsocketbase} object which represents
 the server-side of the connection.
 
 If {\it wait} is TRUE and there are no pending connections to be

-accepted, it will wait for the next incoming connection to arrive.
-{\bf Warning:} This will block the GUI.
+accepted, it will wait for the next incoming connection to
+arrive. {\bf Warning:} This will block the GUI.

 
 If {\it wait} is FALSE, it will try to accept a pending connection
 if there is one, but it will always return immediately without blocking
 the GUI. If you want to use Accept in this way, you can either check for
 
 If {\it wait} is FALSE, it will try to accept a pending connection
 if there is one, but it will always return immediately without blocking
 the GUI. If you want to use Accept in this way, you can either check for

-incoming connections with \helpref{WaitForAccept}{wxsocketserverwaitforaccept}
+incoming connections with \helpref{WaitForAccept}{wxsocketserverwaitforaccept} 

 or catch {\bf wxSOCKET\_CONNECTION} events, then call Accept once you know
 that there is an incoming connection waiting to be accepted.
 
 \wxheading{Return value}
 
 or catch {\bf wxSOCKET\_CONNECTION} events, then call Accept once you know
 that there is an incoming connection waiting to be accepted.
 
 \wxheading{Return value}
 

-Returns an opened socket connection, or NULL if an error occured or
+Returns an opened socket connection, or NULL if an error occurred or

 if the {\it wait} parameter was FALSE and there were no pending
 connections.
 
 if the {\it wait} parameter was FALSE and there were no pending
 connections.
 


@@ -1301,14 +1312,14 @@ Accept an incoming connection using the specified socket object.
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-Returns TRUE on success, or FALSE if an error occured or if the
+Returns TRUE on success, or FALSE if an error occurred or if the

 {\it wait} parameter was FALSE and there were no pending
 connections.
 
 \helpref{wxSocketServer::WaitForAccept}{wxsocketserverwaitforaccept}, 
 \helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify}, 
 \helpref{wxSocketBase::Notify}{wxsocketbasenotify}, 
 {\it wait} parameter was FALSE and there were no pending
 connections.
 
 \helpref{wxSocketServer::WaitForAccept}{wxsocketserverwaitforaccept}, 
 \helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify}, 
 \helpref{wxSocketBase::Notify}{wxsocketbasenotify}, 

-\helpref{wxSocketServer::Accept}{wxsocketserveraccept} for a detailed explanation
+\helpref{wxSocketServer::Accept}{wxsocketserveraccept}

 
 %
 % WaitForAccept
 
 %
 % WaitForAccept


@@ -1317,8 +1328,8 @@ connections.
 
 \func{bool}{WaitForAccept}{\param{long}{ seconds = -1}, \param{long}{ millisecond = 0}}
 
 
 \func{bool}{WaitForAccept}{\param{long}{ seconds = -1}, \param{long}{ millisecond = 0}}
 

-This function waits for an incoming connection. Use it if you want to call
-\helpref{Accept}{wxsocketserveraccept} or \helpref{AcceptWith}{wxsocketserveracceptwith}
+This function waits for an incoming connection. Use it if you want to call 
+\helpref{Accept}{wxsocketserveraccept} or \helpref{AcceptWith}{wxsocketserveracceptwith} 

 with {\it wait} set to FALSE, to detect when an incoming connection is waiting
 to be accepted.
 
 with {\it wait} set to FALSE, to detect when an incoming connection is waiting
 to be accepted.