Some doc corrections; removed wxDocument arg from wxView constructor;

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

diff --git a/docs/latex/wx/socket.tex b/docs/latex/wx/socket.tex
index b2800c1fbe700ae4f439fd34a211a8a7302ffd38..49a59bb2275f5e27e089d1668bbc471114ee2270 100644 (file)
--- a/docs/latex/wx/socket.tex
+++ b/docs/latex/wx/socket.tex
@@ -4,6 +4,10 @@
 
 \helpref{wxEvtHandler}{wxevthandler}
 
 
 \helpref{wxEvtHandler}{wxevthandler}
 

+\wxheading{Include files}
+
+<wx/socket.h>
+

 % ---------------------------------------------------------------------------
 % Event handling
 % ---------------------------------------------------------------------------
 % ---------------------------------------------------------------------------
 % Event handling
 % ---------------------------------------------------------------------------


@@ -13,7 +17,7 @@ To process events from a socket, use the following event handler macro to direct
  input to member
 functions that take a \helpref{wxSocketEvent}{wxsocketevent} argument.
 
  input to member
 functions that take a \helpref{wxSocketEvent}{wxsocketevent} argument.
 

-\twocolwidtha{7cm}
+\twocolwidtha{7cm}%

 \begin{twocollist}\itemsep=0pt
 \twocolitem{{\bf EVT\_SOCKET(id, func)}}{A socket event occured.}
 \end{twocollist}%
 \begin{twocollist}\itemsep=0pt
 \twocolitem{{\bf EVT\_SOCKET(id, func)}}{A socket event occured.}
 \end{twocollist}%


@@ -21,20 +25,19 @@ functions that take a \helpref{wxSocketEvent}{wxsocketevent} argument.
 % ---------------------------------------------------------------------------
 % See also ...
 % ---------------------------------------------------------------------------
 % ---------------------------------------------------------------------------
 % See also ...
 % ---------------------------------------------------------------------------

-

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

-\helpref{wxSocketEvent}{wxsocketevent}
-\helpref{wxSocketClient}{wxsocketclient}
+\helpref{wxSocketEvent}{wxsocketevent}\\
+\helpref{wxSocketClient}{wxsocketclient}\\

 \helpref{wxSocketServer}{wxsocketserver}
 
 % ---------------------------------------------------------------------------
 % Members
 % ---------------------------------------------------------------------------
 \helpref{wxSocketServer}{wxsocketserver}
 
 % ---------------------------------------------------------------------------
 % Members
 % ---------------------------------------------------------------------------

-

 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxSocketBase::wxSocketBase}
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxSocketBase::wxSocketBase}

+

 \func{}{wxSocketBase}{\void}
 
 Default constructor but don't use it, you must use \helpref{wxSocketClient}{wxsocketclient}
 \func{}{wxSocketBase}{\void}
 
 Default constructor but don't use it, you must use \helpref{wxSocketClient}{wxsocketclient}


@@ -69,7 +72,7 @@ Returns TRUE if an error occured.
 
 Returns TRUE if the socket is connected.
 
 
 Returns TRUE if the socket is connected.
 

-\membersection{wxSocketBase::IsData}\label{wxsocketbaseerror}
+\membersection{wxSocketBase::IsData}\label{wxsocketbaseisdata}

 
 \constfunc{bool}{IsData}{\void}
 
 
 \constfunc{bool}{IsData}{\void}
 


@@ -102,11 +105,9 @@ Returns an error in the errno format (see your C programmer's guide).
 % ---------------------------------------------------------------------------
 % IO calls
 % ---------------------------------------------------------------------------
 % ---------------------------------------------------------------------------
 % IO calls
 % ---------------------------------------------------------------------------

-

 %
 % Peek
 %
 %
 % Peek
 %

-

 \membersection{wxSocketBase::Peek}\label{wxsocketbasepeek}
 
 \func{wxSocketBase\&}{Peek}{\param{char *}{ buffer}, \param{size\_t}{ nbytes}}
 \membersection{wxSocketBase::Peek}\label{wxsocketbasepeek}
 
 \func{wxSocketBase\&}{Peek}{\param{char *}{ buffer}, \param{size\_t}{ nbytes}}


@@ -117,21 +118,22 @@ doesn't delete it from the system socket in-queue.
 \wxheading{Parameters}
 
 \docparam{buffer}{Buffer where to put peeked data.}
 \wxheading{Parameters}
 
 \docparam{buffer}{Buffer where to put peeked data.}

+

 \docparam{nbytes}{Number of bytes.}
 
 \docparam{nbytes}{Number of bytes.}
 

-\wxheading{Returns value}
+\wxheading{Return value}
+

 Returns a reference to the current object.
 
 \wxheading{See also}
 
 Returns a reference to the current object.
 
 \wxheading{See also}
 

-\helpref{wxSocketBase::Error}{wxsocketbaserror},
-\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
+\helpref{wxSocketBase::Error}{wxsocketbaseerror}\\
+\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount}\\

 \helpref{wxSocketBase::LastError}{wxsocketbaselasterror}
 
 %
 % Read
 %
 \helpref{wxSocketBase::LastError}{wxsocketbaselasterror}
 
 %
 % Read
 %

