docs/latex/wx/sckaddr.tex

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