X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b80dc5febe0017218e62726b52e32ee418eaa7e3..5a20d2ced0a0779b5d8b1cc8064f8404b2727e92:/docs/latex/wx/sckaddr.tex diff --git a/docs/latex/wx/sckaddr.tex b/docs/latex/wx/sckaddr.tex index 9c04a74b01..66b0c645ec 100644 --- a/docs/latex/wx/sckaddr.tex +++ b/docs/latex/wx/sckaddr.tex @@ -3,35 +3,38 @@ % ---------------------------------------------------------------------------- \section{\class{wxSockAddress}}\label{wxsockaddress} +You are unlikely to need to use this class: only wxSocketBase uses it. + \wxheading{Derived from} \helpref{wxObject}{wxobject} -{\bf Actually, you don't have to use these functions: only wxSocketBase use it.} +\wxheading{Include files} + + \wxheading{See also} -\helpref{wxSocketBase}{wxsocketbase}\\ -\helpref{wxIPV4address}{wxipv4address}\\ -\helpref{wxIPV6address}{wxipv6address}\\ -\helpref{wxunixaddress}{wxunixaddress} +\helpref{wxSocketBase}{wxsocketbase} +\helpref{wxIPaddress}{wxipaddress} +\helpref{wxIPV4address}{wxipv4address} % ---------------------------------------------------------------------------- % Members % ---------------------------------------------------------------------------- - \latexignore{\rtfignore{\wxheading{Members}}} % % ctor/dtor % +\membersection{wxSockAddress::wxSockAddress}\label{wxsockaddressctor} -\membersection{wxSockAddress::wxSockAddress} \func{}{wxSockAddress}{\void} Default constructor. -\membersection{wxSockAddress::\destruct{wxSockAddress}} +\membersection{wxSockAddress::\destruct{wxSockAddress}}\label{wxsockaddressdtor} + \func{}{\destruct{wxSockAddress}}{\void} Default destructor. @@ -39,117 +42,18 @@ Default destructor. % % Clear % -\membersection{wxSockAddress::Clear} +\membersection{wxSockAddress::Clear}\label{wxsockaddressclear} + \func{void}{Clear}{\void} Delete all informations about the address. -% -% Build -% -\membersection{wxSockAddress::Build} -\func{void}{Build}{\param{struct sockaddr *\&}{ addr}, \param{size\_t\&}{ len}} - -Build a coded socket address. - -% -% Disassemble -% -\membersection{wxSockAddress::Disassemble} -\func{void}{Disassemble}{\param{struct sockaddr *}{addr}, \param{size\_t}{ len}} - -Decode a socket address. {\bf Actually, you don't have to use this -function: only wxSocketBase use it.} - % % SockAddrLen % -\membersection{wxSockAddress::SockAddrLen} -\func{int}{SockAddrLen}{\void}; - -Returns the length of the socket address. - -% ---------------------------------------------------------------------------- -% CLASS: wxIPV4address -% ---------------------------------------------------------------------------- -\section{\class{wxIPV4address}}\label{wxipv4address} - -\wxheading{Derived from} - -\helpref{wxSockAddress}{wxsockaddress} - -% ---------------------------------------------------------------------------- -% MEMBERS -% ---------------------------------------------------------------------------- - -\latexignore{\rtfignore{\wxheading{Members}}} - -% -% Hostname -% - -\membersection{wxIPV4address::Hostname} -\func{bool}{Hostname}{\param{const wxString\&}{ hostname}} - -Use the specified {\it hostname} for the address. - -\wxheading{Return value} - -Returns FALSE if something bad happens (invalid hostname, invalid IP address). - -% -% Hostname -% - -\membersection{wxIPV4address::Hostname} -\func{wxString}{Hostname}{\void} - -Returns the hostname which matches the IP address. - -% -% Service -% - -\membersection{wxIPV4address::Service} -\func{bool}{Service}{\param{const wxString\&}{ service}} - -Use the specified {\it service} string for the address. +\membersection{wxSockAddress::SockAddrLen}\label{wxsockaddresssockaddrlen} -\wxheading{Return value} - -Returns FALSE if something bad happens (invalid service). - -% -% Service -% +\func{int}{SockAddrLen}{\void} -\membersection{wxIPV4address::Service} -\func{bool}{Service}{\param{unsigned short}{ service}} - -Use the specified {\it service} for the address. - -\wxheading{Return value} - -Returns FALSE if something bad happens (invalid service). - -% -% Service -% - -\membersection{wxIPV4address::Service} -\func{unsigned short}{Service}{\void} - -Returns the current service. - -% -% LocalHost -% - -\membersection{wxIPV4address::LocalHost} -\func{bool}{LocalHost}{\void} - -Initialize peer host to local host. - -\wxheading{Return value} +Returns the length of the socket address. -Returns FALSE if something bad happens.