-

 \membersection{wxSocketBase::Read}\label{wxsocketbaseread}
 
 \func{wxSocketBase\&}{Read}{\param{char *}{ buffer}, \param{size\_t}{ nbytes}}
 \membersection{wxSocketBase::Read}\label{wxsocketbaseread}
 
 \func{wxSocketBase\&}{Read}{\param{char *}{ buffer}, \param{size\_t}{ nbytes}}


@@ -141,45 +143,85 @@ This function reads a buffer of {\it nbytes} bytes from the socket.
 \wxheading{Parameters}
 
 \docparam{buffer}{Buffer where to put read data.}
 \wxheading{Parameters}
 
 \docparam{buffer}{Buffer where to put read data.}

+

 \docparam{nbytes}{Number of bytes.}
 
 \docparam{nbytes}{Number of bytes.}
 

-\wxheading{Returns value}
+\wxheading{Return value}
+

 Returns a reference to the current object.
 
 Returns a reference to the current object.
 

+\wxheading{Remark/Warning}
+
+By default, Read uses an internal asynchronous manager: it will send data when
+the socket requests them. It is particularly interesting when you enter a long
+data transfer (e.g. a big file, an image, ...). But it is also buggy when you
+simply discuss with the peer using user data. In this case, wxSocket prepares
+itself to send data (Write wait for them to be sent) and during a GUI refresh
+the user enters new data, which involves a new Read call though the previous
+isn't finished. Well, in most cases it can work but it might fail too.
+So I advise you to use the SPEED flag, which disables the asynchronous manager,
+when you just want to discuss with the peer.
+
+This remark is also valid for all IO call.
+

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

-\helpref{wxSocketBase::Error}{wxsocketbaserror},
-\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
-\helpref{wxSocketBase::LastError}{wxsocketbaselasterror}
+\helpref{wxSocketBase::Error}{wxsocketbaseerror},
+ \helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
+ \helpref{wxSocketBase::LastError}{wxsocketbaselasterror}

  
  

+\membersection{wxSocketBase::SetFlags}\label{wxsocketbasesetflags}
+
+\func{void}{SetFlags}{\param{wxSockFlags}{ flags}}
+
+\twocolwidtha{7cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\bf wxSocketBase::NONE}}{Normal functionnalities.}
+\twocolitem{{\bf wxSocketBase::NOWAIT}}{Get the available data in the input queue and exit immediately.}
+\twocolitem{{\bf wxSocketBase::WAITALL}}{Wait for all required data unless an error occured.}
+\twocolitem{{\bf wxSocketBase::SPEED}}{Disable the asynchronous IO functionnality.}
+\end{twocollist}
+

 %
 % Read
 %
 %
 % Read
 %

-

 \membersection{wxSocketBase::Write}\label{wxsocketbasewrite}
 
 \func{wxSocketBase\&}{Write}{\param{const char *}{ buffer}, \param{size\_t}{ nbytes}}
 
 This function writes a buffer of {\it nbytes} bytes from the socket.
 
 \membersection{wxSocketBase::Write}\label{wxsocketbasewrite}
 
 \func{wxSocketBase\&}{Write}{\param{const char *}{ buffer}, \param{size\_t}{ nbytes}}
 
 This function writes a buffer of {\it nbytes} bytes from the socket.
 

+\wxheading{Remark/Warning}
+
+By default, Write uses an internal asynchronous manager: it will send data when
+the socket requests them. It is particularly interesting when you enter a long
+data transfer (e.g. a big file, an image, ...). But it is also buggy when you
+simply discuss with the peer using user data. In this case, wxSocket prepares
+itself to send data (Write wait for them to be sent) and during a GUI refresh
+the user enters new data, which involves a new Write call though the previous
+isn't finished. Well, in most cases it can work but it might fail too.  
+So I advise you to use the SPEED flag, which disables the asynchronous manager,
+when you just want to discuss with the peer.
+

 \wxheading{Parameters}
 
 \docparam{buffer}{Buffer where to get the data to write.}
 \wxheading{Parameters}
 
 \docparam{buffer}{Buffer where to get the data to write.}

+

 \docparam{nbytes}{Number of bytes.}
 
 \docparam{nbytes}{Number of bytes.}
 

-\wxheading{Returns value}
+\wxheading{Return value}
+

 Returns a reference to the current object.
 
 \wxheading{See also}
 
 Returns a reference to the current object.
 
 \wxheading{See also}
 

-\helpref{wxSocketBase::Error}{wxsocketbaserror},
-\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
+\helpref{wxSocketBase::Error}{wxsocketbaseerror}\\
+\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount}\\

 \helpref{wxSocketBase::LastError}{wxsocketbaselasterror}
 
 %
 % WriteMsg
 %
 \helpref{wxSocketBase::LastError}{wxsocketbaselasterror}
 
 %
 % WriteMsg
 %

-

 \membersection{wxSocketBase::WriteMsg}\label{wxsocketbasewritemsg}
 
 \func{wxSocketBase\&}{WriteMsg}{\param{const char *}{ buffer}, \param{size\_t}{ nbytes}}
 \membersection{wxSocketBase::WriteMsg}\label{wxsocketbasewritemsg}
 
 \func{wxSocketBase\&}{WriteMsg}{\param{const char *}{ buffer}, \param{size\_t}{ nbytes}}


