X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/304b9d52cf2a01372ed0e83bd062812ad7d77c78..a0c2e4a050f4f2e8d344483ba4cfaa8b08a1fe87:/docs/latex/wx/socket.tex diff --git a/docs/latex/wx/socket.tex b/docs/latex/wx/socket.tex index 04a2515b89..52685b58cf 100644 --- a/docs/latex/wx/socket.tex +++ b/docs/latex/wx/socket.tex @@ -29,6 +29,10 @@ http://www.litwindow.com/knowhow/knowhow.html for more details. +\wxheading{Library} + +\helpref{wxNet}{librarieslist} + \wxheading{wxSocket errors} \twocolwidtha{7cm} @@ -127,7 +131,7 @@ Functions to retrieve current state and miscellaneous info. \helpref{IsDisconnected}{wxsocketbaseisdisconnected}\\ \helpref{LastCount}{wxsocketbaselastcount}\\ \helpref{LastError}{wxsocketbaselasterror}\\ -\helpref{Ok}{wxsocketbaseok}\\ +\helpref{IsOk}{wxsocketbaseisok}\\ \helpref{SaveState}{wxsocketbasesavestate}\\ \helpref{RestoreState}{wxsocketbaserestorestate} @@ -414,11 +418,11 @@ be sent to the application. If {\it notify} is false; no events will be sent. % -% Ok +% IsOk % -\membersection{wxSocketBase::Ok}\label{wxsocketbaseok} +\membersection{wxSocketBase::IsOk}\label{wxsocketbaseisok} -\constfunc{bool}{Ok}{\void} +\constfunc{bool}{IsOk}{\void} Returns true if the socket is initialized and ready and false in other cases. @@ -524,6 +528,8 @@ The following flags can be used: \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)} +\twocolitem{{\bf wxSOCKET\_BROADCAST}}{Switches the socket to broadcast mode} +\twocolitem{{\bf wxSOCKET\_NOBIND}}{Stops the socket from being bound to a specific adapter (normally used in conjunction with {\bf wxSOCKET\_BROADCAST})} \end{twocollist} A brief overview on how to use these flags follows. @@ -568,6 +574,10 @@ your platform's implementation of setsockopt(). Note that on BSD-based systems ( use of wxSOCKET\_REUSEADDR implies SO\_REUSEPORT in addition to SO\_REUSEADDR to be consistent with Windows. +The {\bf wxSOCKET\_BROADCAST} flag controls the use of the SO\_BROADCAST standard +setsockopt() flag. This flag allows the socket to use the broadcast address, and is generally +used in conjunction with {\bf wxSOCKET\_NOBIND} and \helpref{wxIPaddress::BroadcastAddress}{wxipaddressbroadcastaddress}. + So: {\bf wxSOCKET\_NONE} will try to read at least SOME data, no matter how much. @@ -996,12 +1006,17 @@ For a detailed explanation, see \helpref{wxSocketBase::SetFlags}{wxsocketbaseset \wxheading{Derived from} -\helpref{wxSocketBase}{wxsocketbase} +\helpref{wxSocketBase}{wxsocketbase}\\ +\helpref{wxObject}{wxobject} \wxheading{Include files} +\wxheading{Library} + +\helpref{wxNet}{librarieslist} + \latexignore{\rtfignore{\wxheading{Members}}} % --------------------------------------------------------------------------- @@ -1139,12 +1154,17 @@ This event class contains information about socket events. \wxheading{Derived from} -\helpref{wxEvent}{wxevent} +\helpref{wxEvent}{wxevent}\\ +\helpref{wxObject}{wxobject} \wxheading{Include files} +\wxheading{Library} + +\helpref{wxNet}{librarieslist} + \wxheading{Event table macros} To process a socket event, use these event handler macros to direct input