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