@@ -191,22 +233,23 @@ the buffer. So a buffer sent with WriteMsg {\bf must} be read with ReadMsg.
 \wxheading{Parameters}
 
 \docparam{buffer}{Buffer where to put data peeked.}
 \wxheading{Parameters}
 
 \docparam{buffer}{Buffer where to put data peeked.}

+

 \docparam{nbytes}{Number of bytes.}
 
 \docparam{nbytes}{Number of bytes.}
 

-\wxheading{Returns value}
+\wxheading{Return value}
+

 Returns a reference to the current object.
 
 \wxheading{See also}
 
 Returns a reference to the current object.
 
 \wxheading{See also}
 

-\helpref{wxSocketBase::Error}{wxsocketbaserror},
-\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
-\helpref{wxSocketBase::LastError}{wxsocketbaselasterror},
+\helpref{wxSocketBase::Error}{wxsocketbaseerror}\\
+\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount}\\
+\helpref{wxSocketBase::LastError}{wxsocketbaselasterror}\\

 \helpref{wxSocketBase::ReadMsg}{wxsocketbasereadmsg}
 
 %
 % ReadMsg
 %
 \helpref{wxSocketBase::ReadMsg}{wxsocketbasereadmsg}
 
 %
 % ReadMsg
 %

-

 \membersection{wxSocketBase::ReadMsg}\label{wxsocketbasereadmsg}
 
 \func{wxSocketBase\&}{ReadMsg}{\param{char *}{ buffer}, \param{size\_t}{ nbytes}}
 \membersection{wxSocketBase::ReadMsg}\label{wxsocketbasereadmsg}
 
 \func{wxSocketBase\&}{ReadMsg}{\param{char *}{ buffer}, \param{size\_t}{ nbytes}}


@@ -218,22 +261,23 @@ bytes left. This function always wait for the buffer to be entirely filled.
 \wxheading{Parameters}
 
 \docparam{buffer}{Buffer where to put read data.}
 \wxheading{Parameters}
 
 \docparam{buffer}{Buffer where to put read data.}

+

 \docparam{nbytes}{Number of bytes allocated for the buffer.}
 
 \docparam{nbytes}{Number of bytes allocated for the buffer.}
 

-\wxheading{Returns value}
+\wxheading{Return value}
+

 Returns a reference to the current object.
 
 \wxheading{See also}
 
 Returns a reference to the current object.
 
 \wxheading{See also}
 

-\helpref{wxSocketBase::Error}{wxsocketbaserror},
-\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
-\helpref{wxSocketBase::LastError}{wxsocketbaselasterror},
+\helpref{wxSocketBase::Error}{wxsocketbaseerror}\\
+\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount}\\
+\helpref{wxSocketBase::LastError}{wxsocketbaselasterror}\\

 \helpref{wxSocketBase::WriteMsg}{wxsocketbasewritemsg}
 
 %
 % Unread
 %
 \helpref{wxSocketBase::WriteMsg}{wxsocketbasewritemsg}
 
 %
 % Unread
 %

-

 \membersection{wxSocketBase::UnRead}\label{wxsocketbaseunread}
 
 \func{wxSocketBase\&}{UnRead}{\param{const char *}{ buffer}, \param{size\_t}{ nbytes}}
 \membersection{wxSocketBase::UnRead}\label{wxsocketbaseunread}
 
 \func{wxSocketBase\&}{UnRead}{\param{const char *}{ buffer}, \param{size\_t}{ nbytes}}


@@ -245,21 +289,22 @@ It is useful for sockets because we can't seek it.
 \wxheading{Parameters}
 
 \docparam{buffer}{Buffer to be unread.}
 \wxheading{Parameters}
 
 \docparam{buffer}{Buffer to be unread.}

+

 \docparam{nbytes}{Number of bytes.}
 
 \docparam{nbytes}{Number of bytes.}
 

-\wxheading{Returns value}
+\wxheading{Return value}
+

 Returns a reference to the current object.
 
 \wxheading{See also}
 
 Returns a reference to the current object.
 
 \wxheading{See also}
 

-\helpref{wxSocketBase::Error}{wxsocketbaserror},
-\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
+\helpref{wxSocketBase::Error}{wxsocketbaseerror}\\
+\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount}\\

 \helpref{wxSocketBase::LastError}{wxsocketbaselasterror}
 
 %
 % Discard
 %
 \helpref{wxSocketBase::LastError}{wxsocketbaselasterror}
 
 %
 % Discard
 %

-

 \membersection{wxSocketBase::Discard}\label{wxsocketbasediscard}
 
 \func{wxSocketBase\&}{Discard}{\void}
 \membersection{wxSocketBase::Discard}\label{wxsocketbasediscard}
 
 \func{wxSocketBase\&}{Discard}{\void}


