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}
	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	% IPAddress
	47	%
	48
	49	\membersection{wxIPV4address::IPAddress}
	50
	51	\func{wxString}{IPAddress}{\void}
	52
	53	Returns a wxString containing the IP address in dot quad (127.0.0.1) format.
	54
	55	%
	56	% Service
	57	%
	58
	59	\membersection{wxIPV4address::Service}
	60
	61	\func{bool}{Service}{\param{const wxString\&}{ service}}
	62
	63	Set the port to that corresponding to the specified {\it service}.
	64
	65	\wxheading{Return value}
	66
	67	Returns true on success, false if something goes wrong
	68	(invalid service).
	69
	70	%
	71	% Service
	72	%
	73
	74	\membersection{wxIPV4address::Service}
	75
	76	\func{bool}{Service}{\param{unsigned short}{ service}}
	77
	78	Set the port to that corresponding to the specified {\it service}.
	79
	80	\wxheading{Return value}
	81
	82	Returns true on success, false if something goes wrong
	83	(invalid service).
	84
	85	%
	86	% Service
	87	%
	88
	89	\membersection{wxIPV4address::Service}
	90
	91	\func{unsigned short}{Service}{\void}
	92
	93	Returns the current service.
	94
	95	%
	96	% AnyAddress
	97	%
	98
	99	\membersection{wxIPV4address::AnyAddress}\label{wxipv4addressanyaddress}
	100
	101	\func{bool}{AnyAddress}{\void}
	102
	103	Set address to any of the addresses of the current machine. Whenever
	104	possible, use this function instead of \helpref{wxIPV4address::LocalHost}{wxipv4addresslocalhost},
	105	as this correctly handles multi-homed hosts and avoids other small
	106	problems. Internally, this is the same as setting the IP address
	107	to {\bf INADDR\_ANY}.
	108
	109	\wxheading{Return value}
	110
	111	Returns true on success, false if something went wrong.
	112
	113	%
	114	% LocalHost
	115	%
	116
	117	\membersection{wxIPV4address::LocalHost}\label{wxipv4addresslocalhost}
	118
	119	\func{bool}{LocalHost}{\void}
	120
	121	Set address to localhost (127.0.0.1). Whenever possible, use the
	122	\helpref{wxIPV4address::AnyAddress}{wxipv4addressanyaddress},
	123	function instead of this one, as this will correctly handle multi-homed
	124	hosts and avoid other small problems.
	125
	126	\wxheading{Return value}
	127
	128	Returns true on success, false if something went wrong.
	129