| 1 | % ---------------------------------------------------------------------------- |
| 2 | % CLASS: wxIPV4address |
| 3 | % ---------------------------------------------------------------------------- |
| 4 | \section{\class{wxIPV4address}}\label{wxipv4address} |
| 5 | |
| 6 | \wxheading{Derived from} |
| 7 | |
| 8 | \helpref{wxSockAddress}{wxsockaddress} |
| 9 | |
| 10 | \wxheading{Include files} |
| 11 | |
| 12 | <wx/socket.h> |
| 13 | |
| 14 | % ---------------------------------------------------------------------------- |
| 15 | % MEMBERS |
| 16 | % ---------------------------------------------------------------------------- |
| 17 | \latexignore{\rtfignore{\wxheading{Members}}} |
| 18 | |
| 19 | % |
| 20 | % Hostname |
| 21 | % |
| 22 | |
| 23 | \membersection{wxIPV4address::Hostname} |
| 24 | |
| 25 | \func{bool}{Hostname}{\param{const wxString\&}{ hostname}} |
| 26 | |
| 27 | Set the address to {\it hostname}, which can be a host name |
| 28 | or an IP-style address in dot notation (a.b.c.d) |
| 29 | |
| 30 | \wxheading{Return value} |
| 31 | |
| 32 | Returns true on success, false if something goes wrong |
| 33 | (invalid hostname or invalid IP address). |
| 34 | |
| 35 | % |
| 36 | % Hostname |
| 37 | % |
| 38 | |
| 39 | \membersection{wxIPV4address::Hostname} |
| 40 | |
| 41 | \func{wxString}{Hostname}{\void} |
| 42 | |
| 43 | Returns the hostname which matches the IP address. |
| 44 | |
| 45 | % |
| 46 | % Service |
| 47 | % |
| 48 | |
| 49 | \membersection{wxIPV4address::Service} |
| 50 | |
| 51 | \func{bool}{Service}{\param{const wxString\&}{ service}} |
| 52 | |
| 53 | Set the port to that corresponding to the specified {\it service}. |
| 54 | |
| 55 | \wxheading{Return value} |
| 56 | |
| 57 | Returns true on success, false if something goes wrong |
| 58 | (invalid service). |
| 59 | |
| 60 | % |
| 61 | % Service |
| 62 | % |
| 63 | |
| 64 | \membersection{wxIPV4address::Service} |
| 65 | |
| 66 | \func{bool}{Service}{\param{unsigned short}{ service}} |
| 67 | |
| 68 | Set the port to that corresponding to the specified {\it service}. |
| 69 | |
| 70 | \wxheading{Return value} |
| 71 | |
| 72 | Returns true on success, false if something goes wrong |
| 73 | (invalid service). |
| 74 | |
| 75 | % |
| 76 | % Service |
| 77 | % |
| 78 | |
| 79 | \membersection{wxIPV4address::Service} |
| 80 | |
| 81 | \func{unsigned short}{Service}{\void} |
| 82 | |
| 83 | Returns the current service. |
| 84 | |
| 85 | % |
| 86 | % AnyAddress |
| 87 | % |
| 88 | |
| 89 | \membersection{wxIPV4address::AnyAddress}\label{wxipv4addressanyaddress} |
| 90 | |
| 91 | \func{bool}{AnyAddress}{\void} |
| 92 | |
| 93 | Set address to any of the addresses of the current machine. Whenever |
| 94 | possible, use this function instead of \helpref{wxIPV4address::LocalHost}{wxipv4addresslocalhost}, |
| 95 | as this correctly handles multi-homed hosts and avoids other small |
| 96 | problems. Internally, this is the same as setting the IP address |
| 97 | to {\bf INADDR\_ANY}. |
| 98 | |
| 99 | \wxheading{Return value} |
| 100 | |
| 101 | Returns true on success, false if something went wrong. |
| 102 | |
| 103 | % |
| 104 | % LocalHost |
| 105 | % |
| 106 | |
| 107 | \membersection{wxIPV4address::LocalHost}\label{wxipv4addresslocalhost} |
| 108 | |
| 109 | \func{bool}{LocalHost}{\void} |
| 110 | |
| 111 | Set address to localhost (127.0.0.1). Whenever possible, use the |
| 112 | \helpref{wxIPV4address::AnyAddress}{wxipv4addressanyaddress}, |
| 113 | function instead of this one, as this will correctly handle multi-homed |
| 114 | hosts and avoid other small problems. |
| 115 | |
| 116 | \wxheading{Return value} |
| 117 | |
| 118 | Returns true on success, false if something went wrong. |
| 119 | |