@@ -271,6 +316,7 @@ doesn't wait.
 % Wait functions
 % ---------------------------------------------------------------------------
 \membersection{wxSocketBase::Wait}\label{wxsocketbasewait}
 % Wait functions
 % ---------------------------------------------------------------------------
 \membersection{wxSocketBase::Wait}\label{wxsocketbasewait}

+

 \func{bool}{Wait}{\param{long}{ seconds = -1}, \param{long}{ microsecond = 0}}
 
 This function waits for an event: it could be an incoming byte, the possibility
 \func{bool}{Wait}{\param{long}{ seconds = -1}, \param{long}{ microsecond = 0}}
 
 This function waits for an event: it could be an incoming byte, the possibility


@@ -280,23 +326,24 @@ established connection.
 \wxheading{Parameters}
 
 \docparam{seconds}{Number of seconds to wait. By default, it waits infinitely.}
 \wxheading{Parameters}
 
 \docparam{seconds}{Number of seconds to wait. By default, it waits infinitely.}

+

 \docparam{microsecond}{Number of microseconds to wait.}
 
 \docparam{microsecond}{Number of microseconds to wait.}
 

-\wxheading{Return value:}
+\wxheading{Return value}

 
 Returns TRUE if an event occured, FALSE if the timeout was reached.
 
 \wxheading{See also}
 
 
 Returns TRUE if an event occured, FALSE if the timeout was reached.
 
 \wxheading{See also}
 

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

 \helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost}
 
 %
 % WaitForRead
 %
 \helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost}
 
 %
 % WaitForRead
 %

-

 \membersection{wxSocketBase::WaitForRead}\label{wxsocketbasewaitforread}
 \membersection{wxSocketBase::WaitForRead}\label{wxsocketbasewaitforread}

+

 \func{bool}{WaitForRead}{\param{long}{ seconds = -1}, \param{long}{ microsecond = 0}}
 
 This function waits for a read event.
 \func{bool}{WaitForRead}{\param{long}{ seconds = -1}, \param{long}{ microsecond = 0}}
 
 This function waits for a read event.


@@ -304,23 +351,24 @@ This function waits for a read event.
 \wxheading{Parameters}
 
 \docparam{seconds}{Number of seconds to wait. By default, it waits infinitely.}
 \wxheading{Parameters}
 
 \docparam{seconds}{Number of seconds to wait. By default, it waits infinitely.}

+

 \docparam{microsecond}{Number of microseconds to wait.}
 
 \docparam{microsecond}{Number of microseconds to wait.}
 

-\wxheading{Return value:}
+\wxheading{Return value}

 
 Returns TRUE if a byte arrived, FALSE if the timeout was reached.
 
 \wxheading{See also}
 
 
 Returns TRUE if a byte arrived, FALSE if the timeout was reached.
 
 \wxheading{See also}
 

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

 \helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost}
 
 %
 % WaitForWrite
 %
 \helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost}
 
 %
 % WaitForWrite
 %

-

 \membersection{wxSocketBase::WaitForWrite}\label{wxsocketbasewaitforwrite}
 \membersection{wxSocketBase::WaitForWrite}\label{wxsocketbasewaitforwrite}

+

 \func{bool}{WaitForWrite}{\param{long}{ seconds = -1}, \param{long}{ microsecond = 0}}
 
 This function waits for a write event.
 \func{bool}{WaitForWrite}{\param{long}{ seconds = -1}, \param{long}{ microsecond = 0}}
 
 This function waits for a write event.


@@ -328,23 +376,24 @@ This function waits for a write event.
 \wxheading{Parameters}
 
 \docparam{seconds}{Number of seconds to wait. By default, it waits infinitely.}
 \wxheading{Parameters}
 
 \docparam{seconds}{Number of seconds to wait. By default, it waits infinitely.}

+

 \docparam{microsecond}{Number of microseconds to wait.}
 
 \docparam{microsecond}{Number of microseconds to wait.}
 

-\wxheading{Return value:}
+\wxheading{Return value}

 
 Returns TRUE if a write event occured, FALSE if the timeout was reached.
 
 \wxheading{See also}
 
 
 Returns TRUE if a write event occured, FALSE if the timeout was reached.
 
 \wxheading{See also}
 

-\helpref{wxSocketBase::Wait}{wxsocketbasewait},
-\helpref{wxSocketBase::WaitForRead}{wxsocketbasewaitforread},
+\helpref{wxSocketBase::Wait}{wxsocketbasewait}\\
+\helpref{wxSocketBase::WaitForRead}{wxsocketbasewaitforread}\\

 \helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost}
 
 %
 % WaitForLost
 %
 \helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost}
 
 %
 % WaitForLost
 %

-

 \membersection{wxSocketBase::WaitForLost}\label{wxsocketbasewaitforlost}
 \membersection{wxSocketBase::WaitForLost}\label{wxsocketbasewaitforlost}

+

 \func{bool}{Wait}{\param{long}{ seconds = -1}, \param{long}{ microsecond = 0}}
 
 This function waits for a "lost" event. For instance, the peer may have closed
 \func{bool}{Wait}{\param{long}{ seconds = -1}, \param{long}{ microsecond = 0}}
 
 This function waits for a "lost" event. For instance, the peer may have closed


