docs/latex/wx/sckaddr.tex

   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
  31 \func{}{wxSockAddress}{\void}
  32
  33 Default constructor.
  34
  35 \membersection{wxSockAddress::\destruct{wxSockAddress}}
  36
  37 \func{}{\destruct{wxSockAddress}}{\void}
  38
  39 Default destructor.
  40
  41 %
  42 % Clear
  43 %
  44 \membersection{wxSockAddress::Clear}
  45 \func{void}{Clear}{\void}
  46
  47 Delete all informations about the address.
  48
  49 %
  50 % Build
  51 %
  52 \membersection{wxSockAddress::Build}
  53
  54 \func{void}{Build}{\param{struct sockaddr *\&}{ addr}, \param{size\_t\&}{ len}}
  55
  56 Build a coded socket address.
  57
  58 %
  59 % Disassemble
  60 %
  61 \membersection{wxSockAddress::Disassemble}
  62
  63 \func{void}{Disassemble}{\param{struct sockaddr *}{addr}, \param{size\_t}{ len}}
  64
  65 Decode a socket address. {\bf Actually, you don't have to use this
  66 function: only wxSocketBase use it.}
  67
  68 %
  69 % SockAddrLen
  70 %
  71 \membersection{wxSockAddress::SockAddrLen}
  72
  73 \func{int}{SockAddrLen}{\void};
  74
  75 Returns the length of the socket address.
  76
  77 % ----------------------------------------------------------------------------
  78 % CLASS: wxIPV4address
  79 % ----------------------------------------------------------------------------
  80 \section{\class{wxIPV4address}}\label{wxipv4address}
  81
  82 \wxheading{Derived from}
  83
  84 \helpref{wxSockAddress}{wxsockaddress}
  85
  86 % ----------------------------------------------------------------------------
  87 % MEMBERS
  88 % ----------------------------------------------------------------------------
  89
  90 \latexignore{\rtfignore{\wxheading{Members}}}
  91
  92 %
  93 % Hostname
  94 %
  95
  96 \membersection{wxIPV4address::Hostname}
  97
  98 \func{bool}{Hostname}{\param{const wxString\&}{ hostname}}
  99
 100 Use the specified {\it hostname} for the address.
 101
 102 \wxheading{Return value}
 103
 104 Returns FALSE if something bad happens (invalid hostname, invalid IP address).
 105
 106 %
 107 % Hostname
 108 %
 109
 110 \membersection{wxIPV4address::Hostname}
 111
 112 \func{wxString}{Hostname}{\void}
 113
 114 Returns the hostname which matches the IP address.
 115
 116 %
 117 % Service
 118 %
 119
 120 \membersection{wxIPV4address::Service}
 121
 122 \func{bool}{Service}{\param{const wxString\&}{ service}}
 123
 124 Use the specified {\it service} string for the address.
 125
 126 \wxheading{Return value}
 127
 128 Returns FALSE if something bad happens (invalid service).
 129
 130 %
 131 % Service
 132 %
 133
 134 \membersection{wxIPV4address::Service}
 135
 136 \func{bool}{Service}{\param{unsigned short}{ service}}
 137
 138 Use the specified {\it service} for the address.
 139
 140 \wxheading{Return value}
 141
 142 Returns FALSE if something bad happens (invalid service).
 143
 144 %
 145 % Service
 146 %
 147
 148 \membersection{wxIPV4address::Service}
 149
 150 \func{unsigned short}{Service}{\void}
 151
 152 Returns the current service.
 153
 154 %
 155 % LocalHost
 156 %
 157
 158 \membersection{wxIPV4address::LocalHost}
 159
 160 \func{bool}{LocalHost}{\void}
 161
 162 Initialize peer host to local host.
 163
 164 \wxheading{Return value}
 165
 166 Returns FALSE if something bad happens.
 167