]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/socksrv.tex
Added wxDataViewTreeCtrl
[wxWidgets.git] / docs / latex / wx / socksrv.tex
index 29bb083b2c182a588d8241ec82f65443fc950723..06dd9ec98d5198329154dc6049576854ce895de9 100644 (file)
@@ -5,7 +5,7 @@
 %% Modified by:
 %% Created:     14.01.02 (extracted from socket.tex)
 %% RCS-ID:      $Id$
-%% Copyright:   (c) wxWindows team
+%% Copyright:   (c) wxWidgets team
 %% License:     wxWindows license
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 
 \wxheading{Derived from}
 
-\helpref{wxSocketBase}{wxsocketbase}
+\helpref{wxSocketBase}{wxsocketbase}\\
+\helpref{wxObject}{wxobject}
 
 \wxheading{Include files}
 
 <wx/socket.h>
 
+\wxheading{Library}
+
+\helpref{wxNet}{librarieslist}
+
 % ---------------------------------------------------------------------------
 % Members
 % ---------------------------------------------------------------------------
 %
 % wxSocketServer
 %
-\membersection{wxSocketServer::wxSocketServer}\label{wxsocketserverconstr}
+\membersection{wxSocketServer::wxSocketServer}\label{wxsocketserverctor}
 
-\func{}{wxSocketServer}{\param{wxSockAddress\&}{ address}, \param{wxSocketFlags}{ flags = wxSOCKET\_NONE}}
+\func{}{wxSocketServer}{\param{const 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 
-\helpref{wxSocketBase::Ok}{wxsocketbaseok}.
+\helpref{wxSocketBase:IsOk}{wxsocketbaseisok}.
 
 \wxheading{Parameters}
 
@@ -47,7 +52,7 @@ Before trying to accept new connections, test whether it succeeded with
 %
 % ~wxSocketServer
 %
-\membersection{wxSocketServer::\destruct{wxSocketServer}}
+\membersection{wxSocketServer::\destruct{wxSocketServer}}\label{wxsocketserverdtor}
 
 \func{}{\destruct{wxSocketServer}}{\void}
 
@@ -58,17 +63,17 @@ Destructor (it doesn't close the accepted connections).
 %
 \membersection{wxSocketServer::Accept}\label{wxsocketserveraccept}
 
-\func{wxSocketBase *}{Accept}{\param{bool}{ wait = TRUE}}
+\func{wxSocketBase *}{Accept}{\param{bool}{ wait = true}}
 
 Accepts an incoming connection request, and creates a new 
 \helpref{wxSocketBase}{wxsocketbase} object which represents
 the server-side of the connection.
 
-If {\it wait} is TRUE and there are no pending connections to be
+If {\it wait} is true and there are no pending connections to be
 accepted, it will wait for the next incoming connection to
 arrive. {\bf Warning:} This will block the GUI.
 
-If {\it wait} is FALSE, it will try to accept a pending connection
+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} 
@@ -78,7 +83,7 @@ that there is an incoming connection waiting to be accepted.
 \wxheading{Return value}
 
 Returns an opened socket connection, or NULL if an error occurred or
-if the {\it wait} parameter was FALSE and there were no pending
+if the {\it wait} parameter was false and there were no pending
 connections.
 
 \wxheading{See also}
@@ -93,7 +98,7 @@ connections.
 %
 \membersection{wxSocketServer::AcceptWith}\label{wxsocketserveracceptwith}
 
-\func{bool}{AcceptWith}{\param{wxSocketBase\&}{ socket}, \param{bool}{ wait = TRUE}}
+\func{bool}{AcceptWith}{\param{wxSocketBase\&}{ socket}, \param{bool}{ wait = true}}
 
 Accept an incoming connection using the specified socket object.
 
@@ -103,8 +108,8 @@ Accept an incoming connection using the specified socket object.
 
 \wxheading{Return value}
 
-Returns TRUE on success, or FALSE if an error occurred or if the
-{\it wait} parameter was FALSE and there were no pending
+Returns true on success, or false if an error occurred or if the
+{\it wait} parameter was false and there were no pending
 connections.
 
 \helpref{wxSocketServer::WaitForAccept}{wxsocketserverwaitforaccept}, 
@@ -121,7 +126,7 @@ connections.
 
 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
+with {\it wait} set to false, to detect when an incoming connection is waiting
 to be accepted.
 
 \wxheading{Parameters}
@@ -134,7 +139,7 @@ as set with \helpref{SetTimeout}{wxsocketbasesettimeout}.}
 
 \wxheading{Return value}
 
-Returns TRUE if an incoming connection arrived, FALSE if the timeout elapsed.
+Returns true if an incoming connection arrived, false if the timeout elapsed.
 
 \wxheading{See also}