@@ -353,26 +402,40 @@ the connection, or the connection may have been broken.
 \wxheading{Parameters}
 
 \docparam{seconds}{Number of seconds to wait. By default, it waits infinitely.}
 \wxheading{Parameters}
 
 \docparam{seconds}{Number of seconds to wait. By default, it waits infinitely.}

+

 \docparam{microsecond}{Number of microseconds to wait.}
 
 \docparam{microsecond}{Number of microseconds to wait.}
 

-\wxheading{Return value:}
+\wxheading{Return value}

 
 Returns TRUE if a "lost" event occured, FALSE if the timeout was reached.
 
 \wxheading{See also}
 
 
 Returns TRUE if a "lost" event occured, FALSE if the timeout was reached.
 
 \wxheading{See also}
 

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

 \helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost}
 
 \helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost}
 

+%
+% RestoreState
+%
+\membersection{wxSocketBase::RestoreState}\label{wxsocketbaserestorestate}
+
+\func{void}{RestoreState}{\void}
+
+This function restores a previously saved state.
+
+\wxheading{See also}
+
+\helpref{wxSocketBase::SaveState}{wxsocketbasesavestate}
+

 % ---------------------------------------------------------------------------
 % Socket state
 % ---------------------------------------------------------------------------
 % ---------------------------------------------------------------------------
 % Socket state
 % ---------------------------------------------------------------------------

-

 %
 % SaveState
 %
 \membersection{wxSocketBase::SaveState}\label{wxsocketbasesavestate}
 %
 % SaveState
 %
 \membersection{wxSocketBase::SaveState}\label{wxsocketbasesavestate}

+

 \func{void}{SaveState}{\void}
 
 This function saves the current state of the socket object in a stack:
 \func{void}{SaveState}{\void}
 
 This function saves the current state of the socket object in a stack:


@@ -382,25 +445,11 @@ actually it saves all flags and the state of the asynchronous callbacks.
 
 \helpref{wxSocketBase::RestoreState}{wxsocketbaserestorestate}
 
 
 \helpref{wxSocketBase::RestoreState}{wxsocketbaserestorestate}
 

-%
-% RestoreState
-%
-
-\membersection{wxSocketBase::RestoreState}\label{wxsocketbaserestorestate}
-
-\func{void}{RestoreState}{\void}
-
-This function restores a previously saved state.
-
-\wxheading{See also}
-
-\helpref{wxSocketBase::SaveState}{wxsocketbasesavestate}
-

 % ---------------------------------------------------------------------------
 % Socket callbacks
 % ---------------------------------------------------------------------------
 % ---------------------------------------------------------------------------
 % Socket callbacks
 % ---------------------------------------------------------------------------

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

 
 

-\membersection{wxSocketBase::SetEventHandler}{wxsocketbaseseteventhandler}

 \func{void}{SetEventHandler}{\param{wxEvtHandler\&}{ evt\_hdlr}, \param{int}{ id = -1}}
 
 Sets an event handler to be called when a socket event occured.
 \func{void}{SetEventHandler}{\param{wxEvtHandler\&}{ evt\_hdlr}, \param{int}{ id = -1}}
 
 Sets an event handler to be called when a socket event occured.


@@ -408,6 +457,7 @@ Sets an event handler to be called when a socket event occured.
 \wxheading{Parameters}
 
 \docparam{evt\_hdlr}{Specifies the event handler you want to use.}
 \wxheading{Parameters}
 
 \docparam{evt\_hdlr}{Specifies the event handler you want to use.}

+

 \docparam{id}{The id of socket event.}
 
 \wxheading{See also}
 \docparam{id}{The id of socket event.}
 
 \wxheading{See also}


@@ -417,26 +467,29 @@ Sets an event handler to be called when a socket event occured.
 % ---------------------------------------------------------------------------
 % CLASS wxSocketClient
 % ---------------------------------------------------------------------------
 % ---------------------------------------------------------------------------
 % CLASS wxSocketClient
 % ---------------------------------------------------------------------------

-

 \section{\class{wxSocketClient}}\label{wxsocketclient}
 
 \wxheading{Derived from}
 
 \helpref{wxSocketBase}{wxsocketbase}
 
 \section{\class{wxSocketClient}}\label{wxsocketclient}
 
 \wxheading{Derived from}
 
 \helpref{wxSocketBase}{wxsocketbase}
 

+\wxheading{Include files}
+
+<wx/socket.h>
+

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

-

 %
 % wxSocketClient
 %
 %
 % wxSocketClient
 %

-

 \membersection{wxSocketClient::wxSocketClient}
 \membersection{wxSocketClient::wxSocketClient}

+

 \func{}{wxSocketClient}{\param{wxSockFlags}{ flags = wxSocketBase::NONE}}
 
 Constructs a new wxSocketClient.
 \func{}{wxSocketClient}{\param{wxSockFlags}{ flags = wxSocketBase::NONE}}
 
 Constructs a new wxSocketClient.

-{\bf Warning !} The created needs to be registered to a socket handler (See \helpref{wxSocketHandler}{wxsockethandler}).
+
+{\bf Warning !} The new socket client needs to be registered to a socket handler (See \helpref{wxSocketHandler}{wxsockethandler}).

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 


