Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

* Added some warning in socket doc.

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@1688 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Guilhem Lavaux
1999-02-12 18:31:00 +00:00
parent 503d5ba994
commit 9f3430a6d4
1 changed files with 58 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

88
docs/latex/wx/socket.tex
View File

@@ -23,7 +23,9 @@ functions that take a \helpref{wxSocketEvent}{wxsocketevent} argument.
% --------------------------------------------------------------------------- % ---------------------------------------------------------------------------
\wxheading{See also} \wxheading{See also}
\helpref{wxSocketEvent}{wxsocketevent}, \helpref{wxSocketClient}{wxsocketclient}, \helpref{wxSocketServer}{wxsocketserver} \helpref{wxSocketEvent}{wxsocketevent}\\
\helpref{wxSocketClient}{wxsocketclient}\\
\helpref{wxSocketServer}{wxsocketserver}
% --------------------------------------------------------------------------- % ---------------------------------------------------------------------------
% Members % Members
@@ -121,9 +123,9 @@ Returns a reference to the current object.
\wxheading{See also} \wxheading{See also}
\helpref{wxSocketBase::Error}{wxsocketbaseerror}, \helpref{wxSocketBase::Error}{wxsocketbaseerror}\\
\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount}, \helpref{wxSocketBase::LastCount}{wxsocketbaselastcount}\\
\helpref{wxSocketBase::LastError}{wxsocketbaselasterror} \helpref{wxSocketBase::LastError}{wxsocketbaselasterror}
% %
% Read % Read
@@ -144,6 +146,20 @@ This function reads a buffer of {\it nbytes} bytes from the socket.
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}{wxsocketbaseerror}, \helpref{wxSocketBase::Error}{wxsocketbaseerror},
@@ -171,6 +187,18 @@ Returns a reference to the current object.
This function writes a buffer of {\it nbytes} bytes from the socket. 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} \wxheading{Parameters}
\docparam{buffer}{Buffer where to get the data to write.} \docparam{buffer}{Buffer where to get the data to write.}
@@ -183,9 +211,9 @@ Returns a reference to the current object.
\wxheading{See also} \wxheading{See also}
\helpref{wxSocketBase::Error}{wxsocketbaseerror}, \helpref{wxSocketBase::Error}{wxsocketbaseerror}\\
\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount}, \helpref{wxSocketBase::LastCount}{wxsocketbaselastcount}\\
\helpref{wxSocketBase::LastError}{wxsocketbaselasterror} \helpref{wxSocketBase::LastError}{wxsocketbaselasterror}
% %
% WriteMsg % WriteMsg
@@ -210,10 +238,10 @@ Returns a reference to the current object.
\wxheading{See also} \wxheading{See also}
\helpref{wxSocketBase::Error}{wxsocketbaseerror}, \helpref{wxSocketBase::Error}{wxsocketbaseerror}\\
\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount}, \helpref{wxSocketBase::LastCount}{wxsocketbaselastcount}\\
\helpref{wxSocketBase::LastError}{wxsocketbaselasterror}, \helpref{wxSocketBase::LastError}{wxsocketbaselasterror}\\
\helpref{wxSocketBase::ReadMsg}{wxsocketbasereadmsg} \helpref{wxSocketBase::ReadMsg}{wxsocketbasereadmsg}
% %
% ReadMsg % ReadMsg
@@ -238,10 +266,10 @@ Returns a reference to the current object.
\wxheading{See also} \wxheading{See also}
\helpref{wxSocketBase::Error}{wxsocketbaseerror}, \helpref{wxSocketBase::Error}{wxsocketbaseerror}\\
\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount}, \helpref{wxSocketBase::LastCount}{wxsocketbaselastcount}\\
\helpref{wxSocketBase::LastError}{wxsocketbaselasterror}, \helpref{wxSocketBase::LastError}{wxsocketbaselasterror}\\
\helpref{wxSocketBase::WriteMsg}{wxsocketbasewritemsg} \helpref{wxSocketBase::WriteMsg}{wxsocketbasewritemsg}
% %
% Unread % Unread
@@ -266,9 +294,9 @@ Returns a reference to the current object.
\wxheading{See also} \wxheading{See also}
\helpref{wxSocketBase::Error}{wxsocketbaseerror}, \helpref{wxSocketBase::Error}{wxsocketbaseerror}\\
\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount}, \helpref{wxSocketBase::LastCount}{wxsocketbaselastcount}\\
\helpref{wxSocketBase::LastError}{wxsocketbaselasterror} \helpref{wxSocketBase::LastError}{wxsocketbaselasterror}
% %
% Discard % Discard
@@ -303,9 +331,9 @@ Returns TRUE if an event occured, FALSE if the timeout was reached.
\wxheading{See also} \wxheading{See also}
\helpref{wxSocketBase::WaitForRead}{wxsocketbasewaitforread}, \helpref{wxSocketBase::WaitForRead}{wxsocketbasewaitforread}\\
\helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite}, \helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite}\\
\helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost} \helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost}
% %
% WaitForRead % WaitForRead
@@ -328,9 +356,9 @@ Returns TRUE if a byte arrived, FALSE if the timeout was reached.
\wxheading{See also} \wxheading{See also}
\helpref{wxSocketBase::Wait}{wxsocketbasewait}, \helpref{wxSocketBase::Wait}{wxsocketbasewait}\\
\helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite}, \helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite}\\
\helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost} \helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost}
% %
% WaitForWrite % WaitForWrite
@@ -353,9 +381,9 @@ Returns TRUE if a write event occured, FALSE if the timeout was reached.
\wxheading{See also} \wxheading{See also}
\helpref{wxSocketBase::Wait}{wxsocketbasewait}, \helpref{wxSocketBase::Wait}{wxsocketbasewait}\\
\helpref{wxSocketBase::WaitForRead}{wxsocketbasewaitforread}, \helpref{wxSocketBase::WaitForRead}{wxsocketbasewaitforread}\\
\helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost} \helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost}
% %
% WaitForLost % WaitForLost
@@ -379,9 +407,9 @@ Returns TRUE if a "lost" event occured, FALSE if the timeout was reached.
\wxheading{See also} \wxheading{See also}
\helpref{wxSocketBase::WaitForRead}{wxsocketbasewaitforread}, \helpref{wxSocketBase::WaitForRead}{wxsocketbasewaitforread}\\
\helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite}, \helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite}\\
\helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost} \helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost}
% %
% RestoreState % RestoreState