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

... / ...

Commit	Line	Data
	1	% ----------------------------------------------------------------------------
	2	% CLASS: wxSockAddress
	3	% ----------------------------------------------------------------------------
	4	\section{\class{wxSockAddress}}\label{wxsockaddress}
	5
	6	\wxheading{Derived from}
	7
	8	\helpref{wxObject}{wxobject}
	9
	10	{\bf Actually, you don't have to use these functions: only wxSocketBase use it.}
	11
	12	\wxheading{See also}
	13
	14	\helpref{wxSocketBase}{wxsocketbase}\\
	15	\helpref{wxIPV4address}{wxipv4address}\\
	16	\helpref{wxIPV6address}{wxipv6address}\\
	17	\helpref{wxunixaddress}{wxunixaddress}
	18
	19	% ----------------------------------------------------------------------------
	20	% Members
	21	% ----------------------------------------------------------------------------
	22
	23	\latexignore{\rtfignore{\wxheading{Members}}}
	24
	25	%
	26	% ctor/dtor
	27	%
	28
	29	\membersection{wxSockAddress::wxSockAddress}
	30	\func{}{wxSockAddress}{\void}
	31
	32	Default constructor.
	33
	34	\membersection{wxSockAddress::\destruct{wxSockAddress}}
	35	\func{}{\destruct{wxSockAddress}}{\void}
	36
	37	Default destructor.
	38
	39	%
	40	% Clear
	41	%
	42	\membersection{wxSockAddress::Clear}
	43	\func{void}{Clear}{\void}
	44
	45	Delete all informations about the address.
	46
	47	%
	48	% Build
	49	%
	50	\membersection{wxSockAddress::Build}
	51	\func{void}{Build}{\param{struct sockaddr *\&}{ addr}, \param{size\_t\&}{ len}}
	52
	53	Build a coded socket address.
	54
	55	%
	56	% Disassemble
	57	%
	58	\membersection{wxSockAddress::Disassemble}
	59	\func{void}{Disassemble}{\param{struct sockaddr *}{addr}, \param{size\_t}{ len}}
	60
	61	Decode a socket address. {\bf Actually, you don't have to use this
	62	function: only wxSocketBase use it.}
	63
	64	%
	65	% SockAddrLen
	66	%
	67	\membersection{wxSockAddress::SockAddrLen}
	68	\func{int}{SockAddrLen}{\void};
	69
	70	Returns the length of the socket address.
	71
	72	% ----------------------------------------------------------------------------
	73	% CLASS: wxIPV4address
	74	% ----------------------------------------------------------------------------
	75	\section{\class{wxIPV4address}}\label{wxipv4address}
	76
	77	\wxheading{Derived from}
	78
	79	\helpref{wxSockAddress}{wxsockaddress}
	80
	81	% ----------------------------------------------------------------------------
	82	% MEMBERS
	83	% ----------------------------------------------------------------------------
	84
	85	\latexignore{\rtfignore{\wxheading{Members}}}
	86
	87	%
	88	% Hostname
	89	%
	90
	91	\membersection{wxIPV4address::Hostname}
	92	\func{bool}{Hostname}{\param{const wxString\&}{ hostname}}
	93
	94	Use the specified {\it hostname} for the address.
	95
	96	\wxheading{Return value}
	97
	98	Returns FALSE if something bad happens (invalid hostname, invalid IP address).
	99
	100	%
	101	% Hostname
	102	%
	103
	104	\membersection{wxIPV4address::Hostname}
	105	\func{wxString}{Hostname}{\void}
	106
	107	Returns the hostname which matches the IP address.
	108
	109	%
	110	% Service
	111	%
	112
	113	\membersection{wxIPV4address::Service}
	114	\func{bool}{Service}{\param{const wxString\&}{ service}}
	115
	116	Use the specified {\it service} string for the address.
	117
	118	\wxheading{Return value}
	119
	120	Returns FALSE if something bad happens (invalid service).
	121
	122	%
	123	% Service
	124	%
	125
	126	\membersection{wxIPV4address::Service}
	127	\func{bool}{Service}{\param{unsigned short}{ service}}
	128
	129	Use the specified {\it service} for the address.
	130
	131	\wxheading{Return value}
	132
	133	Returns FALSE if something bad happens (invalid service).
	134
	135	%
	136	% Service
	137	%
	138
	139	\membersection{wxIPV4address::Service}
	140	\func{unsigned short}{Service}{\void}
	141
	142	Returns the current service.
	143
	144	%
	145	% LocalHost
	146	%
	147
	148	\membersection{wxIPV4address::LocalHost}
	149	\func{bool}{LocalHost}{\void}
	150
	151	Initialize peer host to local host.
	152
	153	\wxheading{Return value}
	154
	155	Returns FALSE if something bad happens.