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

Some doc proofreading

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@6718 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Julian Smart
2000-03-15 00:21:49 +00:00
parent 8cb9f0d0f8
commit fa482912e4
96 changed files with 559 additions and 486 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -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
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.
@@ -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
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
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
@@ -93,7 +93,7 @@ handler macro to direct events to member functions that take a
\helpref{wxSocketEvent}{wxsocketevent},
\helpref{wxSocketClient}{wxsocketclient},
\helpref{wxSocketServer}{wxsocketserver},
\helpref{wxSocketServer}{wxsocketserver},
\helpref{Sockets sample}{samplesockets}
% ---------------------------------------------------------------------------
@@ -189,8 +189,8 @@ releases of wxWindows.
\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}
@@ -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
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:
@@ -328,7 +328,7 @@ following calls: Discard, Peek, Read, ReadMsg, Unread, Write, WriteMsg.
\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}
%
@@ -385,11 +385,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.
\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}
%
@@ -512,10 +512,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},
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
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.
@@ -533,7 +533,7 @@ Calls to SaveState and RestoreState can be nested.
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}
\helpref{wxSocketEvent::GetClientData}{wxsocketeventgetclientdata}
function.
%
@@ -545,7 +545,7 @@ function.
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}
@@ -559,7 +559,7 @@ enabled with \helpref{SetNotify}{wxsocketbasesetnotify} and
\helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify},
\helpref{wxSocketBase::Notify}{wxsocketbasenotify},
\helpref{wxSocketEvent}{wxsocketevent},
\helpref{wxEvtHandler}{wxevthandler},
\helpref{wxEvtHandler}{wxevthandler}
%
% SetFlags
@@ -663,7 +663,7 @@ 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
applies to all IO calls, and also to the \helpref{Wait}{wxsocketbasewait}
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.
@@ -745,7 +745,7 @@ of flags being used. For a detailed explanation, see \helpref{wxSocketBase::SetF
\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.
@@ -843,11 +843,11 @@ FALSE if the timeout was reached.
\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::WaitForWrite}{wxsocketbasewaitforwrite},
\helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite},
\helpref{wxSocketClient::WaitOnConnect}{wxsocketclientwaitonconnect}
%
@@ -904,7 +904,7 @@ Returns TRUE if the socket becomes readable, FALSE on timeout.
\wxheading{See also}
\helpref{wxSocketBase::InterruptWait}{wxsocketbaseinterruptwait},
\helpref{wxSocketBase::InterruptWait}{wxsocketbaseinterruptwait},
\helpref{wxSocketBase::Wait}{wxsocketbasewait}
%
@@ -934,7 +934,7 @@ Returns TRUE if the socket becomes writable, FALSE on timeout.
\wxheading{See also}
\helpref{wxSocketBase::InterruptWait}{wxsocketbaseinterruptwait},
\helpref{wxSocketBase::InterruptWait}{wxsocketbaseinterruptwait},
\helpref{wxSocketBase::Wait}{wxsocketbasewait}
%
@@ -980,8 +980,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
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.
@@ -1029,6 +1029,8 @@ For a detailed explanation, see \helpref{wxSocketBase::SetFlags}{wxsocketbaseset
<wx/socket.h>
\latexignore{\rtfignore{\wxheading{Members}}}
% ---------------------------------------------------------------------------
% Members
% ---------------------------------------------------------------------------
@@ -1088,7 +1090,7 @@ 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
with \helpref{WaitOnConnect}{wxsocketclientwaitonconnect} or by watching
{\bf wxSOCKET\_CONNECTION} and {\bf wxSOCKET\_LOST} events.
\wxheading{See also}
@@ -1120,7 +1122,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;
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.
@@ -1144,8 +1146,8 @@ bool success = client->IsConnected();
\wxheading{See also}
\helpref{wxSocketClient::Connect}{wxsocketclientconnect},
\helpref{wxSocketBase::InterruptWait}{wxsocketbaseinterruptwait},
\helpref{wxSocketClient::Connect}{wxsocketclientconnect},
\helpref{wxSocketBase::InterruptWait}{wxsocketbaseinterruptwait},
\helpref{wxSocketBase::IsConnected}{wxsocketbaseisconnected}
% ---------------------------------------------------------------------------
@@ -1233,7 +1235,7 @@ Returns the socket event type.
\func{}{wxSocketServer}{\param{wxSockAddress\&}{ address}, \param{wxSocketFlags}{ flags = wxSOCKET_NONE}}
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}
@@ -1258,7 +1260,7 @@ Destructor (it doesn't close the accepted connections).
\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.
@@ -1269,7 +1271,7 @@ accepted, it will wait for the next incoming connection to arrive.
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.
@@ -1317,8 +1319,8 @@ connections.
\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.