@@ -445,17 +498,17 @@ Constructs a new wxSocketClient.
 %
 % ~wxSocketClient
 %
 %
 % ~wxSocketClient
 %

-

 \membersection{wxSocketClient::\destruct{wxSocketClient}}
 \membersection{wxSocketClient::\destruct{wxSocketClient}}

+

 \func{}{\destruct{wxSocketClient}}{\void}
 
 \func{}{\destruct{wxSocketClient}}{\void}
 

-Destructs a wxSocketClient object.
+Destroys a wxSocketClient object.

 
 %
 % Connect
 %
 
 %
 % Connect
 %

+\membersection{wxSocketClient::Connect}\label{wxsocketclientconnect}

 
 

-\membersection{wxSocketClient::Connect}{wxsocketclientconnect}

 \func{bool}{Connect}{\param{wxSockAddress\&}{ address}, \param{bool}{ wait = TRUE}}
 
 Connects to a server using the specified address. If {\it wait} is TRUE, Connect
 \func{bool}{Connect}{\param{wxSockAddress\&}{ address}, \param{bool}{ wait = TRUE}}
 
 Connects to a server using the specified address. If {\it wait} is TRUE, Connect


@@ -464,6 +517,7 @@ will wait for the socket ready to send or receive data.
 \wxheading{Parameters}
 
 \docparam{address}{Address of the server.}
 \wxheading{Parameters}
 
 \docparam{address}{Address of the server.}

+

 \docparam{wait}{If true, waits for the connection to be ready.}
 
 \wxheading{Return value}
 \docparam{wait}{If true, waits for the connection to be ready.}
 
 \wxheading{Return value}


@@ -477,8 +531,8 @@ Returns TRUE if the connection is established and no error occurs.
 %
 % WaitOnConnect
 %
 %
 % WaitOnConnect
 %

+\membersection{wxSocketClient::WaitOnConnect}\label{wxsocketclientwaitonconnect}

 
 

-\membersection{wxSocketClient::WaitOnConnect}

 \func{bool}{WaitOnConnect}{\param{long}{ seconds = -1}, \param{long}{ microseconds = 0}}
 
 Wait for a "connect" event.
 \func{bool}{WaitOnConnect}{\param{long}{ seconds = -1}, \param{long}{ microseconds = 0}}
 
 Wait for a "connect" event.


@@ -488,124 +542,96 @@ Wait for a "connect" event.
 \helpref{wxSocketBase::Wait}{wxsocketbasewait} for a detailed description.
 
 % ---------------------------------------------------------------------------
 \helpref{wxSocketBase::Wait}{wxsocketbasewait} for a detailed description.
 
 % ---------------------------------------------------------------------------

-% CLASS: wxSocketServer
+% CLASS: wxSocketEvent

 % ---------------------------------------------------------------------------
 % ---------------------------------------------------------------------------

+\section{\class{wxSocketEvent}}\label{wxsocketevent}

 
 

-\section{\class{wxSocketServer}}\label{wxsocketserver}
+This event class contains information about socket events.

 
 \wxheading{Derived from}
 
 
 \wxheading{Derived from}
 

-\helpref{wxSocketBase}{wxsocketbase}
+\helpref{wxEvent}{wxevent}

 
 

-% ---------------------------------------------------------------------------
-% Members
-% ---------------------------------------------------------------------------
-
-\latexignore{\rtfignore{\wxheading{Members}}}
-
-%
-% wxSocketServer
-%
+\wxheading{Include files}

 
 

-\membersection{wxSocketServer::wxSocketServer}{wxsocketserverconstr}
-\func{}{wxSocketServer}{\param{wxSockAddress\&}{ address}, \param{wxSockFlags}{ flags = wxSocketBase::NONE}}
-
-Constructs a new wxSocketServer.
-{\bf Warning !} The created object needs to be registered to a socket handler
-(See \helpref{wxSocketHandler}{wxsockethandler}).
-
-\wxheading{Parameters}
-
-\docparam{address}{Specifies the local address for the server (e.g. port number).}
-\docparam{flags}{Socket flags (See \helpref{wxSocketBase::SetFlags}{wxsocketbase
-setflags})}
+<wx/socket.h>

 
 

-%
-% ~wxSocketServer
-%
-
-\membersection{wxSocketServer::\destruct{wxSocketServer}}
-\func{}{\destruct{wxSocketServer}}{\void}
-
-Destructs a wxSocketServer object (it doesn't close the accepted connection).
-
-%
-% Accept
-%
-
-\membersection{wxSocketServer::Accept}
-\func{wxSocketBase *}{Accept}{\void}
-
-Creates a new object wxSocketBase and accepts an incoming connection. {\bf Warning !} This function will block the GUI.
+\wxheading{Event table macros}

 
 

-\wxheading{Return value}
+To process a socket event, use these event handler macros to direct input to member
+functions that take a wxSocketEvent argument.

 
 

-Returns an opened socket connection.
+\twocolwidtha{7cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\bf EVT\_SOCKET(id, func)}}{Process a socket event, supplying the member function.}
+\end{twocollist}%

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

