include/wx/private/sckaddr.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/private/sockaddr.h
   3 // Purpose:     wxSockAddressImpl
   4 // Author:      Vadim Zeitlin
   5 // Created:     2008-12-28
   6 // RCS-ID:      $Id$
   7 // Copyright:   (c) 2008 Vadim Zeitlin <vadim@wxwidgets.org>
   8 // Licence:     wxWindows licence
   9 ///////////////////////////////////////////////////////////////////////////////
  10
  11 #ifndef _WX_PRIVATE_SOCKADDR_H_
  12 #define _WX_PRIVATE_SOCKADDR_H_
  13
  14 #ifdef __WXMSW__
  15     #include "wx/msw/wrapwin.h"
  16
  17     #if wxUSE_IPV6
  18         #include <ws2tcpip.h>
  19     #endif
  20 #elif defined(__VMS__)
  21     #include <socket.h>
  22
  23     struct sockaddr_un
  24     {
  25         u_char  sun_len;        /* sockaddr len including null */
  26         u_char  sun_family;     /* AF_UNIX */
  27         char    sun_path[108];  /* path name (gag) */
  28     };
  29     #include <in.h>
  30 #else // generic Unix
  31     #include <sys/types.h>
  32     #include <sys/socket.h>
  33     #include <netinet/in.h>
  34     #include <sys/un.h>
  35 #endif // platform
  36
  37 #include <stdlib.h> // for calloc()
  38
  39 // this is a wrapper for sockaddr_storage if it's available or just sockaddr
  40 // otherwise
  41 union wxSockAddressStorage
  42 {
  43 #if wxUSE_IPV6
  44     sockaddr_storage addr_storage;
  45 #endif
  46     sockaddr addr;
  47 };
  48
  49 // ----------------------------------------------------------------------------
  50 // helpers for wxSockAddressImpl
  51 // ----------------------------------------------------------------------------
  52
  53 // helper class mapping sockaddr_xxx types to corresponding AF_XXX values
  54 //
  55 // FIXME-VC6: we could leave the template undefined if not for VC6 which
  56 //            absolutely does need to have a generic version defining the
  57 //            template "interface" to compile the code below
  58 template <class T> struct AddressFamily { enum { value = AF_UNSPEC }; };
  59
  60 template <> struct AddressFamily<sockaddr_in> { enum { value = AF_INET }; };
  61
  62 #if wxUSE_IPV6
  63 template <> struct AddressFamily<sockaddr_in6> { enum { value = AF_INET6 }; };
  64 #endif // wxUSE_IPV6
  65
  66 #ifdef wxHAS_UNIX_DOMAIN_SOCKETS
  67 template <> struct AddressFamily<sockaddr_un> { enum { value = AF_UNIX }; };
  68 #endif // wxHAS_UNIX_DOMAIN_SOCKETS
  69
  70 // ----------------------------------------------------------------------------
  71 // wxSockAddressImpl
  72 // ----------------------------------------------------------------------------
  73
  74 // Represents a socket endpoint, e.g. an (address, port) pair for PF_INET
  75 // sockets. It can be initialized from an existing sockaddr struct and also
  76 // provides access to sockaddr stored internally so that it can be easily used
  77 // with e.g. connect(2).
  78 //
  79 // This class also performs (synchronous, hence potentially long) name lookups
  80 // if necessary, i.e. if the host name strings don't contain addresses in
  81 // numerical form (quad dotted for IPv4 or standard hexadecimal for IPv6).
  82 // Notice that internally the potentially Unicode host names are encoded as
  83 // UTF-8 before being passed to the lookup function but the host names should
  84 // really be ASCII anyhow.
  85 class wxSockAddressImpl
  86 {
  87 public:
  88     // as this is passed to socket() it should be a PF_XXX and not AF_XXX (even
  89     // though they're the same in practice)
  90     enum Family
  91     {
  92         FAMILY_INET = PF_INET,
  93 #if wxUSE_IPV6
  94         FAMILY_INET6 = PF_INET6,
  95 #endif
  96 #ifdef wxHAS_UNIX_DOMAIN_SOCKETS
  97         FAMILY_UNIX = PF_UNIX,
  98 #endif
  99         FAMILY_UNSPEC = PF_UNSPEC
 100     };
 101
 102     // default ctor creates uninitialized object, use one of CreateXXX() below
 103     wxSockAddressImpl()
 104     {
 105         InitUnspec();
 106     }
 107
 108     // ctor from an existing sockaddr
 109     wxSockAddressImpl(const sockaddr& addr, int len)
 110     {
 111         switch ( addr.sa_family )
 112         {
 113             case PF_INET:
 114 #if wxUSE_IPV6
 115             case PF_INET6:
 116 #endif
 117 #ifdef wxHAS_UNIX_DOMAIN_SOCKETS
 118             case PF_UNIX:
 119 #endif
 120                 m_family = static_cast<Family>(addr.sa_family);
 121                 break;
 122
 123             default:
 124                 wxFAIL_MSG( "unsupported socket address family" );
 125                 InitUnspec();
 126                 return;
 127         }
 128
 129         InitFromSockaddr(addr, len);
 130     }
 131
 132     // copy ctor and assignment operators
 133     wxSockAddressImpl(const wxSockAddressImpl& other)
 134     {
 135         InitFromOther(other);
 136     }
 137
 138     wxSockAddressImpl& operator=(const wxSockAddressImpl& other)
 139     {
 140         free(m_addr);
 141
 142         InitFromOther(other);
 143
 144         return *this;
 145     }
 146
 147     // dtor frees the memory used by m_addr
 148     ~wxSockAddressImpl()
 149     {
 150         free(m_addr);
 151     }
 152
 153
 154     // reset the address to the initial uninitialized state
 155     void Clear()
 156     {
 157         free(m_addr);
 158
 159         InitUnspec();
 160     }
 161
 162     // initialize the address to be of specific address family, it must be
 163     // currently uninitialized (you may call Clear() to achieve this)
 164     void CreateINET();
 165     void CreateINET6();
 166 #ifdef wxHAS_UNIX_DOMAIN_SOCKETS
 167     void CreateUnix();
 168 #endif // wxHAS_UNIX_DOMAIN_SOCKETS
 169     void Create(Family family)
 170     {
 171         switch ( family )
 172         {
 173             case FAMILY_INET:
 174                 CreateINET();
 175                 break;
 176
 177 #if wxUSE_IPV6
 178             case FAMILY_INET6:
 179                 CreateINET6();
 180                 break;
 181 #endif // wxUSE_IPV6
 182
 183 #ifdef wxHAS_UNIX_DOMAIN_SOCKETS
 184             case FAMILY_UNIX:
 185                 CreateUnix();
 186                 break;
 187 #endif // wxHAS_UNIX_DOMAIN_SOCKETS
 188
 189             default:
 190                 wxFAIL_MSG( "unsupported socket address family" );
 191         }
 192     }
 193
 194     // simple accessors
 195     Family GetFamily() const { return m_family; }
 196     bool Is(Family family) const { return m_family == family; }
 197     bool IsOk() const { return m_family != FAMILY_UNSPEC; }
 198     const sockaddr *GetAddr() const { return m_addr; }
 199     sockaddr *GetWritableAddr() { return m_addr; }
 200     int GetLen() const { return m_len; }
 201
 202     // accessors for INET or INET6 address families
 203 #if wxUSE_IPV6
 204     #define CALL_IPV4_OR_6(func, args) \
 205         Is(FAMILY_INET6) ? func##6(args) : func##4(args)
 206     #define CALL_IPV4_OR_6_VOID(func) \
 207         Is(FAMILY_INET6) ? func##6() : func##4()
 208 #else
 209     #define CALL_IPV4_OR_6(func, args) func##4(args)
 210     #define CALL_IPV4_OR_6_VOID(func) func##4()
 211 #endif // IPv6 support on/off
 212
 213     wxString GetHostName() const;
 214     bool SetHostName(const wxString& name)
 215     {
 216         return CALL_IPV4_OR_6(SetHostName, (name));
 217     }
 218
 219     wxUint16 GetPort() const { return CALL_IPV4_OR_6_VOID(GetPort); }
 220     bool SetPort(wxUint16 port) { return CALL_IPV4_OR_6(SetPort, (port)); }
 221     bool SetPortName(const wxString& name, const char *protocol);
 222
 223     bool SetToAnyAddress() { return CALL_IPV4_OR_6_VOID(SetToAnyAddress); }
 224
 225 #undef CALL_IPV4_OR_6
 226
 227     // accessors for INET addresses only
 228     bool GetHostAddress(wxUint32 *address) const;
 229     bool SetHostAddress(wxUint32 address);
 230
 231     bool SetToBroadcastAddress() { return SetHostAddress(INADDR_BROADCAST); }
 232
 233     // accessors for INET6 addresses only
 234 #if wxUSE_IPV6
 235     bool GetHostAddress(in6_addr *address) const;
 236     bool SetHostAddress(const in6_addr& address);
 237 #endif // wxUSE_IPV6
 238
 239 #ifdef wxHAS_UNIX_DOMAIN_SOCKETS
 240     // methods valid for Unix address family addresses only
 241     bool SetPath(const wxString& path);
 242     wxString GetPath() const;
 243 #endif // wxHAS_UNIX_DOMAIN_SOCKETS
 244
 245 private:
 246     void DoAlloc(int len)
 247     {
 248         m_addr = static_cast<sockaddr *>(calloc(1, len));
 249         m_len = len;
 250     }
 251
 252     // FIXME-VC6: VC6 doesn't grok Foo<T>() call syntax so we need the extra
 253     //            dummy parameter of type T, use the macros in sckaddr.cpp to
 254     //            hide it
 255     template <class T>
 256     T *Alloc(T *)
 257     {
 258         DoAlloc(sizeof(T));
 259
 260         return reinterpret_cast<T *>(m_addr);
 261     }
 262
 263     template <class T>
 264     T *Get(T *) const
 265     {
 266         wxCHECK_MSG( static_cast<int>(m_family) == AddressFamily<T>::value,
 267                      NULL,
 268                      "socket address family mismatch" );
 269
 270         return reinterpret_cast<T *>(m_addr);
 271     }
 272
 273     void InitUnspec()
 274     {
 275         m_family = FAMILY_UNSPEC;
 276         m_addr = NULL;
 277         m_len = 0;
 278     }
 279
 280     void InitFromSockaddr(const sockaddr& addr, int len)
 281     {
 282         DoAlloc(len);
 283         memcpy(m_addr, &addr, len);
 284     }
 285
 286     void InitFromOther(const wxSockAddressImpl& other)
 287     {
 288         m_family = other.m_family;
 289
 290         if ( other.m_addr )
 291         {
 292             InitFromSockaddr(*other.m_addr, other.m_len);
 293         }
 294         else // no address to copy
 295         {
 296             m_addr = NULL;
 297             m_len = 0;
 298         }
 299     }
 300
 301     // IPv4/6 implementations of public functions
 302     bool SetHostName4(const wxString& name);
 303
 304     bool SetPort4(wxUint16 port);
 305     wxUint16 GetPort4() const;
 306
 307     bool SetToAnyAddress4() { return SetHostAddress(INADDR_ANY); }
 308
 309 #if wxUSE_IPV6
 310     bool SetHostName6(const wxString& name);
 311
 312     bool SetPort6(wxUint16 port);
 313     wxUint16 GetPort6() const;
 314
 315     bool SetToAnyAddress6();
 316 #endif // wxUSE_IPV6
 317
 318     Family m_family;
 319     sockaddr *m_addr;
 320     int m_len;
 321 };
 322
 323 #endif // _WX_PRIVATE_SOCKADDR_H_