synchronize GTK2 minimum version in docs

[wxWidgets.git] / include / wx / sckaddr.h

diff --git a/include/wx/sckaddr.h b/include/wx/sckaddr.h
index 6e2a0ae012716c8e3fe7fc621095aecc7c8420aa..09646f4ae06d4c605855c947aba9b8bf9916331e 100644 (file)
--- a/include/wx/sckaddr.h
+++ b/include/wx/sckaddr.h
@@ -1,115 +1,223 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        sckaddr.h
+// Name:        wx/sckaddr.h

 // Purpose:     Network address classes
 // Author:      Guilhem Lavaux
 // Purpose:     Network address classes
 // Author:      Guilhem Lavaux

-// Modified by:
+// Modified by: Vadim Zeitlin to switch to wxSockAddressImpl implementation

 // Created:     26/04/1997
 // RCS-ID:      $Id$
 // Copyright:   (c) 1997, 1998 Guilhem Lavaux
 // Created:     26/04/1997
 // RCS-ID:      $Id$
 // Copyright:   (c) 1997, 1998 Guilhem Lavaux

-// Licence:     wxWindows license
+//              (c) 2008, 2009 Vadim Zeitlin
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

-#ifndef _WX_NETWORK_ADDRESS_H
-#define _WX_NETWORK_ADDRESS_H
-
-#ifdef __GNUG__
-#pragma interface
-#endif
+#ifndef _WX_SCKADDR_H_
+#define _WX_SCKADDR_H_

 
 #include "wx/defs.h"
 
 #if wxUSE_SOCKETS
 
 #include "wx/string.h"
 
 #include "wx/defs.h"
 
 #if wxUSE_SOCKETS
 
 #include "wx/string.h"

-#include "wx/gsocket.h"

 
 

+class wxSockAddressImpl;

 
 

-class WXDLLEXPORT wxSockAddress : public wxObject {
-  DECLARE_ABSTRACT_CLASS(wxSockAddress)
+// forward declare it instead of including the system headers defining it which
+// can bring in <windows.h> under Windows which we don't want to include from
+// public wx headers
+struct sockaddr;
+
+// Any socket address kind
+class WXDLLIMPEXP_NET wxSockAddress : public wxObject
+{

 public:
 public:

-  typedef enum { IPV4=1, IPV6=2, UNIX=3 } Addr;
+    enum Family
+    {
+        NONE,
+        IPV4,
+        IPV6,
+        UNIX
+    };
+
+    wxSockAddress();
+    wxSockAddress(const wxSockAddress& other);
+    virtual ~wxSockAddress();

 
 

-  wxSockAddress();
-  virtual ~wxSockAddress();
+    wxSockAddress& operator=(const wxSockAddress& other);

 
 

-  virtual void Clear();
-  virtual int Type() = 0;
+    virtual void Clear();
+    virtual Family Type() = 0;

 
 

-  GAddress *GetAddress() const { return m_address; }
-  void SetAddress(GAddress *address);
-  const wxSockAddress& operator =(const wxSockAddress& addr);
+    // accessors for the low level address represented by this object
+    const sockaddr *GetAddressData() const;
+    int GetAddressDataLen() const;

 
 

-  void CopyObject(wxObject& dest) const;
+    // we need to be able to create copies of the addresses polymorphically
+    // (i.e. without knowing the exact address class)
+    virtual wxSockAddress *Clone() const = 0;
+
+
+    // implementation only, don't use
+    const wxSockAddressImpl& GetAddress() const { return *m_impl; }
+    void SetAddress(const wxSockAddressImpl& address);

 
 protected:
 
 protected:

-  GAddress *m_address;
+    wxSockAddressImpl *m_impl;
+
+private:
+    void Init();
+    DECLARE_ABSTRACT_CLASS(wxSockAddress)

 };
 
 };
 

-class WXDLLEXPORT wxIPV4address : public wxSockAddress {
-  DECLARE_DYNAMIC_CLASS(wxIPV4address)
+// An IP address (either IPv4 or IPv6)
+class WXDLLIMPEXP_NET wxIPaddress : public wxSockAddress
+{

 public:
 public:

-  wxIPV4address();
-  virtual ~wxIPV4address();
+    wxIPaddress() : wxSockAddress() { }
+    wxIPaddress(const wxIPaddress& other)
+        : wxSockAddress(other),
+          m_origHostname(other.m_origHostname)
+    {
+    }
+
+    bool operator==(const wxIPaddress& addr) const;
+
+    bool Hostname(const wxString& name);
+    bool Service(const wxString& name);
+    bool Service(unsigned short port);
+
+    bool LocalHost();
+    virtual bool IsLocalHost() const = 0;
+
+    bool AnyAddress();
+
+    virtual wxString IPAddress() const = 0;

 
 

-  bool Hostname(const wxString& name);
-  bool Hostname(unsigned long addr);
-  bool Service(const wxString& name);
-  bool Service(unsigned short port);
-  bool LocalHost();
-  bool AnyAddress();
+    wxString Hostname() const;
+    unsigned short Service() const;

 
 

-  wxString Hostname();
-  unsigned short Service();
+    wxString OrigHostname() const { return m_origHostname; }

 
 

-  inline int Type() { return wxSockAddress::IPV4; }
+protected:
+    // get m_impl initialized to the right family if it hadn't been done yet
+    wxSockAddressImpl& GetImpl();
+    const wxSockAddressImpl& GetImpl() const
+    {
+        return const_cast<wxIPaddress *>(this)->GetImpl();
+    }
+
+    // host name originally passed to Hostname()
+    wxString m_origHostname;
+
+private:
+    // create the wxSockAddressImpl object of the correct family if it's
+    // currently uninitialized
+    virtual void DoInitImpl() = 0;
+
+
+    DECLARE_ABSTRACT_CLASS(wxIPaddress)

 };
 
 };
 