-\helpref{wxSocketServer::AcceptWith}{wxsocketserveracceptwith}
-
-%
-% AcceptWith
-%
+\helpref{wxSocketHandler}{wxsockethandler},\rtfsp
+\helpref{wxSocketBase}{wxsocketbase},\rtfsp
+\helpref{wxSocketClient}{wxsocketclient},\rtfsp
+\helpref{wxSocketServer}{wxsocketserver}

 
 

-\membersection{wxSocketServer::AcceptWith}{wxsocketserveracceptwith}
-\func{bool}{AcceptWith}{\param{wxSocketBase\&}{ socket}}
+\latexignore{\rtfignore{\wxheading{Members}}}

 
 

-Accept an incoming connection using the specified socket object.
-This is useful when someone wants to inherit wxSocketBase.
+\membersection{wxSocketEvent::wxSocketEvent}

 
 

-\wxheading{Parameters}
+\func{}{wxSocketEvent}{\param{int}{ id = 0}}

 
 

-\docparam{socket}{Socket to be initialized}
+Constructor.

 
 

-\wxheading{Return value}
+\membersection{wxSocketEvent::SocketEvent}\label{wxsocketeventsocketevent}

 
 

-Returns TRUE if no error occurs, else FALSE.
+\constfunc{wxSocketBase::wxRequestEvent}{SocketEvent}{\void}

 
 

+Returns the socket event type.

 
 % ---------------------------------------------------------------------------
 % CLASS: wxSocketHandler
 % ---------------------------------------------------------------------------
 
 % ---------------------------------------------------------------------------
 % CLASS: wxSocketHandler
 % ---------------------------------------------------------------------------

-

 \section{\class{wxSocketHandler}}\label{wxsockethandler}
 
 \wxheading{Derived from}
 
 \helpref{wxObject}{wxobject}
 
 \section{\class{wxSocketHandler}}\label{wxsockethandler}
 
 \wxheading{Derived from}
 
 \helpref{wxObject}{wxobject}
 

+\wxheading{Include files}
+
+<wx/socket.h>
+

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

-

 \latexignore{\rtfignore{\wxheading{Members}}}
 
 %
 % wxSocketHandler
 %
 \membersection{wxSocketHandler::wxSocketHandler}
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 %
 % wxSocketHandler
 %
 \membersection{wxSocketHandler::wxSocketHandler}

+

 \func{}{wxSocketHandler}{\void}
 
 Constructs a new wxSocketHandler.
 \func{}{wxSocketHandler}{\void}
 
 Constructs a new wxSocketHandler.

-It is advised to use \helpref{wxSocketHandler::Master}{wxsockethandlermaster}
-to get a socket handler. But creating a socket handler is useful to group
+
+It is advised to use \helpref{wxSocketHandler::Master}{wxsockethandlermaster} to
+get a socket handler. But creating a socket handler is useful to group

 many sockets.
 
 %
 % ~wxSocketHandler
 %
 many sockets.
 
 %
 % ~wxSocketHandler
 %

-

 \membersection{wxSocketHandler::\destruct{wxSocketHandler}}
 \membersection{wxSocketHandler::\destruct{wxSocketHandler}}

+

 \func{}{\destruct{wxSocketHandler}}{\void}
 
 \func{}{\destruct{wxSocketHandler}}{\void}
 

-Destructs a wxSocketHandler object.
+Destroys a wxSocketHandler object.

 
 %
 % Register
 %
 
 %
 % Register
 %

-

 \membersection{wxSocketHandler::Register}
 \membersection{wxSocketHandler::Register}

+

 \func{void}{Register}{\param{wxSocketBase *}{socket}}
 
 Register a socket: if it is already registered in this handler it will just
 \func{void}{Register}{\param{wxSocketBase *}{socket}}
 
 Register a socket: if it is already registered in this handler it will just


@@ -618,8 +644,8 @@ return immediately.
 %
 % UnRegister
 %
 %
 % UnRegister
 %

-

 \membersection{wxSocketHandler::UnRegister}
 \membersection{wxSocketHandler::UnRegister}

+

 \func{void}{UnRegister}{\param{wxSocketBase *}{socket}}
 
 UnRegister a socket: if it isn't registered in this handler it will just
 \func{void}{UnRegister}{\param{wxSocketBase *}{socket}}
 
 UnRegister a socket: if it isn't registered in this handler it will just


@@ -632,8 +658,8 @@ return.
 %
 % Count
 %
 %
 % Count
 %

-

 \membersection{wxSocketHandler::Count}
 \membersection{wxSocketHandler::Count}

+

 \constfunc{unsigned long}{Count}{\void}
 
 Returns the number of sockets registered in the handler.
 \constfunc{unsigned long}{Count}{\void}
 
 Returns the number of sockets registered in the handler.


@@ -645,8 +671,8 @@ Number of sockets registered.
 %
 % CreateServer
 %
 %
 % CreateServer
 %

-

 \membersection{wxSocketHandler::CreateServer}
 \membersection{wxSocketHandler::CreateServer}

