From: Guilhem Lavaux <lavaux@easynet.fr>
Date: Wed, 30 Sep 1998 17:45:29 +0000 (+0000)
Subject: * wxSocket doc updates.
X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/b80dc5febe0017218e62726b52e32ee418eaa7e3

* wxSocket doc updates.


git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@790 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---

diff --git a/docs/latex/wx/sckaddr.tex b/docs/latex/wx/sckaddr.tex
new file mode 100644
index 0000000000..9c04a74b01
--- /dev/null
+++ b/docs/latex/wx/sckaddr.tex
@@ -0,0 +1,155 @@
+% ----------------------------------------------------------------------------
+% CLASS: wxSockAddress
+% ----------------------------------------------------------------------------
+\section{\class{wxSockAddress}}\label{wxsockaddress}
+
+\wxheading{Derived from}
+
+\helpref{wxObject}{wxobject}
+
+{\bf Actually, you don't have to use these functions: only wxSocketBase use it.}
+
+\wxheading{See also}
+
+\helpref{wxSocketBase}{wxsocketbase}\\
+\helpref{wxIPV4address}{wxipv4address}\\
+\helpref{wxIPV6address}{wxipv6address}\\
+\helpref{wxunixaddress}{wxunixaddress}
+
+% ----------------------------------------------------------------------------
+% Members
+% ----------------------------------------------------------------------------
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+%
+% ctor/dtor
+%
+
+\membersection{wxSockAddress::wxSockAddress}
+\func{}{wxSockAddress}{\void}
+
+Default constructor.
+
+\membersection{wxSockAddress::\destruct{wxSockAddress}}
+\func{}{\destruct{wxSockAddress}}{\void}
+
+Default destructor.
+
+%
+% Clear
+%
+\membersection{wxSockAddress::Clear}
+\func{void}{Clear}{\void}
+
+Delete all informations about the address.
+
+%
+% Build
+%
+\membersection{wxSockAddress::Build}
+\func{void}{Build}{\param{struct sockaddr *\&}{ addr}, \param{size\_t\&}{ len}}
+
+Build a coded socket address.
+
+%
+% Disassemble
+%
+\membersection{wxSockAddress::Disassemble}
+\func{void}{Disassemble}{\param{struct sockaddr *}{addr}, \param{size\_t}{ len}}
+
+Decode a socket address. {\bf Actually, you don't have to use this
+function: only wxSocketBase use it.}
+
+%
+% SockAddrLen
+%
+\membersection{wxSockAddress::SockAddrLen}
+\func{int}{SockAddrLen}{\void};
+
+Returns the length of the socket address.
+
+% ----------------------------------------------------------------------------
+% CLASS: wxIPV4address
+% ----------------------------------------------------------------------------
+\section{\class{wxIPV4address}}\label{wxipv4address}
+
+\wxheading{Derived from}
+
+\helpref{wxSockAddress}{wxsockaddress}
+
+% ----------------------------------------------------------------------------
+% MEMBERS
+% ----------------------------------------------------------------------------
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+%
+% Hostname
+%
+
+\membersection{wxIPV4address::Hostname}
+\func{bool}{Hostname}{\param{const wxString\&}{ hostname}}
+
+Use the specified {\it hostname} for the address.
+
+\wxheading{Return value}
+
+Returns FALSE if something bad happens (invalid hostname, invalid IP address). 
+
+%
+% Hostname
+%
+
+\membersection{wxIPV4address::Hostname}
+\func{wxString}{Hostname}{\void}
+
+Returns the hostname which matches the IP address.
+
+%
+% Service
+%
+
+\membersection{wxIPV4address::Service}
+\func{bool}{Service}{\param{const wxString\&}{ service}}
+
+Use the specified {\it service} string for the address.
+
+\wxheading{Return value}
+
+Returns FALSE if something bad happens (invalid service).
+
+%
+% Service
+%
+
+\membersection{wxIPV4address::Service}
+\func{bool}{Service}{\param{unsigned short}{ service}}
+
+Use the specified {\it service} for the address.
+
+\wxheading{Return value}
+
+Returns FALSE if something bad happens (invalid service).
+
+%
+% Service
+%
+
+\membersection{wxIPV4address::Service}
+\func{unsigned short}{Service}{\void}
+
+Returns the current service.
+
+%
+% LocalHost
+%
+
+\membersection{wxIPV4address::LocalHost}
+\func{bool}{LocalHost}{\void}
+
+Initialize peer host to local host.
+
+\wxheading{Return value}
+
+Returns FALSE if something bad happens.
diff --git a/docs/latex/wx/socket.tex b/docs/latex/wx/socket.tex
index b2800c1fbe..18c8ddc249 100644
--- a/docs/latex/wx/socket.tex
+++ b/docs/latex/wx/socket.tex
@@ -680,3 +680,32 @@ Returns a new socket client.
 \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}{wxsockebasewait}
+
+%
+% YieldSock
+%
+\membersection{wxSocketHandler::YieldSock}
+\func{void}{YieldSock}{\void}
+
+Execute pending requests in all registered sockets.