-#ifdef ENABLE_IPV6
-class WXDLLEXPORT wxIPV6address : public wxSockAddress {
-  DECLARE_DYNAMIC_CLASS(wxIPV6address)
+// An IPv4 address
+class WXDLLIMPEXP_NET wxIPV4address : public wxIPaddress
+{
+public:
+    wxIPV4address() : wxIPaddress() { }
+    wxIPV4address(const wxIPV4address& other) : wxIPaddress(other) { }
+
+    // implement wxSockAddress pure virtuals:
+    virtual Family Type() { return IPV4; }
+    virtual wxSockAddress *Clone() const { return new wxIPV4address(*this); }
+
+
+    // implement wxIPaddress pure virtuals:
+    virtual bool IsLocalHost() const;
+
+    virtual wxString IPAddress() const;
+
+
+    // IPv4-specific methods:
+    bool Hostname(unsigned long addr);
+
+    // make base class methods hidden by our overload visible
+    //
+    // FIXME-VC6: replace this with "using IPAddress::Hostname" (not supported
+    //            by VC6) when support for it is dropped
+    wxString Hostname() const { return wxIPaddress::Hostname(); }
+    bool Hostname(const wxString& name) { return wxIPaddress::Hostname(name); }
+
+    bool BroadcastAddress();
+

 private:
 private:

-  struct sockaddr_in6 *m_addr;
+    virtual void DoInitImpl();
+
+    DECLARE_DYNAMIC_CLASS(wxIPV4address)
+};
+
+
+#if wxUSE_IPV6
+
+// An IPv6 address
+class WXDLLIMPEXP_NET wxIPV6address : public wxIPaddress
+{

 public:
 public:

-  wxIPV6address();
-  ~wxIPV6address();
+    wxIPV6address() : wxIPaddress() { }
+    wxIPV6address(const wxIPV6address& other) : wxIPaddress(other) { }
+
+    // implement wxSockAddress pure virtuals:
+    virtual Family Type() { return IPV6; }
+    virtual wxSockAddress *Clone() const { return new wxIPV6address(*this); }
+

 
 

-  bool Hostname(const wxString& name);
-  bool Hostname(unsigned char addr[16]);
-  bool Service(const wxString& name);
-  bool Service(unsigned short port);
-  bool LocalHost();
+    // implement wxIPaddress pure virtuals:
+    virtual bool IsLocalHost() const;

 
 

-  wxString Hostname() const;
-  unsigned short Service() const;
+    virtual wxString IPAddress() const;

 
 

-  inline int Type() { return wxSockAddress::IPV6; }
+    // IPv6-specific methods:
+    bool Hostname(unsigned char addr[16]);
+
+    using wxIPaddress::Hostname;
+
+private:
+    virtual void DoInitImpl();
+
+    DECLARE_DYNAMIC_CLASS(wxIPV6address)

 };
 };

-#endif

 
 

-#ifdef __UNIX__
-#include <sys/socket.h>
-#ifndef __VMS__
-# include <sys/un.h>
+#endif // wxUSE_IPV6
+
+// Unix domain sockets are only available under, well, Unix
+#if defined(__UNIX__) && !defined(__WINDOWS__) && !defined(__WINE__)
+    #define wxHAS_UNIX_DOMAIN_SOCKETS

 #endif
 
 #endif
 

-class WXDLLEXPORT wxUNIXaddress : public wxSockAddress {
-  DECLARE_DYNAMIC_CLASS(wxUNIXaddress)
-private:
-  struct sockaddr_un *m_addr;
+#ifdef wxHAS_UNIX_DOMAIN_SOCKETS
+
+// A Unix domain socket address
+class WXDLLIMPEXP_NET wxUNIXaddress : public wxSockAddress
+{

 public:
 public:

-  wxUNIXaddress();
-  ~wxUNIXaddress();
+    wxUNIXaddress() : wxSockAddress() { }
+    wxUNIXaddress(const wxUNIXaddress& other) : wxSockAddress(other) { }
+
+    void Filename(const wxString& name);
+    wxString Filename() const;

 
 

-  void Filename(const wxString& name);
-  wxString Filename();
+    virtual Family Type() { return UNIX; }
+    virtual wxSockAddress *Clone() const { return new wxUNIXaddress(*this); }

 
 

-  inline int Type() { return wxSockAddress::UNIX; }
+private:
+    wxSockAddressImpl& GetUNIX();
+    const wxSockAddressImpl& GetUNIX() const
+    {
+        return const_cast<wxUNIXaddress *>(this)->GetUNIX();
+    }
+
+    DECLARE_DYNAMIC_CLASS(wxUNIXaddress)

 };
 };

-#endif
-  // __UNIX__

 
 

-#endif
-  // wxUSE_SOCKETS
+#endif // wxHAS_UNIX_DOMAIN_SOCKETS

 
 

-#endif
-  // _WX_NETWORK_ADDRESS_H
+#endif // wxUSE_SOCKETS
+
+#endif // _WX_SCKADDR_H_