%% Modified by:
%% Created: 1999
%% RCS-ID: $Id$
-%% Copyright: (c) wxWindows team
-%% Licence: wxWindows licence
+%% Copyright: (c) wxWidgets team
+%% License: wxWidgets license
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{\class{wxSocketBase}}\label{wxsocketbase}
\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 (server), or connection establishment (client).}
+\twocolitem{{\bf wxSOCKET\_CONNECTION}}{Incoming connection request (server), or successful connection establishment (client).}
\twocolitem{{\bf wxSOCKET\_LOST}}{The connection has been closed.}
\end{twocollist}
{\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
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 delayed connection request fails.
+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.
+handler macro to direct events to member functions that take
+a \helpref{wxSocketEvent}{wxsocketevent} argument.
\twocolwidtha{7cm}%
\begin{twocollist}\itemsep=0pt
\helpref{wxSocketBase}{wxsocketbaseconstruct}\\
\helpref{\destruct{wxSocketBase}}{wxsocketbasedestruct}\\
-\helpref{wxDestroy}{wxsocketbasedestroy}
+\helpref{Destroy}{wxsocketbasedestroy}
\membersection{Socket state}
Callback functions are also available, but they are provided for backwards
compatibility only. Their use is strongly discouraged in favour of events,
and should be considered deprecated. Callbacks may be unsupported in future
-releases of wxWindows.
+releases of wxWidgets.
\helpref{Callback}{wxsocketbasecallback}\\
\helpref{CallbackData}{wxsocketbasecallbackdata}
\end{verbatim}
The first parameter is a reference to the socket object in which the
-event occured. The second parameter tells you which event occured.
+event occurred. The second parameter tells you which event occurred.
(See \helpref{wxSocket events}{wxsocketbase}). The third parameter
is the user data you specified using \helpref{CallbackData}{wxsocketbasecallbackdata}.
-Note that events are preferred over callbacks where possible.
-
\wxheading{Return value}
A pointer to the previous callback.
+\wxheading{Remark/Warning}
+
+Note that callbacks are now deprecated and unsupported, and they remain
+for backwards compatibility only. Use events instead.
+
\wxheading{See also}
\helpref{wxSocketBase::CallbackData}{wxsocketbasecallbackdata},
This function sets the the user data which will be passed to a
callback function set via \helpref{Callback}{wxsocketbasecallback}.
-Note that events are preferred over callbacks where possible.
-
\wxheading{Return value}
A pointer to the previous user data.
+\wxheading{Remark/Warning}
+
+Note that callbacks are now deprecated and unsupported, and they remain
+for backwards compatibility only. Use events instead.
+
+\wxheading{See also}
+
\helpref{wxSocketBase::Callback}{wxsocketbasecallback},
\helpref{wxSocketBase::SetNotify}{wxsocketbasesetnotify},
\helpref{wxSocketBase::Notify}{wxsocketbasenotify}
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. This means that you don't need to do it yourself, unless you
-explicitly want to disable further operation.
+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.
\wxheading{Remark/Warning}
\wxheading{Return value}
-Always TRUE.
+Always true.
%
% Discard
Use \helpref{LastCount}{wxsocketbaselastcount} to verify the number of bytes actually discarded.
-If you use \helpref{Error}{wxsocketbaseerror}, it will always return FALSE.
+If you use \helpref{Error}{wxsocketbaseerror}, it will always return false.
%
% Error
\constfunc{bool}{Error}{\void}
-Returns TRUE if an error occured in the last IO operation.
+Returns true if an error occurred in the last IO operation.
Use this function to check for an error condition after one of the
following calls: Discard, Peek, Read, ReadMsg, Unread, Write, WriteMsg.
%
\membersection{wxSocketBase::GetLocal}\label{wxsocketbasegetlocal}
-\constfunc{bool}{GetLocal}{\param{wxSockAddress\& }{addr\_man}}
+\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
\wxheading{Return value}
-It returns TRUE if no errors happened, FALSE otherwise.
+true if no error happened, false otherwise.
%
% GetFlags
%
\membersection{wxSocketBase::GetPeer}\label{wxsocketbasegetpeer}
-\constfunc{bool}{GetPeer}{\param{wxSockAddress\& }{addr\_man}}
+\constfunc{bool}{GetPeer}{\param{wxSockAddress\& }{addr}}
This function returns the peer address field of the socket. The peer
address field contains the complete peer host address of the socket
\wxheading{Return value}
-It returns TRUE if no errors happened, FALSE otherwise.
+true if no error happened, false otherwise.
%
% InterruptWait
\constfunc{bool}{IsConnected}{\void}
-Returns TRUE if the socket is connected.
+Returns true if the socket is connected.
%
% IsData
%
\constfunc{bool}{IsDisconnected}{\void}
-Returns TRUE if the socket is not connected.
+Returns true if the socket is not connected.
\membersection{wxSocketBase::LastCount}\label{wxsocketbaselastcount}
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 occured (this
+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
+if the last IO call failed. If this returns true, use LastError
to discover the cause of the error.
%
\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
+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
+be sent to the application. If {\it notify} is false; no events
will be sent.
%
\constfunc{bool}{Ok}{\void}
-Returns TRUE if the socket is initialized and ready and FALSE in other
+Returns true if the socket is initialized and ready and false in other
cases.
\wxheading{Remark/Warning}
-For \helpref{wxSocketClient}{wxsocketclient}, Ok won't return TRUE unless
+For \helpref{wxSocketClient}{wxsocketclient}, Ok won't return true unless
the client is connected to a server.
-For \helpref{wxSocketServer}{wxsocketserver}, Ok will return TRUE if the
+For \helpref{wxSocketServer}{wxsocketserver}, Ok will return true if the
server could bind to the specified address and is already listening for
new connections.
-Ok does not check for IO errors; use \helpref{Error}{wxsocketbaseerror}
-instead for that purpose.
+Ok does not check for IO errors;
+use \helpref{Error}{wxsocketbaseerror} instead for that purpose.
%
% RestoreState
\func{void}{SetClientData}{\param{void *}{data}}
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.
+contain a pointer to this data, which can be retrieved with
+the \helpref{wxSocketEvent::GetClientData}{wxsocketeventgetclientdata} function.
%
% SetEventHandler
%
\membersection{wxSocketBase::SetEventHandler}\label{wxsocketbaseseteventhandler}
-\func{void}{SetEventHandler}{\param{wxEvtHandler\&}{ evt\_hdlr}, \param{int}{ id = -1}}
+\func{void}{SetEventHandler}{\param{wxEvtHandler\&}{ handler}, \param{int}{ id = -1}}
Sets an event handler to be called when a socket event occurs. The
handler will be called for those events for which notification is
\wxheading{Parameters}
-\docparam{evt\_hdlr}{Specifies the event handler you want to use.}
+\docparam{handler}{Specifies the event handler you want to use.}
\docparam{id}{The id of socket event.}
%
\membersection{wxSocketBase::SetFlags}\label{wxsocketbasesetflags}
-\func{void}{SetFlags}{\param{wxSocketBase::wxSocketFlags}{ flags}}
+\func{void}{SetFlags}{\param{wxSocketFlags}{ flags}}
-Use SetFlags to customize IO operation for this socket. The {\it flags}
-parameter is a combination of flags ORed toghether. The following flags
-can be used:
+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:
\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
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.
+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
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.
+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
\func{void}{SetNotify}{\param{wxSocketEventFlags}{ flags}}
SetNotify specifies which socket events are to be sent to the event handler.
-The {\it flags} parameter is a 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}
\begin{verbatim}
sock.SetNotify(wxSOCKET_INPUT_FLAG | wxSOCKET_LOST_FLAG);
- sock.Notify(TRUE);
+ sock.Notify(true);
\end{verbatim}
In this example, the user will be notified about incoming socket data and
\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 is set to 10 minutes.
+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.
%
% Peek
If you use \helpref{LastCount}{wxsocketbaselastcount}, it will always return {\it nbytes}.
-If you use \helpref{Error}{wxsocketbaseerror}, it will always return FALSE.
+If you use \helpref{Error}{wxsocketbaseerror}, it will always return false.
\wxheading{Parameters}
\func{bool}{Wait}{\param{long}{ seconds = -1}, \param{long}{ millisecond = 0}}
-This function waits until one of the following conditions is TRUE. Note
-that it is recommended to use the individual Wait functions to wait for
-the required condition, instead of this one.
+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 (only for clients)
-\item An incoming connection request has arrived (only for servers)
+\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}
+Note that it is recommended to use the individual Wait functions
+to wait for the required condition, instead of this one.
+
\wxheading{Parameters}
\docparam{seconds}{Number of seconds to wait.
\wxheading{Return value}
-Returns TRUE when any of the above conditions is satisfied,
-FALSE if the timeout was reached.
+Returns true when any of the above conditions is satisfied,
+false if the timeout was reached.
\wxheading{See also}
\wxheading{Return value}
-Returns TRUE if the connection was lost, FALSE if the timeout was reached.
+Returns true if the connection was lost, false if the timeout was reached.
\wxheading{See also}
\wxheading{Return value}
-Returns TRUE if the socket becomes readable, FALSE on timeout.
+Returns true if the socket becomes readable, false on timeout.
\wxheading{See also}
\wxheading{Return value}
-Returns TRUE if the socket becomes writable, FALSE on timeout.
+Returns true if the socket becomes writable, false on timeout.
\wxheading{See also}
%
\membersection{wxSocketClient::wxSocketClient}
-\func{}{wxSocketClient}{\param{wxSocketFlags}{ flags = wxSOCKET_NONE}}
+\func{}{wxSocketClient}{\param{wxSocketFlags}{ flags = wxSOCKET\_NONE}}
Constructor.
\func{}{\destruct{wxSocketClient}}{\void}
-Destructor.
+Destructor. Please see \helpref{wxSocketBase::Destroy}{wxsocketbasedestroy}.
%
% Connect
%
\membersection{wxSocketClient::Connect}\label{wxsocketclientconnect}
-\func{bool}{Connect}{\param{wxSockAddress\&}{ address}, \param{bool}{ wait = TRUE}}
+\func{bool}{Connect}{\param{wxSockAddress\&}{ address}, \param{bool}{ wait = true}}
Connects to a server using the specified address.
-If {\it wait} is TRUE, Connect will wait until the connection completes.
-{\bf Warning:} This will block the GUI.
+If {\it wait} is true, Connect will wait until the connection
+completes. {\bf Warning:} This will block the GUI.
-If {\it wait} is FALSE, Connect will try to establish the connection and
+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.
+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).
\docparam{address}{Address of the server.}
-\docparam{wait}{If TRUE, waits for the connection to complete.}
+\docparam{wait}{If true, waits for the connection to complete.}
\wxheading{Return value}
-Returns TRUE if the connection is established and no error occurs.
+Returns true if the connection is established and no error occurs.
-If {\it wait} was TRUE, and Connect returns FALSE, an error occured
+If {\it wait} was true, and Connect returns false, an error occurred
and the connection failed.
-If {\it wait} was FALSE, and Connect returns FALSE, you should still
+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.
+with \helpref{WaitOnConnect}{wxsocketclientwaitonconnect} or by
+watching {\bf wxSOCKET\_CONNECTION} and {\bf wxSOCKET\_LOST} events.
\wxheading{See also}
\func{bool}{WaitOnConnect}{\param{long}{ seconds = -1}, \param{long}{ milliseconds = 0}}
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.
+elapses. Use this function after issuing a call
+to \helpref{Connect}{wxsocketclientconnect} with {\it wait} set to false.
\wxheading{Parameters}
\wxheading{Return value}
-WaitOnConnect returns TRUE if the connection request completes. This
-does not necessarily mean that the connection was succesfully established;
+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.
-If the timeout elapses, WaitOnConnect returns FALSE.
+If the timeout elapses, WaitOnConnect returns false.
These semantics allow code like this:
\begin{verbatim}
// Issue the connection request
-client->Connect(addr, FALSE);
+client->Connect(addr, false);
// Wait until the request completes or until we decide to give up
-bool waitmore = TRUE;
+bool waitmore = true;
while ( !client->WaitOnConnect(seconds, millis) && waitmore )
{
// possibly give some feedback to the user,
- // and update waitmore if needed.
+ // and update waitmore as needed.
}
bool success = client->IsConnected();
\end{verbatim}
\wxheading{Event table macros}
-To process a socket event, use these event handler macros to direct input to member
-functions that take a wxSocketEvent argument.
+To process a socket event, use these event handler macros to direct input
+to member functions that take a wxSocketEvent argument.
\twocolwidtha{7cm}
\begin{twocollist}\itemsep=0pt
Returns the socket event type.
-% ---------------------------------------------------------------------------
-% CLASS: wxSocketServer
-% ---------------------------------------------------------------------------
-\section{\class{wxSocketServer}}\label{wxsocketserver}
-
-\wxheading{Derived from}
-
-\helpref{wxSocketBase}{wxsocketbase}
-
-\wxheading{Include files}
-
-<wx/socket.h>
-
-% ---------------------------------------------------------------------------
-% 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 occured 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 occured 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} for a detailed explanation
-
-%
-% 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}
-
projects / wxWidgets.git / blobdiff