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

Updated to reflect some of the latest changes

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@6518 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Guillermo Rodriguez Garcia
2000-03-08 08:29:16 +00:00
parent 6bf783984a
commit 061379e2ac
1 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -612,7 +612,7 @@ default is set to 10 minutes.
% %
\membersection{wxSocketBase::Peek}\label{wxsocketbasepeek} \membersection{wxSocketBase::Peek}\label{wxsocketbasepeek}
\func{wxSocketBase\&}{Peek}{\param{char *}{ buffer}, \param{wxUint32}{ nbytes}} \func{wxSocketBase\&}{Peek}{\param{void *}{ buffer}, \param{wxUint32}{ nbytes}}
This function peeks a buffer of {\it nbytes} bytes from the socket. This function peeks a buffer of {\it nbytes} bytes from the socket.
Peeking a buffer doesn't delete it from the socket input queue. Peeking a buffer doesn't delete it from the socket input queue.
@@ -648,7 +648,7 @@ of flags being used. For a detailed explanation, see \helpref{wxSocketBase::SetF
% %
\membersection{wxSocketBase::Read}\label{wxsocketbaseread} \membersection{wxSocketBase::Read}\label{wxsocketbaseread}
\func{wxSocketBase\&}{Read}{\param{char *}{ buffer}, \param{wxUint32}{ nbytes}} \func{wxSocketBase\&}{Read}{\param{void *}{ buffer}, \param{wxUint32}{ nbytes}}
This function reads a buffer of {\it nbytes} bytes from the socket. This function reads a buffer of {\it nbytes} bytes from the socket.
@@ -683,7 +683,7 @@ of flags being used. For a detailed explanation, see \helpref{wxSocketBase::SetF
% %
\membersection{wxSocketBase::ReadMsg}\label{wxsocketbasereadmsg} \membersection{wxSocketBase::ReadMsg}\label{wxsocketbasereadmsg}
\func{wxSocketBase\&}{ReadMsg}{\param{char *}{ 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 on a socket. If the buffer passed to the function isn't big enough, the
@@ -724,7 +724,7 @@ For a detailed explanation, see \helpref{wxSocketBase::SetFlags}{wxsocketbaseset
% %
\membersection{wxSocketBase::Unread}\label{wxsocketbaseunread} \membersection{wxSocketBase::Unread}\label{wxsocketbaseunread}
\func{wxSocketBase\&}{Unread}{\param{const char *}{ buffer}, \param{wxUint32}{ nbytes}} \func{wxSocketBase\&}{Unread}{\param{const void *}{ buffer}, \param{wxUint32}{ nbytes}}
This function unreads a buffer. That is, the data in the buffer is put back This function unreads a buffer. That is, the data in the buffer is put back
in the incoming queue. This function is not affected by wxSocket flags. in the incoming queue. This function is not affected by wxSocket flags.
@@ -882,7 +882,7 @@ Returns TRUE if the connection was lost, FALSE if the timeout was reached.
% %
\membersection{wxSocketBase::Write}\label{wxsocketbasewrite} \membersection{wxSocketBase::Write}\label{wxsocketbasewrite}
\func{wxSocketBase\&}{Write}{\param{const char *}{ buffer}, \param{wxUint32}{ nbytes}} \func{wxSocketBase\&}{Write}{\param{const void *}{ buffer}, \param{wxUint32}{ nbytes}}
This function writes a buffer of {\it nbytes} bytes to the socket. This function writes a buffer of {\it nbytes} bytes to the socket.
@@ -917,7 +917,7 @@ of flags being used. For a detailed explanation, see \helpref{wxSocketBase::SetF
% %
\membersection{wxSocketBase::WriteMsg}\label{wxsocketbasewritemsg} \membersection{wxSocketBase::WriteMsg}\label{wxsocketbasewritemsg}
\func{wxSocketBase\&}{WriteMsg}{\param{const char *}{ buffer}, \param{wxUint32}{ nbytes}} \func{wxSocketBase\&}{WriteMsg}{\param{const void *}{ buffer}, \param{wxUint32}{ nbytes}}
This function writes a buffer of {\it nbytes} bytes from the socket, but it This function writes a buffer of {\it nbytes} bytes from the socket, but it
writes a short header before so that \helpref{ReadMsg}{wxsocketbasereadmsg} writes a short header before so that \helpref{ReadMsg}{wxsocketbasereadmsg}
@@ -1126,16 +1126,16 @@ functions that take a wxSocketEvent argument.
Constructor. Constructor.
\membersection{wxSocketEvent::Socket}\label{wxsocketeventsocket} \membersection{wxSocketEvent::GetSocket}\label{wxsocketeventgetsocket}
\constfunc{wxSocketBase *}{Socket}{\void} \constfunc{wxSocketBase *}{GetSocket}{\void}
Returns the socket object to which this event refers to. This makes Returns the socket object to which this event refers to. This makes
it possible to use the same event handler for different sockets. it possible to use the same event handler for different sockets.
\membersection{wxSocketEvent::SocketEvent}\label{wxsocketeventsocketevent} \membersection{wxSocketEvent::GetSocketEvent}\label{wxsocketeventgetsocketevent}
\constfunc{wxSocketNotify}{SocketEvent}{\void} \constfunc{wxSocketNotify}{GetSocketEvent}{\void}
Returns the socket event type. Returns the socket event type.