X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e72403492b3e78f8114d89baae6f81ea24c74647..47610ec22ab01dbc09307a88ab67c1c95f6ee3b1:/docs/latex/wx/socket.tex diff --git a/docs/latex/wx/socket.tex b/docs/latex/wx/socket.tex index 56959fca5e..33a9ae651d 100644 --- a/docs/latex/wx/socket.tex +++ b/docs/latex/wx/socket.tex @@ -70,7 +70,7 @@ again the application will be notified with another {\bf wxSOCKET\_OUTPUT} event. The {\bf wxSOCKET\_CONNECTION} event is issued when a delayed connection -request completes succesfully (client) or when a new connection arrives +request completes successfully (client) or when a new connection arrives at the incoming queue (server). The {\bf wxSOCKET\_LOST} event is issued when a close indication is @@ -577,7 +577,7 @@ enabled with \helpref{SetNotify}{wxsocketbasesetnotify} and \func{void}{SetFlags}{\param{wxSocketFlags}{ flags}} Use SetFlags to customize IO operation for this socket. -The {\it flags} parameter may be a combination of flags ORed toghether. +The {\it flags} parameter may be a combination of flags ORed together. The following flags can be used: \twocolwidtha{7cm} @@ -640,7 +640,7 @@ it controls whether the GUI blocks. \func{void}{SetNotify}{\param{wxSocketEventFlags}{ flags}} SetNotify specifies which socket events are to be sent to the event handler. -The {\it flags} parameter may be combination of flags ORed toghether. The +The {\it flags} parameter may be combination of flags ORed together. The following flags can be used: \twocolwidtha{7cm} @@ -1130,7 +1130,7 @@ as set with \helpref{SetTimeout}{wxsocketbasesettimeout}.} \wxheading{Return value} WaitOnConnect returns TRUE if the connection request completes. This -does not necessarily mean that the connection was succesfully established; +does not necessarily mean that the connection was successfully established; it might also happen that the connection was refused by the peer. Use \helpref{IsConnected}{wxsocketbaseisconnected} to distinguish between these two situations. @@ -1218,136 +1218,3 @@ it possible to use the same event handler for different sockets. Returns the socket event type. -% --------------------------------------------------------------------------- -% CLASS: wxSocketServer -% --------------------------------------------------------------------------- -\section{\class{wxSocketServer}}\label{wxsocketserver} - -\wxheading{Derived from} - -\helpref{wxSocketBase}{wxsocketbase} - -\wxheading{Include files} - - - -% --------------------------------------------------------------------------- -% Members -% --------------------------------------------------------------------------- -\latexignore{\rtfignore{\wxheading{Members}}} - -% -% wxSocketServer -% -\membersection{wxSocketServer::wxSocketServer}\label{wxsocketserverconstr} - -\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 -\helpref{wxSocketBase::Ok}{wxsocketbaseok}. - -\wxheading{Parameters} - -\docparam{address}{Specifies the local address for the server (e.g. port number).} - -\docparam{flags}{Socket flags (See \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags})} - -% -% ~wxSocketServer -% -\membersection{wxSocketServer::\destruct{wxSocketServer}} - -\func{}{\destruct{wxSocketServer}}{\void} - -Destructor (it doesn't close the accepted connections). - -% -% Accept -% -\membersection{wxSocketServer::Accept}\label{wxsocketserveraccept} - -\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 -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 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} -or catch {\bf wxSOCKET\_CONNECTION} events, then call Accept once you know -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 -connections. - -\wxheading{See also} - -\helpref{wxSocketServer::WaitForAccept}{wxsocketserverwaitforaccept}, -\helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify}, -\helpref{wxSocketBase::Notify}{wxsocketbasenotify}, -\helpref{wxSocketServer::AcceptWith}{wxsocketserveracceptwith} - -% -% AcceptWith -% -\membersection{wxSocketServer::AcceptWith}\label{wxsocketserveracceptwith} - -\func{bool}{AcceptWith}{\param{wxSocketBase\&}{ socket}, \param{bool}{ wait = TRUE}} - -Accept an incoming connection using the specified socket object. - -\wxheading{Parameters} - -\docparam{socket}{Socket to be initialized} - -\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 -connections. - -\helpref{wxSocketServer::WaitForAccept}{wxsocketserverwaitforaccept}, -\helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify}, -\helpref{wxSocketBase::Notify}{wxsocketbasenotify}, -\helpref{wxSocketServer::Accept}{wxsocketserveraccept} - -% -% WaitForAccept -% -\membersection{wxSocketServer::WaitForAccept}\label{wxsocketserverwaitforaccept} - -\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} -with {\it wait} set to FALSE, to detect when an incoming connection is waiting -to be accepted. - -\wxheading{Parameters} - -\docparam{seconds}{Number of seconds to wait. -If -1, it will wait for the default timeout, -as set with \helpref{SetTimeout}{wxsocketbasesettimeout}.} - -\docparam{millisecond}{Number of milliseconds to wait.} - -\wxheading{Return value} - -Returns TRUE if an incoming connection arrived, FALSE if the timeout elapsed. - -\wxheading{See also} - -\helpref{wxSocketServer::Accept}{wxsocketserveraccept}, -\helpref{wxSocketServer::AcceptWith}{wxsocketserveracceptwith}, -\helpref{wxSocketBase::InterruptWait}{wxsocketbaseinterruptwait} -