git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@5227
c3d73ce0-8a6f-49c7-b76d-
6d57e0e08775
"blocking" here refers to when the function returns, not to whether
the GUI blocks during this time.
"blocking" here refers to when the function returns, not to whether
the GUI blocks during this time.
-The {\bf wxSOCKET\_BLOCK} controls whether the GUI blocks during IO
-operations. If this flag is not used, then the application must take
+The {\bf wxSOCKET\_BLOCK} flag controls whether the GUI blocks during
+IO operations. If this flag is not used, then the application must take
extra care to avoid unwanted reentrance.
So:
extra care to avoid unwanted reentrance.
So:
the data.
{\bf wxSOCKET\_BLOCK} has nothing to do with the previous flags and
the data.
{\bf wxSOCKET\_BLOCK} has nothing to do with the previous flags and
-it control whether the GUI blocks.
+it controls whether the GUI blocks.
-\membersection{wxSocketBase::SetTimeout}{wxsocketbasesettimeout}
+\membersection{wxSocketBase::SetTimeout}\label{wxsocketbasesettimeout}
\func{void}{SetTimeout}{\param{int }{seconds}}
\func{void}{SetTimeout}{\param{int }{seconds}}
wxSocketBase::ReadMsg() will behave as if the wxSOCKET\_WAITALL flag was always set
and it will always ignore the wxSOCKET\_NOWAIT flag. The exact behaviour of ReadMsg
wxSocketBase::ReadMsg() will behave as if the wxSOCKET\_WAITALL flag was always set
and it will always ignore the wxSOCKET\_NOWAIT flag. The exact behaviour of ReadMsg
-depends on the wxSOCKET\_SPEED flag. For a detailed explanation, see \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags}.
+depends on the wxSOCKET\_BLOCK flag. For a detailed explanation, see \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags}.
This function simply deletes all bytes in the incoming queue. This function
doesn't wait. That is, it will behave as if the wxSOCKET\_NOWAIT flag was set. The
This function simply deletes all bytes in the incoming queue. This function
doesn't wait. That is, it will behave as if the wxSOCKET\_NOWAIT flag was set. The
-wxSOCKET\_SPEED and wxSOCKET\_WAITALL flags have no effect on this function.
+wxSOCKET\_BLOCK and wxSOCKET\_WAITALL flags have no effect on this function.
Use LastCount to see the number of bytes discarded.
Use LastCount to see the number of bytes discarded.
\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:
-actually it saves all flags (those set with SetFlags, SetNotify, Notfy)
+actually it saves all flags (those set with SetFlags, SetNotify, Notify)
and the state of the asynchronous callbacks (Callback, CallbackData).
Calls to SaveState / RestoreState can be nested.
and the state of the asynchronous callbacks (Callback, CallbackData).
Calls to SaveState / RestoreState can be nested.
\twocolitem{{\bf EVT\_SOCKET(id, func)}}{Process a socket event, supplying the member function.}
\end{twocollist}%
\twocolitem{{\bf EVT\_SOCKET(id, func)}}{Process a socket event, supplying the member function.}
\end{twocollist}%
-[TODO:]
-A brief note on how to use events.
-The wxSOCKET\_INPUT event is generated when the
-
\wxheading{See also}
\helpref{wxSocketBase}{wxsocketbase},
\wxheading{See also}
\helpref{wxSocketBase}{wxsocketbase},
\helpref{wxSocketServer::WaitForAccept}{wxsocketserverwaitforaccept},
\helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify},
\helpref{wxSocketBase::Notify}{wxsocketbasenotify},
\helpref{wxSocketServer::WaitForAccept}{wxsocketserverwaitforaccept},
\helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify},
\helpref{wxSocketBase::Notify}{wxsocketbasenotify},
-\helpref{wxSocketServer::Accept}{wxsocketserveraccept}
+\helpref{wxSocketServer::Accept}{wxsocketserveraccept} for a detailed explanation