+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Name: socket.tex
+%% Purpose: wxSocket docs
+%% Author: Guillermo Rodriguez Garcia <guille@iies.es>
+%% Modified by:
+%% Created: 1999
+%% RCS-ID: $Id$
+%% Copyright: (c) wxWidgets team
+%% License: wxWindows license
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
\section{\class{wxSocketBase}}\label{wxsocketbase}
+wxSocketBase is the base class for all socket-related objects, and it
+defines all basic IO functionality.
+
+Note: (Workaround for implementation limitation for wxWidgets up to 2.5.x)
+If you want to use sockets or derived classes such as wxFTP in a secondary thread,
+call wxSocketBase::Initialize() (undocumented) from the main thread before creating
+any sockets - in wxApp::OnInit for example.
+See http://wiki.wxwidgets.org/wiki.pl?WxSocket or
+http://www.litwindow.com/knowhow/knowhow.html for more details.
+
\wxheading{Derived from}
-\helpref{wxEvtHandler}{wxevthandler}
+\helpref{wxObject}{wxobject}
-% ---------------------------------------------------------------------------
-% Event handling
-% ---------------------------------------------------------------------------
-\wxheading{Event handling}
+\wxheading{Include files}
+
+<wx/socket.h>
-To process events from a socket, use the following event handler macro to direct
- input to member
-functions that take a \helpref{wxSocketEvent}{wxsocketevent} argument.
+\wxheading{wxSocket errors}
\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
-\twocolitem{{\bf EVT\_SOCKET(id, func)}}{A socket event occured.}
-\end{twocollist}%
+\twocolitem{{\bf wxSOCKET\_NOERROR}}{No error happened.}
+\twocolitem{{\bf wxSOCKET\_INVOP}}{Invalid operation.}
+\twocolitem{{\bf wxSOCKET\_IOERR}}{Input/Output error.}
+\twocolitem{{\bf wxSOCKET\_INVADDR}}{Invalid address passed to wxSocket.}
+\twocolitem{{\bf wxSOCKET\_INVSOCK}}{Invalid socket (uninitialized).}
+\twocolitem{{\bf wxSOCKET\_NOHOST}}{No corresponding host.}
+\twocolitem{{\bf wxSOCKET\_INVPORT}}{Invalid port.}
+\twocolitem{{\bf wxSOCKET\_WOULDBLOCK}}{The socket is non-blocking and the operation would block.}
+\twocolitem{{\bf wxSOCKET\_TIMEDOUT}}{The timeout for this operation expired.}
+\twocolitem{{\bf wxSOCKET\_MEMERR}}{Memory exhausted.}
+\end{twocollist}
+
+\wxheading{wxSocket events}
-% ---------------------------------------------------------------------------
-% See also ...
-% ---------------------------------------------------------------------------
+\twocolwidtha{7cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\bf wxSOCKET\_INPUT}}{There is data available for reading.}
+\twocolitem{{\bf wxSOCKET\_OUTPUT}}{The socket is ready to be written to.}
+\twocolitem{{\bf wxSOCKET\_CONNECTION}}{Incoming connection request (server), or successful connection establishment (client).}
+\twocolitem{{\bf wxSOCKET\_LOST}}{The connection has been closed.}
+\end{twocollist}
+
+A brief note on how to use these events:
+
+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
+{\bf wxSOCKET\_INPUT} event, as more events will be produced as
+necessary.
+
+The {\bf wxSOCKET\_OUTPUT} event is issued when a socket is first
+connected with \helpref{Connect}{wxsocketclientconnect} or accepted
+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}
+error occurs; after this, whenever the socket becomes writable
+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 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
+received for the socket. This means that the connection broke down or
+that it was closed by the peer. Also, this event will be issued if
+a connection request fails.
+
+\wxheading{Event handling}
+
+To process events coming from a socket object, use the following event
+handler macro to direct events to member functions that take
+a \helpref{wxSocketEvent}{wxsocketevent} argument.
+
+\twocolwidtha{7cm}%
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\bf EVT\_SOCKET(id, func)}}{Process a wxEVT\_SOCKET event.}
+\end{twocollist}
\wxheading{See also}
-\helpref{wxSocketEvent}{wxsocketevent}
-\helpref{wxSocketClient}{wxsocketclient}
-\helpref{wxSocketServer}{wxsocketserver}
+\helpref{wxSocketEvent}{wxsocketevent},
+\helpref{wxSocketClient}{wxsocketclient},
+\helpref{wxSocketServer}{wxsocketserver},
+\helpref{Sockets sample}{samplesockets}
% ---------------------------------------------------------------------------
-% Members
+% Function groups
% ---------------------------------------------------------------------------
-\latexignore{\rtfignore{\wxheading{Members}}}
+\latexignore{\rtfignore{\wxheading{Function groups}}}
-\membersection{wxSocketBase::wxSocketBase}
-\func{}{wxSocketBase}{\void}
+\membersection{Construction and destruction}\label{socketconstruction}
-Default constructor but don't use it, you must use \helpref{wxSocketClient}{wxsocketclient}
-or \helpref{wxSocketServer}{wxsocketserver}.
+\helpref{wxSocketBase}{wxsocketbaseconstruct}\\
+\helpref{\destruct{wxSocketBase}}{wxsocketbasedestruct}\\
+\helpref{Destroy}{wxsocketbasedestroy}
-\membersection{wxSocketBase::\destruct{wxSocketBase}}
+\membersection{Socket state}\label{socketstate}
-\func{}{\destruct{wxSocketBase}}{\void}
+Functions to retrieve current state and miscellaneous info.
+
+\helpref{Error}{wxsocketbaseerror}\\
+\helpref{GetLocal}{wxsocketbasegetlocal}\\
+\helpref{GetPeer}{wxsocketbasegetpeer}
+\helpref{IsConnected}{wxsocketbaseisconnected}\\
+\helpref{IsData}{wxsocketbaseisdata}\\
+\helpref{IsDisconnected}{wxsocketbaseisdisconnected}\\
+\helpref{LastCount}{wxsocketbaselastcount}\\
+\helpref{LastError}{wxsocketbaselasterror}\\
+\helpref{IsOk}{wxsocketbaseisok}\\
+\helpref{SaveState}{wxsocketbasesavestate}\\
+\helpref{RestoreState}{wxsocketbaserestorestate}
+
+\membersection{Basic IO}\label{socketbasicio}
+
+Functions that perform basic IO functionality.
+
+\helpref{Close}{wxsocketbaseclose}\\
+\helpref{Discard}{wxsocketbasediscard}\\
+\helpref{Peek}{wxsocketbasepeek}\\
+\helpref{Read}{wxsocketbaseread}\\
+\helpref{ReadMsg}{wxsocketbasereadmsg}\\
+\helpref{Unread}{wxsocketbaseunread}\\
+\helpref{Write}{wxsocketbasewrite}\\
+\helpref{WriteMsg}{wxsocketbasewritemsg}
+
+Functions that perform a timed wait on a certain IO condition.
+
+\helpref{InterruptWait}{wxsocketbaseinterruptwait}\\
+\helpref{Wait}{wxsocketbasewait}\\
+\helpref{WaitForLost}{wxsocketbasewaitforlost}\\
+\helpref{WaitForRead}{wxsocketbasewaitforread}\\
+\helpref{WaitForWrite}{wxsocketbasewaitforwrite}\\
+
+and also:
+
+\helpref{wxSocketServer::WaitForAccept}{wxsocketserverwaitforaccept}\\
+\helpref{wxSocketClient::WaitOnConnect}{wxsocketclientwaitonconnect}
+
+Functions that allow applications to customize socket IO as needed.
+
+\helpref{GetFlags}{wxsocketbasegetflags}\\
+\helpref{SetFlags}{wxsocketbasesetflags}\\
+\helpref{SetTimeout}{wxsocketbasesettimeout}\\
+\helpref{SetLocal}{wxsocketbasesetlocal}\\
+
+\membersection{Handling socket events}\label{socketevents}
+
+Functions that allow applications to receive socket events.
+
+\helpref{Notify}{wxsocketbasenotify}\\
+\helpref{SetNotify}{wxsocketbasesetnotify}\\
+\helpref{GetClientData}{wxsocketbasegetclientdata}\\
+\helpref{SetClientData}{wxsocketbasesetclientdata}\\
+\helpref{SetEventHandler}{wxsocketbaseseteventhandler}
-Destroys the wxSocketBase object.
% ---------------------------------------------------------------------------
-% State functions
+% Members here
% ---------------------------------------------------------------------------
-\membersection{wxSocketBase::Ok}\label{wxsocketbaseok}
+\helponly{\insertatlevel{2}{
-\constfunc{bool}{Ok}{\void}
+\wxheading{Members}
-Returns TRUE if the socket is initialized and ready and FALSE in other
-cases.
+}}
-\membersection{wxSocketBase::Error}\label{wxsocketbaseerror}
+\membersection{wxSocketBase::wxSocketBase}\label{wxsocketbaseconstruct}
-\constfunc{bool}{Error}{\void}
+\func{}{wxSocketBase}{\void}
-Returns TRUE if an error occured.
+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::IsConnected}\label{wxsocketbaseconnected}
+\membersection{wxSocketBase::\destruct{wxSocketBase}}\label{wxsocketbasedestruct}
-\constfunc{bool}{IsConnected}{\void}
+\func{}{\destruct{wxSocketBase}}{\void}
-Returns TRUE if the socket is connected.
+Destructor. Do not destroy a socket using the delete operator directly;
+use \helpref{Destroy}{wxsocketbasedestroy} instead. Also, do not create
+socket objects in the stack.
-\membersection{wxSocketBase::IsData}\label{wxsocketbaseerror}
-\constfunc{bool}{IsData}{\void}
+%
+% Close
+%
+\membersection{wxSocketBase::Close}\label{wxsocketbaseclose}
-Returns TRUE if some data is arrived on the socket.
+\func{void}{Close}{\void}
-\membersection{wxSocketBase::IsDisconnected}\label{wxsocketbasedisconnected}
+This function shuts down the socket, disabling further transmission and
+reception of data; it also disables events for the socket and frees the
+associated system resources. Upon socket destruction, Close is automatically
+called, so in most cases you won't need to do it yourself, unless you
+explicitly want to shut down the socket, typically to notify the peer
+that you are closing the connection.
-\constfunc{bool}{IsDisconnected}{\void}
+\wxheading{Remark/Warning}
-Returns TRUE if the socket is disconnected.
+Although Close immediately disables events for the socket, it is possible
+that event messages may be waiting in the application's event queue. The
+application must therefore be prepared to handle socket event messages
+even after calling Close.
-\membersection{wxSocketBase::IsNoWait}\label{wxsocketbasenowait}
+%
+% Destroy
+%
+\membersection{wxSocketBase::Destroy}\label{wxsocketbasedestroy}
-\constfunc{bool}{IsNoWait}{\void}
+\func{bool}{Destroy}{\void}
-Returns TRUE if the socket mustn't wait.
+Destroys the socket safely. Use this function instead of the delete operator,
+since otherwise socket events could reach the application even after the
+socket has been destroyed. To prevent this problem, this function appends
+the wxSocket to a list of object to be deleted on idle time, after all
+events have been processed. For the same reason, you should avoid creating
+socket objects in the stack.
-\membersection{wxSocketBase::LastCount}\label{wxsocketbaselastcount}
+Destroy calls \helpref{Close}{wxsocketbaseclose} automatically.
-\constfunc{size\_t}{LastCount}{\void}
+\wxheading{Return value}
-Returns the number of bytes read or written by the last IO call.
+Always true.
-\membersection{wxSocketBase::LastError}\label{wxsocketbaselasterror}
+%
+% Discard
+%
+\membersection{wxSocketBase::Discard}\label{wxsocketbasediscard}
-\constfunc{int}{LastError}{\void}
+\func{wxSocketBase\&}{Discard}{\void}
-Returns an error in the errno format (see your C programmer's guide).
+This function simply deletes all bytes in the incoming queue. This function
+always returns immediately and its operation is not affected by IO flags.
-% ---------------------------------------------------------------------------
-% IO calls
-% ---------------------------------------------------------------------------
+Use \helpref{LastCount}{wxsocketbaselastcount} to verify the number of bytes actually discarded.
+
+If you use \helpref{Error}{wxsocketbaseerror}, it will always return false.
%
-% Peek
+% Error
%
+\membersection{wxSocketBase::Error}\label{wxsocketbaseerror}
-\membersection{wxSocketBase::Peek}\label{wxsocketbasepeek}
+\constfunc{bool}{Error}{\void}
-\func{wxSocketBase\&}{Peek}{\param{char *}{ buffer}, \param{size\_t}{ nbytes}}
+Returns true if an error occurred in the last IO operation.
-This function peeks a buffer of {\it nbytes} bytes from the socket. Peeking a buffer
-doesn't delete it from the system socket in-queue.
+Use this function to check for an error condition after one of the
+following calls: Discard, Peek, Read, ReadMsg, Unread, Write, WriteMsg.
-\wxheading{Parameters}
+%
+% GetClientData
+%
+\membersection{wxSocketBase::GetClientData}\label{wxsocketbasegetclientdata}
-\docparam{buffer}{Buffer where to put peeked data.}
-\docparam{nbytes}{Number of bytes.}
+\constfunc{void *}{GetClientData}{\void}
-\wxheading{Returns value}
-Returns a reference to the current object.
+Returns a pointer of the client data for this socket, as set with
+\helpref{SetClientData}{wxsocketbasesetclientdata}
-\wxheading{See also}
+%
+% GetLocal
+%
+\membersection{wxSocketBase::GetLocal}\label{wxsocketbasegetlocal}
-\helpref{wxSocketBase::Error}{wxsocketbaserror},
-\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
-\helpref{wxSocketBase::LastError}{wxsocketbaselasterror}
+\constfunc{bool}{GetLocal}{\param{wxSockAddress\& }{addr}}
+
+This function returns the local address field of the socket. The local
+address field contains the complete local address of the socket (local
+address, local port, ...).
+
+\wxheading{Return value}
+
+true if no error happened, false otherwise.
%
-% Read
+% GetFlags
%
+\membersection{wxSocketBase::GetFlags}\label{wxsocketbasegetflags}
-\membersection{wxSocketBase::Read}\label{wxsocketbaseread}
+\constfunc{wxSocketFlags}{GetFlags}{\void}
-\func{wxSocketBase\&}{Read}{\param{char *}{ buffer}, \param{size\_t}{ nbytes}}
+Returns current IO flags, as set with \helpref{SetFlags}{wxsocketbasesetflags}
-This function reads a buffer of {\it nbytes} bytes from the socket.
+%
+% GetPeer
+%
+\membersection{wxSocketBase::GetPeer}\label{wxsocketbasegetpeer}
-\wxheading{Parameters}
+\constfunc{bool}{GetPeer}{\param{wxSockAddress\& }{addr}}
-\docparam{buffer}{Buffer where to put read data.}
-\docparam{nbytes}{Number of bytes.}
+This function returns the peer address field of the socket. The peer
+address field contains the complete peer host address of the socket
+(address, port, ...).
-\wxheading{Returns value}
-Returns a reference to the current object.
+\wxheading{Return value}
-\wxheading{See also}
+true if no error happened, false otherwise.
-\helpref{wxSocketBase::Error}{wxsocketbaserror},
-\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
-\helpref{wxSocketBase::LastError}{wxsocketbaselasterror}
-
%
-% Read
+% InterruptWait
%
+\membersection{wxSocketBase::InterruptWait}\label{wxsocketbaseinterruptwait}
+
+\func{void}{InterruptWait}{\void}
+
+Use this function to interrupt any wait operation currently in progress.
+Note that this is not intended as a regular way to interrupt a Wait call,
+but only as an escape mechanism for exceptional situations where it is
+absolutely necessary to use it, for example to abort an operation due to
+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{wxSocketClient::WaitOnConnect}{wxsocketclientwaitonconnect}
-\membersection{wxSocketBase::Write}\label{wxsocketbasewrite}
-
-\func{wxSocketBase\&}{Write}{\param{const char *}{ buffer}, \param{size\_t}{ nbytes}}
+%
+% IsConnected
+%
+\membersection{wxSocketBase::IsConnected}\label{wxsocketbaseisconnected}
-This function writes a buffer of {\it nbytes} bytes from the socket.
+\constfunc{bool}{IsConnected}{\void}
-\wxheading{Parameters}
+Returns true if the socket is connected.
-\docparam{buffer}{Buffer where to get the data to write.}
-\docparam{nbytes}{Number of bytes.}
+%
+% IsData
+%
+\membersection{wxSocketBase::IsData}\label{wxsocketbaseisdata}
-\wxheading{Returns value}
-Returns a reference to the current object.
+\constfunc{bool}{IsData}{\void}
-\wxheading{See also}
+This function waits until the socket is readable. This might mean that
+queued data is available for reading or, for streamed sockets, that
+the connection has been closed, so that a read operation will complete
+immediately without blocking (unless the {\bf wxSOCKET\_WAITALL} flag
+is set, in which case the operation might still block).
-\helpref{wxSocketBase::Error}{wxsocketbaserror},
-\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
-\helpref{wxSocketBase::LastError}{wxsocketbaselasterror}
+\membersection{wxSocketBase::IsDisconnected}\label{wxsocketbaseisdisconnected}
%
-% WriteMsg
+% IsDisconnected
%
+\constfunc{bool}{IsDisconnected}{\void}
-\membersection{wxSocketBase::WriteMsg}\label{wxsocketbasewritemsg}
+Returns true if the socket is not connected.
-\func{wxSocketBase\&}{WriteMsg}{\param{const char *}{ buffer}, \param{size\_t}{ nbytes}}
+\membersection{wxSocketBase::LastCount}\label{wxsocketbaselastcount}
-This function writes a buffer of {\it nbytes} bytes from the socket. But it
-writes a short header before so that ReadMsg can alloc the right size for
-the buffer. So a buffer sent with WriteMsg {\bf must} be read with ReadMsg.
+%
+% LastCount
+%
+\constfunc{wxUint32}{LastCount}{\void}
-\wxheading{Parameters}
+Returns the number of bytes read or written by the last IO call.
-\docparam{buffer}{Buffer where to put data peeked.}
-\docparam{nbytes}{Number of bytes.}
+Use this function to get the number of bytes actually transferred
+after using one of the following IO calls: Discard, Peek, Read,
+ReadMsg, Unread, Write, WriteMsg.
-\wxheading{Returns value}
-Returns a reference to the current object.
+%
+% LastError
+%
+\membersection{wxSocketBase::LastError}\label{wxsocketbaselasterror}
-\wxheading{See also}
+\constfunc{wxSocketError}{LastError}{\void}
-\helpref{wxSocketBase::Error}{wxsocketbaserror},
-\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
-\helpref{wxSocketBase::LastError}{wxsocketbaselasterror},
-\helpref{wxSocketBase::ReadMsg}{wxsocketbasereadmsg}
+Returns the last wxSocket error. See \helpref{wxSocket errors}{wxsocketbase}.
+
+Please note that this function merely returns the last error code,
+but it should not be used to determine if an error has occurred (this
+is because successful operations do not change the LastError value).
+Use \helpref{Error}{wxsocketbaseerror} first, in order to determine
+if the last IO call failed. If this returns true, use LastError
+to discover the cause of the error.
%
-% ReadMsg
+% Notify
%
+\membersection{wxSocketBase::Notify}\label{wxsocketbasenotify}
-\membersection{wxSocketBase::ReadMsg}\label{wxsocketbasereadmsg}
+\func{void}{Notify}{\param{bool}{ notify}}
+
+According to the {\it notify} value, this function enables
+or disables socket events. If {\it notify} is true, the events
+configured with \helpref{SetNotify}{wxsocketbasesetnotify} will
+be sent to the application. If {\it notify} is false; no events
+will be sent.
-\func{wxSocketBase\&}{ReadMsg}{\param{char *}{ buffer}, \param{size\_t}{ nbytes}}
+%
+% IsOk
+%
+\membersection{wxSocketBase::IsOk}\label{wxsocketbaseisok}
-This function reads a buffer sent by WriteMsg on a socket. If the buffer passed
-to the function isn't big enough, the function filled it and then discard the
-bytes left. This function always wait for the buffer to be entirely filled.
+\constfunc{bool}{IsOk}{\void}
-\wxheading{Parameters}
+Returns true if the socket is initialized and ready and false in other
+cases.
-\docparam{buffer}{Buffer where to put read data.}
-\docparam{nbytes}{Number of bytes allocated for the buffer.}
+\wxheading{Remark/Warning}
-\wxheading{Returns value}
-Returns a reference to the current object.
+For \helpref{wxSocketClient}{wxsocketclient}, Ok won't return true unless
+the client is connected to a server.
-\wxheading{See also}
+For \helpref{wxSocketServer}{wxsocketserver}, Ok will return true if the
+server could bind to the specified address and is already listening for
+new connections.
-\helpref{wxSocketBase::Error}{wxsocketbaserror},
-\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
-\helpref{wxSocketBase::LastError}{wxsocketbaselasterror},
-\helpref{wxSocketBase::WriteMsg}{wxsocketbasewritemsg}
+Ok does not check for IO errors;
+use \helpref{Error}{wxsocketbaseerror} instead for that purpose.
%
-% Unread
+% RestoreState
%
+\membersection{wxSocketBase::RestoreState}\label{wxsocketbaserestorestate}
-\membersection{wxSocketBase::UnRead}\label{wxsocketbaseunread}
+\func{void}{RestoreState}{\void}
-\func{wxSocketBase\&}{UnRead}{\param{const char *}{ buffer}, \param{size\_t}{ nbytes}}
+This function restores the previous state of the socket, as saved
+with \helpref{SaveState}{wxsocketbasesavestate}
-This function unreads a buffer. It means that the buffer is put in the top
-of the incoming queue. But, it is put also at the end of all unread buffers.
-It is useful for sockets because we can't seek it.
+Calls to SaveState and RestoreState can be nested.
-\wxheading{Parameters}
+\wxheading{See also}
-\docparam{buffer}{Buffer to be unread.}
-\docparam{nbytes}{Number of bytes.}
+\helpref{wxSocketBase::SaveState}{wxsocketbasesavestate}
-\wxheading{Returns value}
-Returns a reference to the current object.
+%
+% SaveState
+%
+\membersection{wxSocketBase::SaveState}\label{wxsocketbasesavestate}
+
+\func{void}{SaveState}{\void}
+
+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
+\helpref{SetClientData}{wxsocketbasesetclientdata}.
+
+Calls to SaveState and RestoreState can be nested.
\wxheading{See also}
-\helpref{wxSocketBase::Error}{wxsocketbaserror},
-\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
-\helpref{wxSocketBase::LastError}{wxsocketbaselasterror}
+\helpref{wxSocketBase::RestoreState}{wxsocketbaserestorestate}
%
-% Discard
+% SetClientData
%
+\membersection{wxSocketBase::SetClientData}\label{wxsocketbasesetclientdata}
-\membersection{wxSocketBase::Discard}\label{wxsocketbasediscard}
+\func{void}{SetClientData}{\param{void *}{data}}
-\func{wxSocketBase\&}{Discard}{\void}
+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} function.
-This function simply deletes all bytes in the incoming queue. This function
-doesn't wait.
+%
+% SetEventHandler
+%
+\membersection{wxSocketBase::SetEventHandler}\label{wxsocketbaseseteventhandler}
-% ---------------------------------------------------------------------------
-% Wait functions
-% ---------------------------------------------------------------------------
-\membersection{wxSocketBase::Wait}\label{wxsocketbasewait}
-\func{bool}{Wait}{\param{long}{ seconds = -1}, \param{long}{ microsecond = 0}}
+\func{void}{SetEventHandler}{\param{wxEvtHandler\&}{ handler}, \param{int}{ id = -1}}
-This function waits for an event: it could be an incoming byte, the possibility
-for the client to write, a lost connection, an incoming connection, an
-established connection.
+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
+\helpref{Notify}{wxsocketbasenotify}.
\wxheading{Parameters}
-\docparam{seconds}{Number of seconds to wait. By default, it waits infinitely.}
-\docparam{microsecond}{Number of microseconds to wait.}
-
-\wxheading{Return value:}
+\docparam{handler}{Specifies the event handler you want to use.}
-Returns TRUE if an event occured, FALSE if the timeout was reached.
+\docparam{id}{The id of socket event.}
\wxheading{See also}
-\helpref{wxSocketBase::WaitForRead}{wxsocketbasewaitforread},
-\helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite},
-\helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost}
+\helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify},
+\helpref{wxSocketBase::Notify}{wxsocketbasenotify},
+\helpref{wxSocketEvent}{wxsocketevent},
+\helpref{wxEvtHandler}{wxevthandler}
%
-% WaitForRead
+% SetFlags
%
+\membersection{wxSocketBase::SetFlags}\label{wxsocketbasesetflags}
-\membersection{wxSocketBase::WaitForRead}\label{wxsocketbasewaitforread}
-\func{bool}{WaitForRead}{\param{long}{ seconds = -1}, \param{long}{ microsecond = 0}}
-
-This function waits for a read event.
-
-\wxheading{Parameters}
+\func{void}{SetFlags}{\param{wxSocketFlags}{ flags}}
-\docparam{seconds}{Number of seconds to wait. By default, it waits infinitely.}
-\docparam{microsecond}{Number of microseconds to wait.}
+Use SetFlags to customize IO operation for this socket.
+The {\it flags} parameter may be a combination of flags ORed together.
+The following flags can be used:
-\wxheading{Return value:}
+\twocolwidtha{7cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\bf wxSOCKET\_NONE}}{Normal functionality.}
+\twocolitem{{\bf wxSOCKET\_NOWAIT}}{Read/write as much data as possible and return immediately.}
+\twocolitem{{\bf wxSOCKET\_WAITALL}}{Wait for all required data to be read/written unless an error occurs.}
+\twocolitem{{\bf wxSOCKET\_BLOCK}}{Block the GUI (do not yield) while reading/writing data.}
+\twocolitem{{\bf wxSOCKET\_REUSEADDR}}{Allows the use of an in-use port (wxServerSocket only)}
+\end{twocollist}
+
+A brief overview on how to use these flags follows.
+
+If no flag is specified (this is the same as {\bf wxSOCKET\_NONE}),
+IO calls will return after some data has been read or written, even
+when the transfer might not be complete. This is the same as issuing
+exactly one blocking low-level call to recv() or send(). Note
+that {\it blocking} here refers to when the function returns, not
+to whether the GUI blocks during this time.
+
+If {\bf wxSOCKET\_NOWAIT} is specified, IO calls will return immediately.
+Read operations will retrieve only available data. Write operations will
+write as much data as possible, depending on how much space is available
+in the output buffer. This is the same as issuing exactly one nonblocking
+low-level call to recv() or send(). Note that {\it nonblocking} here
+refers to when the function returns, not to whether the GUI blocks during
+this time.
+
+If {\bf wxSOCKET\_WAITALL} is specified, IO calls won't return until ALL
+the data has been read or written (or until an error occurs), blocking if
+necessary, and issuing several low level calls if necessary. This is the
+same as having a loop which makes as many blocking low-level calls to
+recv() or send() as needed so as to transfer all the data. Note
+that {\it blocking} here refers to when the function returns, not
+to whether the GUI blocks during this time.
+
+The {\bf wxSOCKET\_BLOCK} flag controls whether the GUI blocks during
+IO operations. If this flag is specified, the socket will not yield
+during IO calls, so the GUI will remain blocked until the operation
+completes. If it is not used, then the application must take extra
+care to avoid unwanted reentrance.
+
+The {\bf wxSOCKET\_REUSEADDR} flag controls the use of the SO\_REUSEADDR standard
+setsockopt() flag. This flag allows the socket to bind to a port that is already in use.
+This is mostly used on UNIX-based systems to allow rapid starting and stopping of a server -
+otherwise you may have to wait several minutes for the port to become available.
+wxSOCKET\_REUSEADDR can also be used with socket clients to (re)bind to a particular local port
+for an outgoing connection.
+This option can have surprising platform dependent behavior, so check the documentation for
+your platform's implementation of setsockopt(). Note that on BSD-based systems (e.g. Mac OS X),
+use of wxSOCKET\_REUSEADDR implies SO\_REUSEPORT in addition to SO\_REUSEADDR to be consistent
+with Windows.
+
+So:
+
+{\bf wxSOCKET\_NONE} will try to read at least SOME data, no matter how much.
+
+{\bf wxSOCKET\_NOWAIT} will always return immediately, even if it cannot
+read or write ANY data.
+
+{\bf wxSOCKET\_WAITALL} will only return when it has read or written ALL
+the data.
+
+{\bf wxSOCKET\_BLOCK} has nothing to do with the previous flags and
+it controls whether the GUI blocks.
+
+{\bf wxSOCKET\_REUSEADDR} controls special platform-specific behavior for
+reusing local addresses/ports.
-Returns TRUE if a byte arrived, FALSE if the timeout was reached.
+%
+% SetLocal
+%
+\membersection{wxSocketBase::SetLocal}\label{wxsocketbasesetlocal}
-\wxheading{See also}
+\func{bool}{SetLocal}{\param{wxIPV4address\&}{ local}}
-\helpref{wxSocketBase::Wait}{wxsocketbasewait},
-\helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite},
-\helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost}
+This function allows you to set the local address and port,
+useful when an application needs to reuse a particular port. When
+a local port is set for a \helpref{wxSocketClient}{wxsocketclient},
+{\bf bind} will be called before {\bf connect}.
%
-% WaitForWrite
+% SetNotify
%
+\membersection{wxSocketBase::SetNotify}\label{wxsocketbasesetnotify}
-\membersection{wxSocketBase::WaitForWrite}\label{wxsocketbasewaitforwrite}
-\func{bool}{WaitForWrite}{\param{long}{ seconds = -1}, \param{long}{ microsecond = 0}}
+\func{void}{SetNotify}{\param{wxSocketEventFlags}{ flags}}
-This function waits for a write event.
+SetNotify specifies which socket events are to be sent to the event handler.
+The {\it flags} parameter may be combination of flags ORed together. The
+following flags can be used:
-\wxheading{Parameters}
+\twocolwidtha{7cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\bf wxSOCKET\_INPUT\_FLAG}}{to receive wxSOCKET\_INPUT}
+\twocolitem{{\bf wxSOCKET\_OUTPUT\_FLAG}}{to receive wxSOCKET\_OUTPUT}
+\twocolitem{{\bf wxSOCKET\_CONNECTION\_FLAG}}{to receive wxSOCKET\_CONNECTION}
+\twocolitem{{\bf wxSOCKET\_LOST\_FLAG}}{to receive wxSOCKET\_LOST}
+\end{twocollist}
-\docparam{seconds}{Number of seconds to wait. By default, it waits infinitely.}
-\docparam{microsecond}{Number of microseconds to wait.}
+For example:
-\wxheading{Return value:}
+\begin{verbatim}
+ sock.SetNotify(wxSOCKET_INPUT_FLAG | wxSOCKET_LOST_FLAG);
+ sock.Notify(true);
+\end{verbatim}
-Returns TRUE if a write event occured, FALSE if the timeout was reached.
+In this example, the user will be notified about incoming socket data and
+whenever the connection is closed.
-\wxheading{See also}
+For more information on socket events see \helpref{wxSocket events}{wxsocketbase}.
-\helpref{wxSocketBase::Wait}{wxsocketbasewait},
-\helpref{wxSocketBase::WaitForRead}{wxsocketbasewaitforread},
-\helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost}
+%
+% SetTimeout
+%
+\membersection{wxSocketBase::SetTimeout}\label{wxsocketbasesettimeout}
+
+\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} family
+of functions if you don't specify a wait interval. Initially, the default
+timeout is 10 minutes.
%
-% WaitForLost
+% Peek
%
+\membersection{wxSocketBase::Peek}\label{wxsocketbasepeek}
-\membersection{wxSocketBase::WaitForLost}\label{wxsocketbasewaitforlost}
-\func{bool}{Wait}{\param{long}{ seconds = -1}, \param{long}{ microsecond = 0}}
+\func{wxSocketBase\&}{Peek}{\param{void *}{ buffer}, \param{wxUint32}{ nbytes}}
-This function waits for a "lost" event. For instance, the peer may have closed
-the connection, or the connection may have been broken.
+This function peeks a buffer of {\it nbytes} bytes from the socket.
+Peeking a buffer doesn't delete it from the socket input queue.
-\wxheading{Parameters}
+Use \helpref{LastCount}{wxsocketbaselastcount} to verify the number of bytes actually peeked.
-\docparam{seconds}{Number of seconds to wait. By default, it waits infinitely.}
-\docparam{microsecond}{Number of microseconds to wait.}
+Use \helpref{Error}{wxsocketbaseerror} to determine if the operation succeeded.
-\wxheading{Return value:}
+\wxheading{Parameters}
-Returns TRUE if a "lost" event occured, FALSE if the timeout was reached.
+\docparam{buffer}{Buffer where to put peeked data.}
-\wxheading{See also}
+\docparam{nbytes}{Number of bytes.}
-\helpref{wxSocketBase::WaitForRead}{wxsocketbasewaitforread},
-\helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite},
-\helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost}
+\wxheading{Return value}
-% ---------------------------------------------------------------------------
-% Socket state
-% ---------------------------------------------------------------------------
+Returns a reference to the current object.
-%
-% SaveState
-%
-\membersection{wxSocketBase::SaveState}\label{wxsocketbasesavestate}
-\func{void}{SaveState}{\void}
+\wxheading{Remark/Warning}
-This function saves the current state of the socket object in a stack:
-actually it saves all flags and the state of the asynchronous callbacks.
+The exact behaviour of wxSocketBase::Peek depends on the combination
+of flags being used. For a detailed explanation, see \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags}
\wxheading{See also}
-\helpref{wxSocketBase::RestoreState}{wxsocketbaserestorestate}
+\helpref{wxSocketBase::Error}{wxsocketbaseerror},
+\helpref{wxSocketBase::LastError}{wxsocketbaselasterror},
+\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
+\helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags}
%
-% RestoreState
+% Read
%
+\membersection{wxSocketBase::Read}\label{wxsocketbaseread}
-\membersection{wxSocketBase::RestoreState}\label{wxsocketbaserestorestate}
+\func{wxSocketBase\&}{Read}{\param{void *}{ buffer}, \param{wxUint32}{ nbytes}}
-\func{void}{RestoreState}{\void}
+This function reads a buffer of {\it nbytes} bytes from the socket.
+
+Use \helpref{LastCount}{wxsocketbaselastcount} to verify the number of bytes actually read.
-This function restores a previously saved state.
+Use \helpref{Error}{wxsocketbaseerror} to determine if the operation succeeded.
+
+\wxheading{Parameters}
+
+\docparam{buffer}{Buffer where to put read data.}
+
+\docparam{nbytes}{Number of bytes.}
+
+\wxheading{Return value}
+
+Returns a reference to the current object.
+
+\wxheading{Remark/Warning}
+
+The exact behaviour of wxSocketBase::Read depends on the combination
+of flags being used. For a detailed explanation, see \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags}.
\wxheading{See also}
-\helpref{wxSocketBase::SaveState}{wxsocketbasesavestate}
+\helpref{wxSocketBase::Error}{wxsocketbaseerror},
+\helpref{wxSocketBase::LastError}{wxsocketbaselasterror},
+\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
+\helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags}
-% ---------------------------------------------------------------------------
-% Socket callbacks
-% ---------------------------------------------------------------------------
+%
+% ReadMsg
+%
+\membersection{wxSocketBase::ReadMsg}\label{wxsocketbasereadmsg}
-\membersection{wxSocketBase::SetEventHandler}{wxsocketbaseseteventhandler}
-\func{void}{SetEventHandler}{\param{wxEvtHandler\&}{ evt\_hdlr}, \param{int}{ id = -1}}
+\func{wxSocketBase\&}{ReadMsg}{\param{void *}{ buffer}, \param{wxUint32}{ nbytes}}
-Sets an event handler to be called when a socket event occured.
+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.
+
+Use \helpref{LastCount}{wxsocketbaselastcount} to verify the number of bytes actually read.
+
+Use \helpref{Error}{wxsocketbaseerror} to determine if the operation succeeded.
\wxheading{Parameters}
-\docparam{evt\_hdlr}{Specifies the event handler you want to use.}
-\docparam{id}{The id of socket event.}
+\docparam{buffer}{Buffer where to put read data.}
-\wxheading{See also}
+\docparam{nbytes}{Size of the buffer.}
-\helpref{wxSocketEvent}{wxsocketevent}
+\wxheading{Return value}
-% ---------------------------------------------------------------------------
-% CLASS wxSocketClient
-% ---------------------------------------------------------------------------
+Returns a reference to the current object.
-\section{\class{wxSocketClient}}\label{wxsocketclient}
+\wxheading{Remark/Warning}
-\wxheading{Derived from}
+wxSocketBase::ReadMsg will behave as if the {\bf wxSOCKET\_WAITALL} flag
+was always set and it will always ignore the {\bf wxSOCKET\_NOWAIT} flag.
+The exact behaviour of ReadMsg depends on the {\bf wxSOCKET\_BLOCK} flag.
+For a detailed explanation, see \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags}.
-\helpref{wxSocketBase}{wxsocketbase}
+\wxheading{See also}
-% ---------------------------------------------------------------------------
-% Members
-% ---------------------------------------------------------------------------
+\helpref{wxSocketBase::Error}{wxsocketbaseerror},
+\helpref{wxSocketBase::LastError}{wxsocketbaselasterror},
+\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
+\helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags},
+\helpref{wxSocketBase::WriteMsg}{wxsocketbasewritemsg}
%
-% wxSocketClient
+% Unread
%
+\membersection{wxSocketBase::Unread}\label{wxsocketbaseunread}
+
+\func{wxSocketBase\&}{Unread}{\param{const void *}{ buffer}, \param{wxUint32}{ nbytes}}
-\membersection{wxSocketClient::wxSocketClient}
-\func{}{wxSocketClient}{\param{wxSockFlags}{ flags = wxSocketBase::NONE}}
+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.
-Constructs a new wxSocketClient.
-{\bf Warning !} The created needs to be registered to a socket handler (See \helpref{wxSocketHandler}{wxsockethandler}).
+If you use \helpref{LastCount}{wxsocketbaselastcount}, it will always return {\it nbytes}.
+
+If you use \helpref{Error}{wxsocketbaseerror}, it will always return false.
\wxheading{Parameters}
-\docparam{flags}{Socket flags (See \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags})}
+\docparam{buffer}{Buffer to be unread.}
-%
-% ~wxSocketClient
-%
+\docparam{nbytes}{Number of bytes.}
-\membersection{wxSocketClient::\destruct{wxSocketClient}}
-\func{}{\destruct{wxSocketClient}}{\void}
+\wxheading{Return value}
+
+Returns a reference to the current object.
-Destructs a wxSocketClient object.
+\wxheading{See also}
+
+\helpref{wxSocketBase::Error}{wxsocketbaseerror},
+\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
+\helpref{wxSocketBase::LastError}{wxsocketbaselasterror}
%
-% Connect
+% Wait
%
+\membersection{wxSocketBase::Wait}\label{wxsocketbasewait}
+
+\func{bool}{Wait}{\param{long}{ seconds = -1}, \param{long}{ millisecond = 0}}
-\membersection{wxSocketClient::Connect}{wxsocketclientconnect}
-\func{bool}{Connect}{\param{wxSockAddress\&}{ address}, \param{bool}{ wait = TRUE}}
+This function waits until any of the following conditions is true:
+
+\begin{itemize}
+\item The socket becomes readable.
+\item The socket becomes writable.
+\item An ongoing connection request has completed (\helpref{wxSocketClient}{wxsocketclient} only)
+\item An incoming connection request has arrived (\helpref{wxSocketServer}{wxsocketserver} only)
+\item The connection has been closed.
+\end{itemize}
-Connects to a server using the specified address. If {\it wait} is TRUE, Connect
-will wait for the socket ready to send or receive data.
+Note that it is recommended to use the individual Wait functions
+to wait for the required condition, instead of this one.
\wxheading{Parameters}
-\docparam{address}{Address of the server.}
-\docparam{wait}{If true, waits for the connection to be ready.}
+\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 the connection is established and no error occurs.
+Returns true when any of the above conditions is satisfied,
+false if the timeout was reached.
\wxheading{See also}
+\helpref{wxSocketBase::InterruptWait}{wxsocketbaseinterruptwait},
+\helpref{wxSocketServer::WaitForAccept}{wxsocketserverwaitforaccept},
+\helpref{wxSocketBase::WaitForLost}{wxsocketbasewaitforlost},
+\helpref{wxSocketBase::WaitForRead}{wxsocketbasewaitforread},
+\helpref{wxSocketBase::WaitForWrite}{wxsocketbasewaitforwrite},
\helpref{wxSocketClient::WaitOnConnect}{wxsocketclientwaitonconnect}
%
-% WaitOnConnect
+% WaitForLost
%
+\membersection{wxSocketBase::WaitForLost}\label{wxsocketbasewaitforlost}
-\membersection{wxSocketClient::WaitOnConnect}
-\func{bool}{WaitOnConnect}{\param{long}{ seconds = -1}, \param{long}{ microseconds = 0}}
-
-Wait for a "connect" event.
+\func{bool}{Wait}{\param{long}{ seconds = -1}, \param{long}{ millisecond = 0}}
-\wxheading{See also}
+This function waits until the connection is lost. This may happen if
+the peer gracefully closes the connection or if the connection breaks.
-\helpref{wxSocketBase::Wait}{wxsocketbasewait} for a detailed description.
+\wxheading{Parameters}
-% ---------------------------------------------------------------------------
-% CLASS: wxSocketServer
-% ---------------------------------------------------------------------------
+\docparam{seconds}{Number of seconds to wait.
+If -1, it will wait for the default timeout,
+as set with \helpref{SetTimeout}{wxsocketbasesettimeout}.}
-\section{\class{wxSocketServer}}\label{wxsocketserver}
+\docparam{millisecond}{Number of milliseconds to wait.}
-\wxheading{Derived from}
+\wxheading{Return value}
-\helpref{wxSocketBase}{wxsocketbase}
+Returns true if the connection was lost, false if the timeout was reached.
-% ---------------------------------------------------------------------------
-% Members
-% ---------------------------------------------------------------------------
+\wxheading{See also}
-\latexignore{\rtfignore{\wxheading{Members}}}
+\helpref{wxSocketBase::InterruptWait}{wxsocketbaseinterruptwait},
+\helpref{wxSocketBase::Wait}{wxsocketbasewait}
%
-% wxSocketServer
+% WaitForRead
%
+\membersection{wxSocketBase::WaitForRead}\label{wxsocketbasewaitforread}
-\membersection{wxSocketServer::wxSocketServer}{wxsocketserverconstr}
-\func{}{wxSocketServer}{\param{wxSockAddress\&}{ address}, \param{wxSockFlags}{ flags = wxSocketBase::NONE}}
+\func{bool}{WaitForRead}{\param{long}{ seconds = -1}, \param{long}{ millisecond = 0}}
-Constructs a new wxSocketServer.
-{\bf Warning !} The created object needs to be registered to a socket handler
-(See \helpref{wxSocketHandler}{wxsockethandler}).
+This function waits until the socket is readable. This might mean that
+queued data is available for reading or, for streamed sockets, that
+the connection has been closed, so that a read operation will complete
+immediately without blocking (unless the {\bf wxSOCKET\_WAITALL} flag
+is set, in which case the operation might still block).
\wxheading{Parameters}
-\docparam{address}{Specifies the local address for the server (e.g. port number).}
-\docparam{flags}{Socket flags (See \helpref{wxSocketBase::SetFlags}{wxsocketbase
-setflags})}
+\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 the socket becomes readable, false on timeout.
+
+\wxheading{See also}
+
+\helpref{wxSocketBase::InterruptWait}{wxsocketbaseinterruptwait},
+\helpref{wxSocketBase::Wait}{wxsocketbasewait}
%
-% ~wxSocketServer
+% WaitForWrite
%
+\membersection{wxSocketBase::WaitForWrite}\label{wxsocketbasewaitforwrite}
+
+\func{bool}{WaitForWrite}{\param{long}{ seconds = -1}, \param{long}{ millisecond = 0}}
+
+This function waits until the socket becomes writable. This might mean that
+the socket is ready to send new data, or for streamed sockets, that the
+connection has been closed, so that a write operation is guaranteed to
+complete immediately (unless the {\bf wxSOCKET\_WAITALL} flag is set,
+in which case the operation might still block).
+
+\wxheading{Parameters}
+
+\docparam{seconds}{Number of seconds to wait.
+If -1, it will wait for the default timeout,
+as set with \helpref{SetTimeout}{wxsocketbasesettimeout}.}
-\membersection{wxSocketServer::\destruct{wxSocketServer}}
-\func{}{\destruct{wxSocketServer}}{\void}
+\docparam{millisecond}{Number of milliseconds to wait.}
+
+\wxheading{Return value}
+
+Returns true if the socket becomes writable, false on timeout.
+
+\wxheading{See also}
-Destructs a wxSocketServer object (it doesn't close the accepted connection).
+\helpref{wxSocketBase::InterruptWait}{wxsocketbaseinterruptwait},
+\helpref{wxSocketBase::Wait}{wxsocketbasewait}
%
-% Accept
+% Write
%
+\membersection{wxSocketBase::Write}\label{wxsocketbasewrite}
+
+\func{wxSocketBase\&}{Write}{\param{const void *}{ buffer}, \param{wxUint32}{ nbytes}}
+
+This function writes a buffer of {\it nbytes} bytes to the socket.
-\membersection{wxSocketServer::Accept}
-\func{wxSocketBase *}{Accept}{\void}
+Use \helpref{LastCount}{wxsocketbaselastcount} to verify the number of bytes actually written.
+
+Use \helpref{Error}{wxsocketbaseerror} to determine if the operation succeeded.
+
+\wxheading{Parameters}
-Creates a new object wxSocketBase and accepts an incoming connection. {\bf Warning !} This function will block the GUI.
+\docparam{buffer}{Buffer with the data to be sent.}
+
+\docparam{nbytes}{Number of bytes.}
\wxheading{Return value}
-Returns an opened socket connection.
+Returns a reference to the current object.
+
+\wxheading{Remark/Warning}
+
+The exact behaviour of wxSocketBase::Write depends on the combination
+of flags being used. For a detailed explanation, see \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags}.
\wxheading{See also}
-\helpref{wxSocketServer::AcceptWith}{wxsocketserveracceptwith}
+\helpref{wxSocketBase::Error}{wxsocketbaseerror},
+\helpref{wxSocketBase::LastError}{wxsocketbaselasterror},
+\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
+\helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags}
%
-% AcceptWith
+% WriteMsg
%
+\membersection{wxSocketBase::WriteMsg}\label{wxsocketbasewritemsg}
+
+\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
+{\bf must} be read with ReadMsg. This function always waits for the entire
+buffer to be sent, unless an error occurs.
-\membersection{wxSocketServer::AcceptWith}{wxsocketserveracceptwith}
-\func{bool}{AcceptWith}{\param{wxSocketBase\&}{ socket}}
+Use \helpref{LastCount}{wxsocketbaselastcount} to verify the number of bytes actually written.
-Accept an incoming connection using the specified socket object.
-This is useful when someone wants to inherit wxSocketBase.
+Use \helpref{Error}{wxsocketbaseerror} to determine if the operation succeeded.
\wxheading{Parameters}
-\docparam{socket}{Socket to be initialized}
+\docparam{buffer}{Buffer with the data to be sent.}
+
+\docparam{nbytes}{Number of bytes to send.}
\wxheading{Return value}
-Returns TRUE if no error occurs, else FALSE.
+Returns a reference to the current object.
+
+\wxheading{Remark/Warning}
+
+wxSocketBase::WriteMsg will behave as if the {\bf wxSOCKET\_WAITALL} flag
+was always set and it will always ignore the {\bf wxSOCKET\_NOWAIT} flag.
+The exact behaviour of WriteMsg depends on the {\bf wxSOCKET\_BLOCK} flag.
+For a detailed explanation, see \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags}.
+
+\wxheading{See also}
+
+\helpref{wxSocketBase::Error}{wxsocketbaseerror},
+\helpref{wxSocketBase::LastError}{wxsocketbaselasterror},
+\helpref{wxSocketBase::LastCount}{wxsocketbaselastcount},
+\helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags},
+\helpref{wxSocketBase::ReadMsg}{wxsocketbasereadmsg}
% ---------------------------------------------------------------------------
-% CLASS: wxSocketHandler
+% CLASS wxSocketClient
% ---------------------------------------------------------------------------
-\section{\class{wxSocketHandler}}\label{wxsockethandler}
+\section{\class{wxSocketClient}}\label{wxsocketclient}
\wxheading{Derived from}
-\helpref{wxObject}{wxobject}
+\helpref{wxSocketBase}{wxsocketbase}
-% ---------------------------------------------------------------------------
-% Members
-% ---------------------------------------------------------------------------
+\wxheading{Include files}
+
+<wx/socket.h>
\latexignore{\rtfignore{\wxheading{Members}}}
+% ---------------------------------------------------------------------------
+% Members
+% ---------------------------------------------------------------------------
%
-% wxSocketHandler
+% wxSocketClient
%
-\membersection{wxSocketHandler::wxSocketHandler}
-\func{}{wxSocketHandler}{\void}
+\membersection{wxSocketClient::wxSocketClient}\label{wxsocketclientctor}
+
+\func{}{wxSocketClient}{\param{wxSocketFlags}{ flags = wxSOCKET\_NONE}}
+
+Constructor.
-Constructs a new wxSocketHandler.
-It is advised to use \helpref{wxSocketHandler::Master}{wxsockethandlermaster}
-to get a socket handler. But creating a socket handler is useful to group
-many sockets.
+\wxheading{Parameters}
+
+\docparam{flags}{Socket flags (See \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags})}
%
-% ~wxSocketHandler
+% ~wxSocketClient
%
+\membersection{wxSocketClient::\destruct{wxSocketClient}}\label{wxsocketclientdtor}
-\membersection{wxSocketHandler::\destruct{wxSocketHandler}}
-\func{}{\destruct{wxSocketHandler}}{\void}
+\func{}{\destruct{wxSocketClient}}{\void}
-Destructs a wxSocketHandler object.
+Destructor. Please see \helpref{wxSocketBase::Destroy}{wxsocketbasedestroy}.
%
-% Register
+% Connect
%
+\membersection{wxSocketClient::Connect}\label{wxsocketclientconnect}
-\membersection{wxSocketHandler::Register}
-\func{void}{Register}{\param{wxSocketBase *}{socket}}
+\func{bool}{Connect}{\param{wxSockAddress\&}{ address}, \param{bool}{ wait = true}}
-Register a socket: if it is already registered in this handler it will just
-return immediately.
+\func{bool}{Connect}{\param{wxSockAddress\&}{ address}, \param{wxSockAddress\&}{ local},
+\param{bool}{ wait = true}}
-\wxheading{Parameters}
+Connects to a server using the specified address.
-\docparam{socket}{Socket to be registered.}
+If {\it wait} is true, Connect will wait until the connection
+completes. {\bf Warning:} This will block the GUI.
-%
-% UnRegister
-%
+If {\it wait} is false, Connect will try to establish the connection and
+return immediately, without blocking the GUI. When used this way, even if
+Connect returns false, the connection request can be completed later.
+To detect this, use \helpref{WaitOnConnect}{wxsocketclientwaitonconnect},
+or catch {\bf wxSOCKET\_CONNECTION} events (for successful establishment)
+and {\bf wxSOCKET\_LOST} events (for connection failure).
-\membersection{wxSocketHandler::UnRegister}
-\func{void}{UnRegister}{\param{wxSocketBase *}{socket}}
+\wxheading{Parameters}
-UnRegister a socket: if it isn't registered in this handler it will just
-return.
+\docparam{address}{Address of the server.}
-\wxheading{Parameters}
+\docparam{local}{Bind to the specified local address and port before connecting.
+The local address and port can also be set using \helpref{SetLocal}{wxsocketbasesetlocal},
+and then using the 2-parameter Connect method.}
-\docparam{socket}{Socket to be unregistered.}
+\docparam{wait}{If true, waits for the connection to complete.}
-%
-% Count
-%
+\wxheading{Return value}
-\membersection{wxSocketHandler::Count}
-\constfunc{unsigned long}{Count}{\void}
+Returns true if the connection is established and no error occurs.
-Returns the number of sockets registered in the handler.
+If {\it wait} was true, and Connect returns false, an error occurred
+and the connection failed.
-\wxheading{Return value}
+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 {\bf wxSOCKET\_CONNECTION} and {\bf wxSOCKET\_LOST} events.
-Number of sockets registered.
+\wxheading{See also}
+
+\helpref{wxSocketClient::WaitOnConnect}{wxsocketclientwaitonconnect},
+\helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify},
+\helpref{wxSocketBase::Notify}{wxsocketbasenotify}
%
-% CreateServer
+% WaitOnConnect
%
+\membersection{wxSocketClient::WaitOnConnect}\label{wxsocketclientwaitonconnect}
-\membersection{wxSocketHandler::CreateServer}
-\func{wxSocketServer *}{CreateServer}{\param{wxSockAddress\&}{ address}, \param{wxSocketBase::wxSockFlags}{ flags = wxSocketbase::NONE}}
+\func{bool}{WaitOnConnect}{\param{long}{ seconds = -1}, \param{long}{ milliseconds = 0}}
-Creates a new wxSocketServer object. The object is automatically registered
-to the current socket handler.
-For a detailed description of the parameters, see \helpref{wxSocketServer::wxSocketServer}{wxsocketserverconstr}.
+Wait until a connection request completes, or until the specified timeout
+elapses. Use this function after issuing a call
+to \helpref{Connect}{wxsocketclientconnect} with {\it wait} set to false.
+
+\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 a new socket server.
+WaitOnConnect returns true if the connection request completes. This
+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.
-%
-% CreateClient
-%
+If the timeout elapses, WaitOnConnect returns false.
-\membersection{wxSocketHandler::CreateClient}
-\func{wxSocketServer *}{CreateClient}{\param{wxSocketBase::wxSockFlags}{ flags = wxSocketbase::NONE}}
+These semantics allow code like this:
-Creates a new wxSocketClient object. The object is automatically registered
-to the current socket handler.
-For a detailed description of the parameters, see \helpref{wxSocketClient::Connect}{wxsocketclientconnect}.
+\begin{verbatim}
+// Issue the connection request
+client->Connect(addr, false);
-\wxheading{Return value}
+// Wait until the request completes or until we decide to give up
+bool waitmore = true;
+while ( !client->WaitOnConnect(seconds, millis) && waitmore )
+{
+ // possibly give some feedback to the user,
+ // and update waitmore as needed.
+}
+bool success = client->IsConnected();
+\end{verbatim}
-Returns a new socket client.
+\wxheading{See also}
-%
-% Master
-%
+\helpref{wxSocketClient::Connect}{wxsocketclientconnect},
+\helpref{wxSocketBase::InterruptWait}{wxsocketbaseinterruptwait},
+\helpref{wxSocketBase::IsConnected}{wxsocketbaseisconnected}
+
+% ---------------------------------------------------------------------------
+% CLASS: wxSocketEvent
+% ---------------------------------------------------------------------------
+\section{\class{wxSocketEvent}}\label{wxsocketevent}
-\membersection{wxSocketHandler::Master}
-\func{static wxSocketHandler\&}{Master}{\void}
+This event class contains information about socket events.
-Returns a default socket handler.
+\wxheading{Derived from}
-%
-% Wait
-%
-\membersection{wxSocketHandler::Wait}
-\func{int}{Wait}{\param{long}{ seconds},\param{long}{ microseconds}}
+\helpref{wxEvent}{wxevent}
-Wait for an event on all registered sockets.
+\wxheading{Include files}
-\wxheading{Parameters}
+<wx/socket.h>
-\docparam{seconds}{Number of seconds to wait. By default, it waits infinitely.}
-\docparam{microsecond}{Number of microseconds to wait.}
+\wxheading{Event table macros}
-\wxheading{Return value}
+To process a socket event, use these event handler macros to direct input
+to member functions that take a wxSocketEvent argument.
-Returns 0 if a timeout occured, else the number of events detected.
+\twocolwidtha{7cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\bf EVT\_SOCKET(id, func)}}{Process a socket event, supplying the member function.}
+\end{twocollist}
\wxheading{See also}
-\helpref{wxSocketBase::Wait}{wxsockebasewait}
+\helpref{wxSocketBase}{wxsocketbase},
+\helpref{wxSocketClient}{wxsocketclient},
+\helpref{wxSocketServer}{wxsocketserver}
-%
-% YieldSock
-%
-\membersection{wxSocketHandler::YieldSock}
-\func{void}{YieldSock}{\void}
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+\membersection{wxSocketEvent::wxSocketEvent}\label{wxsocketeventctor}
+
+\func{}{wxSocketEvent}{\param{int}{ id = 0}}
+
+Constructor.
+
+\membersection{wxSocketEvent::GetClientData}\label{wxsocketeventgetclientdata}
+
+\func{void *}{GetClientData}{\void}
+
+Gets the client data of the socket which generated this event, as
+set with \helpref{wxSocketBase::SetClientData}{wxsocketbasesetclientdata}.
+
+\membersection{wxSocketEvent::GetSocket}\label{wxsocketeventgetsocket}
+
+\constfunc{wxSocketBase *}{GetSocket}{\void}
+
+Returns the socket object to which this event refers to. This makes
+it possible to use the same event handler for different sockets.
+
+\membersection{wxSocketEvent::GetSocketEvent}\label{wxsocketeventgetsocketevent}
+
+\constfunc{wxSocketNotify}{GetSocketEvent}{\void}
+
+Returns the socket event type.
-Execute pending requests in all registered sockets.
projects / wxWidgets.git / blobdiff