[wxWidgets.git] / docs / latex / wx / ipaddr.tex

% ----------------------------------------------------------------------------
% CLASS: wxIPaddress
% ----------------------------------------------------------------------------
\section{\class{wxIPaddress}}\label{wxipaddress}

wxIPaddress is an abstract base class for all internet protocol address 
objects. Currently, only \helpref{wxIPV4address}{wxipv4address} 
is implemented. An experimental implementation for IPV6, wxIPV6address,
is being developed.

\wxheading{Derived from}

\helpref{wxSockAddress}{wxsockaddress}

\wxheading{Include files}

<wx/socket.h>

% ----------------------------------------------------------------------------
% MEMBERS
% ----------------------------------------------------------------------------
\latexignore{\rtfignore{\wxheading{Members}}}

%
% Hostname
%

\membersection{wxIPaddress::Hostname}

\func{virtual bool}{Hostname}{\param{const wxString\&}{ hostname}}

Set the address to {\it hostname}, which can be a host name
or an IP-style address in a format dependent on implementation.

\wxheading{Return value}

Returns true on success, false if something goes wrong
(invalid hostname or invalid IP address).

%
% Hostname
%

\membersection{wxIPaddress::Hostname}

\func{virtual wxString}{Hostname}{\void}

Returns the hostname which matches the IP address.

%
% IPAddress
%

\membersection{wxIPaddress::IPAddress}

\func{virtual wxString}{IPAddress}{\void}

Returns a wxString containing the IP address.

%
% Service
%

\membersection{wxIPaddress::Service}

\func{virtual bool}{Service}{\param{const wxString\&}{ service}}

Set the port to that corresponding to the specified {\it service}.

\wxheading{Return value}

Returns true on success, false if something goes wrong
(invalid service).

%
% Service
%

\membersection{wxIPaddress::Service}

\func{virtual bool}{Service}{\param{unsigned short}{ service}}

Set the port to that corresponding to the specified {\it service}.

\wxheading{Return value}

Returns true on success, false if something goes wrong
(invalid service).

%
% Service
%

\membersection{wxIPaddress::Service}

\func{virtual unsigned short}{Service}{\void}

Returns the current service.

%
% AnyAddress
%

\membersection{wxIPaddress::AnyAddress}\label{wxIPaddressanyaddress}

\func{virtual bool}{AnyAddress}{\void}

Internally, this is the same as setting the IP address
to {\bf INADDR\_ANY}.

On IPV4 implementations, 0.0.0.0

On IPV6 implementations, ::

\wxheading{Return value}

Returns true on success, false if something went wrong.

%
% LocalHost
%

\membersection{wxIPaddress::LocalHost}\label{wxIPaddresslocalhost}

\func{virtual bool}{LocalHost}{\void}

Set address to localhost. 

On IPV4 implementations, 127.0.0.1

On IPV6 implementations, ::1

\wxheading{Return value}

Returns true on success, false if something went wrong.

\membersection{wxIPaddress::IsLocalHost}\label{wxIPaddressislocalhost}

\func{virtual bool}{IsLocalHost}{\void}

Determines if current address is set to localhost. 

\wxheading{Return value}

Returns true if address is localhost, false if internet address.
Commit	Line	Data
be4bd463 JS	1	% ----------------------------------------------------------------------------
	2	% CLASS: wxIPaddress
	3	% ----------------------------------------------------------------------------
	4	\section{\class{wxIPaddress}}\label{wxipaddress}
	5
	6	wxIPaddress is an abstract base class for all internet protocol address
	7	objects. Currently, only \helpref{wxIPV4address}{wxipv4address}
	8	is implemented. An experimental implementation for IPV6, wxIPV6address,
	9	is being developed.
	10
	11	\wxheading{Derived from}
	12
	13	\helpref{wxSockAddress}{wxsockaddress}
	14
	15	\wxheading{Include files}
	16
	17	<wx/socket.h>
	18
	19	% ----------------------------------------------------------------------------
	20	% MEMBERS
	21	% ----------------------------------------------------------------------------
	22	\latexignore{\rtfignore{\wxheading{Members}}}
	23
	24	%
	25	% Hostname
	26	%
	27
	28	\membersection{wxIPaddress::Hostname}
	29
	30	\func{virtual bool}{Hostname}{\param{const wxString\&}{ hostname}}
	31
	32	Set the address to {\it hostname}, which can be a host name
	33	or an IP-style address in a format dependent on implementation.
	34
	35	\wxheading{Return value}
	36
	37	Returns true on success, false if something goes wrong
	38	(invalid hostname or invalid IP address).
	39
	40	%
	41	% Hostname
	42	%
	43
	44	\membersection{wxIPaddress::Hostname}
	45
	46	\func{virtual wxString}{Hostname}{\void}
	47
	48	Returns the hostname which matches the IP address.
	49
	50	%
	51	% IPAddress
	52	%
	53
	54	\membersection{wxIPaddress::IPAddress}
	55
	56	\func{virtual wxString}{IPAddress}{\void}
	57
	58	Returns a wxString containing the IP address.
	59
	60	%
	61	% Service
	62	%
	63
	64	\membersection{wxIPaddress::Service}
65
66	\func{virtual bool}{Service}{\param{const wxString\&}{ 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{wxIPaddress::Service}
80
81	\func{virtual bool}{Service}{\param{unsigned short}{ service}}
82
83	Set the port to that corresponding to the specified {\it service}.
84
85	\wxheading{Return value}
86
87	Returns true on success, false if something goes wrong
88	(invalid service).
89
90	%
91	% Service
92	%
93
94	\membersection{wxIPaddress::Service}
95
96	\func{virtual unsigned short}{Service}{\void}
97
98	Returns the current service.
99
100	%
101	% AnyAddress
102	%
103
104	\membersection{wxIPaddress::AnyAddress}\label{wxIPaddressanyaddress}
105
106	\func{virtual bool}{AnyAddress}{\void}
107
108	Internally, this is the same as setting the IP address
109	to {\bf INADDR\_ANY}.
110
111	On IPV4 implementations, 0.0.0.0
112
113	On IPV6 implementations, ::
114
115	\wxheading{Return value}
116
117	Returns true on success, false if something went wrong.
118
119	%
120	% LocalHost
121	%
122
123	\membersection{wxIPaddress::LocalHost}\label{wxIPaddresslocalhost}
124
125	\func{virtual bool}{LocalHost}{\void}
126
127	Set address to localhost.
128
129	On IPV4 implementations, 127.0.0.1
130
131	On IPV6 implementations, ::1
132
133	\wxheading{Return value}
134
135	Returns true on success, false if something went wrong.
136
461fb267	137	\membersection{wxIPaddress::IsLocalHost}\label{wxIPaddressislocalhost}
be4bd463 JS	138
	139	\func{virtual bool}{IsLocalHost}{\void}
	140
	141	Determines if current address is set to localhost.
	142
	143	\wxheading{Return value}
	144
	145	Returns true if address is localhost, false if internet address.
	146