+

 \func{wxSocketServer *}{CreateServer}{\param{wxSockAddress\&}{ address}, \param{wxSocketBase::wxSockFlags}{ flags = wxSocketbase::NONE}}
 
 Creates a new wxSocketServer object. The object is automatically registered
 \func{wxSocketServer *}{CreateServer}{\param{wxSockAddress\&}{ address}, \param{wxSocketBase::wxSockFlags}{ flags = wxSocketbase::NONE}}
 
 Creates a new wxSocketServer object. The object is automatically registered


@@ -660,12 +686,13 @@ Returns a new socket server.
 %
 % CreateClient
 %
 %
 % CreateClient
 %

-

 \membersection{wxSocketHandler::CreateClient}
 \membersection{wxSocketHandler::CreateClient}

+

 \func{wxSocketServer *}{CreateClient}{\param{wxSocketBase::wxSockFlags}{ flags = wxSocketbase::NONE}}
 
 Creates a new wxSocketClient object. The object is automatically registered
 to the current socket handler.
 \func{wxSocketServer *}{CreateClient}{\param{wxSocketBase::wxSockFlags}{ flags = wxSocketbase::NONE}}
 
 Creates a new wxSocketClient object. The object is automatically registered
 to the current socket handler.

+

 For a detailed description of the parameters, see \helpref{wxSocketClient::Connect}{wxsocketclientconnect}.
 
 \wxheading{Return value}
 For a detailed description of the parameters, see \helpref{wxSocketClient::Connect}{wxsocketclientconnect}.
 
 \wxheading{Return value}


@@ -675,8 +702,121 @@ Returns a new socket client.
 %
 % Master
 %
 %
 % Master
 %

+\membersection{wxSocketHandler::Master}\label{wxsockethandlermaster}

 
 

-\membersection{wxSocketHandler::Master}

 \func{static wxSocketHandler\&}{Master}{\void}
 
 Returns a default socket handler.
 \func{static wxSocketHandler\&}{Master}{\void}
 
 Returns a default socket handler.

+
+%
+% Wait
+%
+\membersection{wxSocketHandler::Wait}
+
+\func{int}{Wait}{\param{long}{ seconds},\param{long}{ microseconds}}
+
+Wait for an event on all registered sockets.
+
+\wxheading{Parameters}
+
+\docparam{seconds}{Number of seconds to wait. By default, it waits infinitely.}
+
+\docparam{microsecond}{Number of microseconds to wait.}
+
+\wxheading{Return value}
+
+Returns 0 if a timeout occured, else the number of events detected.
+
+\wxheading{See also}
+
+\helpref{wxSocketBase::Wait}{wxsocketbasewait}
+
+%
+% YieldSock
+%
+\membersection{wxSocketHandler::YieldSock}
+
+\func{void}{YieldSock}{\void}
+
+Execute pending requests in all registered sockets.
+
+% ---------------------------------------------------------------------------
+% CLASS: wxSocketServer
+% ---------------------------------------------------------------------------
+\section{\class{wxSocketServer}}\label{wxsocketserver}
+
+\wxheading{Derived from}
+
+\helpref{wxSocketBase}{wxsocketbase}
+
+\wxheading{Include files}
+
+<wx/socket.h>
+
+% ---------------------------------------------------------------------------
+% Members
+% ---------------------------------------------------------------------------
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+%
+% wxSocketServer
+%
+\membersection{wxSocketServer::wxSocketServer}\label{wxsocketserverconstr}
+
+\func{}{wxSocketServer}{\param{wxSockAddress\&}{ address}, \param{wxSockFlags}{ flags = wxSocketBase::NONE}}
+
+Constructs a new wxSocketServer.
+
+{\bf Warning !} The created object needs to be registered to a socket handler
+(see \helpref{wxSocketHandler}{wxsockethandler}).
+
+\wxheading{Parameters}
+
+\docparam{address}{Specifies the local address for the server (e.g. port number).}
+
+\docparam{flags}{Socket flags (See \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags})}
+
+%
+% ~wxSocketServer
+%
+\membersection{wxSocketServer::\destruct{wxSocketServer}}
+
+\func{}{\destruct{wxSocketServer}}{\void}
+
+Destroys a wxSocketServer object (it doesn't close the accepted connection).
+
+%
+% Accept
+%
+\membersection{wxSocketServer::Accept}
+
+\func{wxSocketBase *}{Accept}{\void}
+
+Creates a new object wxSocketBase and accepts an incoming connection. {\bf Warning !} This function will block the GUI.
+
+\wxheading{Return value}
+
+Returns an opened socket connection.
+
+\wxheading{See also}
+
+\helpref{wxSocketServer::AcceptWith}{wxsocketserveracceptwith}
+
+%
+% AcceptWith
+%
+\membersection{wxSocketServer::AcceptWith}\label{wxsocketserveracceptwith}
+
+\func{bool}{AcceptWith}{\param{wxSocketBase\&}{ socket}}
+
+Accept an incoming connection using the specified socket object.
+This is useful when someone wants to inherit wxSocketBase.
+
+\wxheading{Parameters}
+
+\docparam{socket}{Socket to be initialized}
+
+\wxheading{Return value}
+
+Returns TRUE if no error occurs, else FALSE.
+