git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

Commit	Line	Data
	1	% ----------------------------------------------------------------------------
	2	% CLASS: wxIPV4address
	3	% ----------------------------------------------------------------------------
	4	\section{\class{wxIPV4address}}\label{wxipv4address}
	5
	6	\wxheading{Derived from}
	7
	8	\helpref{wxIPaddress}{wxipaddress}
	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}\label{wxipv4addresshostname}
	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	\func{wxString}{Hostname}{\void}
	36
	37	Returns the hostname which matches the IP address.
	38
	39	%
	40	% IPAddress
	41	%
	42
	43	\membersection{wxIPV4address::IPAddress}\label{wxipv4addressipaddress}
	44
	45	\func{wxString}{IPAddress}{\void}
	46
	47	Returns a wxString containing the IP address in dot quad (127.0.0.1) format.
	48
	49	%
	50	% Service
	51	%
	52
	53	\membersection{wxIPV4address::Service}\label{wxipv4addressservice}
	54
	55	\func{bool}{Service}{\param{const wxString\&}{ service}}
	56
	57	Set the port to that corresponding to the specified {\it service}.
	58
	59	\wxheading{Return value}
	60
	61	Returns true on success, false if something goes wrong
	62	(invalid service).
	63
	64	\func{bool}{Service}{\param{unsigned short}{ service}}
	65
	66	Set the port to that corresponding to the specified {\it service}.
	67
	68	\wxheading{Return value}
	69
	70	Returns true on success, false if something goes wrong
	71	(invalid service).
	72
	73	\func{unsigned short}{Service}{\void}
	74
	75	Returns the current service.
	76
	77	%
	78	% AnyAddress
	79	%
	80
	81	\membersection{wxIPV4address::AnyAddress}\label{wxipv4addressanyaddress}
	82
	83	\func{bool}{AnyAddress}{\void}
	84
	85	Set address to any of the addresses of the current machine. Whenever
	86	possible, use this function instead of \helpref{wxIPV4address::LocalHost}{wxipv4addresslocalhost},
	87	as this correctly handles multi-homed hosts and avoids other small
	88	problems. Internally, this is the same as setting the IP address
	89	to {\bf INADDR\_ANY}.
	90
	91	\wxheading{Return value}
	92
	93	Returns true on success, false if something went wrong.
	94
	95	%
	96	% LocalHost
	97	%
	98
	99	\membersection{wxIPV4address::LocalHost}\label{wxipv4addresslocalhost}
	100
	101	\func{bool}{LocalHost}{\void}
	102
	103	Set address to localhost (127.0.0.1). Whenever possible, use the
	104	\helpref{wxIPV4address::AnyAddress}{wxipv4addressanyaddress},
	105	function instead of this one, as this will correctly handle multi-homed
	106	hosts and avoid other small problems.
	107
	108	\wxheading{Return value}
	109
	110	Returns true on success, false if something went wrong.
	111