X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9f3430a6d4dc05528ecf1a8a65a25452484ef7ae..8bb8ab39dd433191764a64b4f96344399b113d1b:/docs/latex/wx/socket.tex diff --git a/docs/latex/wx/socket.tex b/docs/latex/wx/socket.tex index 70fdb9dc50..d224507f85 100644 --- a/docs/latex/wx/socket.tex +++ b/docs/latex/wx/socket.tex @@ -4,6 +4,14 @@ \helpref{wxEvtHandler}{wxevthandler} +\wxheading{Include files} + + + +\wxheading{See also} + +GSocket for wxWindows + % --------------------------------------------------------------------------- % Event handling % --------------------------------------------------------------------------- @@ -49,6 +57,46 @@ Destroys the wxSocketBase object. % State functions % --------------------------------------------------------------------------- +% +% SetFlags +% + +\membersection{wxSocketBase::SetFlags}\label{wxsocketbasesetflags} + +\func{void}{SetFlags}{\param{wxSocketBase::wxSockFlags}{ flags}} + +\twocolwidtha{7cm} +\begin{twocollist}\itemsep=0pt +\twocolitem{{\bf wxSocketBase::NONE}}{Normal functionnalities.} +\twocolitem{{\bf wxSocketBase::NOWAIT}}{Get the available data in the input queue and exit immediately.} +\twocolitem{{\bf wxSocketBase::WAITALL}}{Wait for all required data unless an error occured.} +\twocolitem{{\bf wxSocketBase::SPEED}}{Disable the asynchronous IO functionnality.} +\end{twocollist} + +% +% SetNotify +% +\membersection{wxSocketBase::SetNotify}\label{wxsocketbasesetnotify} + +\func{void}{SetNotify}{\param{GSocketEventFlags}{ event_flags}} + +SetNotify setups which socket events are to be sent to the event handler. +For more information on socket events see GSocket events. + +% +% Notify +% +\membersection{wxSocketBase::Notify}\label{wxsocketbasenotify} + +\func{void}{Notify}{\param{bool}{ notify}} + +Notify will enable (notify is TRUE) or disable (notify is FALSE) the propagation +of socket events. + +% +% Ok +% + \membersection{wxSocketBase::Ok}\label{wxsocketbaseok} \constfunc{bool}{Ok}{\void} @@ -94,9 +142,9 @@ Returns the number of bytes read or written by the last IO call. \membersection{wxSocketBase::LastError}\label{wxsocketbaselasterror} -\constfunc{int}{LastError}{\void} +\constfunc{GSocketError}{LastError}{\void} -Returns an error in the errno format (see your C programmer's guide). +Returns an error in the GSocket format. See GSocket errors. % --------------------------------------------------------------------------- % IO calls @@ -165,21 +213,9 @@ This remark is also valid for all IO call. \helpref{wxSocketBase::Error}{wxsocketbaseerror}, \helpref{wxSocketBase::LastCount}{wxsocketbaselastcount}, \helpref{wxSocketBase::LastError}{wxsocketbaselasterror} - -\membersection{wxSocketBase::SetFlags}\label{wxsocketbasesetflags} - -\func{void}{SetFlags}{\param{wxSockFlags}{ flags}} - -\twocolwidtha{7cm} -\begin{twocollist}\itemsep=0pt -\twocolitem{{\bf wxSocketBase::NONE}}{Normal functionnalities.} -\twocolitem{{\bf wxSocketBase::NOWAIT}}{Get the available data in the input queue and exit immediately.} -\twocolitem{{\bf wxSocketBase::WAITALL}}{Wait for all required data unless an error occured.} -\twocolitem{{\bf wxSocketBase::SPEED}}{Disable the asynchronous IO functionnality.} -\end{twocollist} % -% Read +% Write % \membersection{wxSocketBase::Write}\label{wxsocketbasewrite} @@ -274,9 +310,9 @@ Returns a reference to the current object. % % Unread % -\membersection{wxSocketBase::UnRead}\label{wxsocketbaseunread} +\membersection{wxSocketBase::Unread}\label{wxsocketbaseunread} -\func{wxSocketBase\&}{UnRead}{\param{const char *}{ buffer}, \param{size\_t}{ nbytes}} +\func{wxSocketBase\&}{Unread}{\param{const char *}{ buffer}, \param{size\_t}{ nbytes}} 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. @@ -469,6 +505,10 @@ Sets an event handler to be called when a socket event occured. \helpref{wxSocketBase}{wxsocketbase} +\wxheading{Include files} + + + % --------------------------------------------------------------------------- % Members % --------------------------------------------------------------------------- @@ -481,8 +521,6 @@ Sets an event handler to be called when a socket event occured. Constructs a new wxSocketClient. -{\bf Warning !} The created socket client needs to be registered to a socket handler (See \helpref{wxSocketHandler}{wxsockethandler}). - \wxheading{Parameters} \docparam{flags}{Socket flags (See \helpref{wxSocketBase::SetFlags}{wxsocketbasesetflags})} @@ -494,7 +532,7 @@ Constructs a new wxSocketClient. \func{}{\destruct{wxSocketClient}}{\void} -Destructs a wxSocketClient object. +Destroys a wxSocketClient object. % % Connect @@ -544,6 +582,10 @@ This event class contains information about socket events. \helpref{wxEvent}{wxevent} +\wxheading{Include files} + + + \wxheading{Event table macros} To process a socket event, use these event handler macros to direct input to member @@ -556,7 +598,6 @@ functions that take a wxSocketEvent argument. \wxheading{See also} -\helpref{wxSocketHandler}{wxsockethandler},\rtfsp \helpref{wxSocketBase}{wxsocketbase},\rtfsp \helpref{wxSocketClient}{wxsocketclient},\rtfsp \helpref{wxSocketServer}{wxsocketserver} @@ -571,159 +612,10 @@ Constructor. \membersection{wxSocketEvent::SocketEvent}\label{wxsocketeventsocketevent} -\constfunc{wxSocketBase::wxRequestEvent}{SocketEvent}{\void} +\constfunc{GSocketEvent}{SocketEvent}{\void} Returns the socket event type. -% --------------------------------------------------------------------------- -% CLASS: wxSocketHandler -% --------------------------------------------------------------------------- -\section{\class{wxSocketHandler}}\label{wxsockethandler} - -\wxheading{Derived from} - -\helpref{wxObject}{wxobject} - -% --------------------------------------------------------------------------- -% Members -% --------------------------------------------------------------------------- -\latexignore{\rtfignore{\wxheading{Members}}} - -% -% wxSocketHandler -% -\membersection{wxSocketHandler::wxSocketHandler} - -\func{}{wxSocketHandler}{\void} - -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. - -% -% ~wxSocketHandler -% -\membersection{wxSocketHandler::\destruct{wxSocketHandler}} - -\func{}{\destruct{wxSocketHandler}}{\void} - -Destructs a wxSocketHandler object. - -% -% Register -% -\membersection{wxSocketHandler::Register} - -\func{void}{Register}{\param{wxSocketBase *}{socket}} - -Register a socket: if it is already registered in this handler it will just -return immediately. - -\wxheading{Parameters} - -\docparam{socket}{Socket to be registered.} - -% -% UnRegister -% -\membersection{wxSocketHandler::UnRegister} - -\func{void}{UnRegister}{\param{wxSocketBase *}{socket}} - -UnRegister a socket: if it isn't registered in this handler it will just -return. - -\wxheading{Parameters} - -\docparam{socket}{Socket to be unregistered.} - -% -% Count -% -\membersection{wxSocketHandler::Count} - -\constfunc{unsigned long}{Count}{\void} - -Returns the number of sockets registered in the handler. - -\wxheading{Return value} - -Number of sockets registered. - -% -% CreateServer -% -\membersection{wxSocketHandler::CreateServer} - -\func{wxSocketServer *}{CreateServer}{\param{wxSockAddress\&}{ address}, \param{wxSocketBase::wxSockFlags}{ flags = wxSocketbase::NONE}} - -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}. - -\wxheading{Return value} - -Returns a new socket server. - -% -% CreateClient -% -\membersection{wxSocketHandler::CreateClient} - -\func{wxSocketServer *}{CreateClient}{\param{wxSocketBase::wxSockFlags}{ flags = wxSocketbase::NONE}} - -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}. - -\wxheading{Return value} - -Returns a new socket client. - -% -% Master -% -\membersection{wxSocketHandler::Master}\label{wxsockethandlermaster} - -\func{static wxSocketHandler\&}{Master}{\void} - -Returns a default socket handler. - -% -% Wait -% -\membersection{wxSocketHandler::Wait} - -\func{int}{Wait}{\param{long}{ seconds},\param{long}{ microseconds}} - -Wait for an event on all registered sockets. - -\wxheading{Parameters} - -\docparam{seconds}{Number of seconds to wait. By default, it waits infinitely.} - -\docparam{microsecond}{Number of microseconds to wait.} - -\wxheading{Return value} - -Returns 0 if a timeout occured, else the number of events detected. - -\wxheading{See also} - -\helpref{wxSocketBase::Wait}{wxsocketbasewait} - -% -% YieldSock -% -\membersection{wxSocketHandler::YieldSock} - -\func{void}{YieldSock}{\void} - -Execute pending requests in all registered sockets. - % --------------------------------------------------------------------------- % CLASS: wxSocketServer % --------------------------------------------------------------------------- @@ -733,6 +625,10 @@ Execute pending requests in all registered sockets. \helpref{wxSocketBase}{wxsocketbase} +\wxheading{Include files} + + + % --------------------------------------------------------------------------- % Members % --------------------------------------------------------------------------- @@ -747,9 +643,6 @@ Execute pending requests in all registered sockets. Constructs a new wxSocketServer. -{\bf Warning !} The created object needs to be registered to a socket handler -(see \helpref{wxSocketHandler}{wxsockethandler}). - \wxheading{Parameters} \docparam{address}{Specifies the local address for the server (e.g. port number).} @@ -763,7 +656,7 @@ Constructs a new wxSocketServer. \func{}{\destruct{wxSocketServer}}{\void} -Destructs a wxSocketServer object (it doesn't close the accepted connection). +Destroys a wxSocketServer object (it doesn't close the accepted connection). % % Accept @@ -800,4 +693,3 @@ This is useful when someone wants to inherit wxSocketBase. Returns TRUE if no error occurs, else FALSE. -