Escape underscores

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

diff --git a/include/wx/sckaddr.h b/include/wx/sckaddr.h
index a780b3a716bfa51f0f94359dd462b61896a77098..98e1c0d4e7b592c28b91a963e91a8b2353737fee 100644 (file)
--- a/include/wx/sckaddr.h
+++ b/include/wx/sckaddr.h
@@ -6,16 +6,12 @@
 // Created:     26/04/1997
 // RCS-ID:      $Id$
 // Copyright:   (c) 1997, 1998 Guilhem Lavaux
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_NETWORK_ADDRESS_H
 #define _WX_NETWORK_ADDRESS_H
 
-#if defined(__GNUG__) && !defined(__APPLE__)
-#pragma interface "sckaddr.h"
-#endif
-
 #include "wx/defs.h"
 
 #if wxUSE_SOCKETS
@@ -24,7 +20,7 @@
 #include "wx/gsocket.h"
 
 
-class WXDLLEXPORT wxSockAddress : public wxObject {
+class WXDLLIMPEXP_NET wxSockAddress : public wxObject {
   DECLARE_ABSTRACT_CLASS(wxSockAddress)
 public:
   typedef enum { IPV4=1, IPV6=2, UNIX=3 } Addr;
@@ -52,33 +48,80 @@ private:
   void Init();
 };
 
-class WXDLLEXPORT wxIPV4address : public wxSockAddress {
+// Interface to an IP address (either IPV4 or IPV6)
+class WXDLLIMPEXP_NET wxIPaddress : public wxSockAddress {
+  DECLARE_ABSTRACT_CLASS(wxIPaddress)
+public:
+  wxIPaddress();
+  wxIPaddress(const wxIPaddress& other);
+  virtual ~wxIPaddress();
+
+  virtual bool Hostname(const wxString& name) = 0;
+  virtual bool Service(const wxString& name) = 0;
+  virtual bool Service(unsigned short port) = 0;
+
+  virtual bool LocalHost() = 0;
+  virtual bool IsLocalHost() const = 0;
+
+  virtual bool AnyAddress() = 0;
+
+  virtual wxString IPAddress() const = 0;
+
+  virtual wxString Hostname() const = 0;
+  virtual unsigned short Service() const = 0;
+};
+
+class WXDLLIMPEXP_NET wxIPV4address : public wxIPaddress {
   DECLARE_DYNAMIC_CLASS(wxIPV4address)
 public:
   wxIPV4address();
   wxIPV4address(const wxIPV4address& other);
   virtual ~wxIPV4address();
 
-  bool Hostname(const wxString& name);
+  // IPV4 name formats
+  //
+  //                    hostname
+  // dot format         a.b.c.d
+  virtual bool Hostname(const wxString& name);
   bool Hostname(unsigned long addr);
-  bool Service(const wxString& name);
-  bool Service(unsigned short port);
-  bool LocalHost();
-  bool AnyAddress();
+  virtual bool Service(const wxString& name);
+  virtual bool Service(unsigned short port);
+
+  // localhost (127.0.0.1)
+  virtual bool LocalHost();
+  virtual bool IsLocalHost() const;
+
+  // any (0.0.0.0)
+  virtual bool AnyAddress();
 
-  wxString Hostname();
+  virtual wxString Hostname() const;
   wxString OrigHostname() { return m_origHostname; }
-  unsigned short Service();
+  virtual unsigned short Service() const;
+
+  // a.b.c.d
+  virtual wxString IPAddress() const;
 
   virtual int Type() { return wxSockAddress::IPV4; }
   virtual wxSockAddress *Clone() const;
 
+  bool operator==(const wxIPV4address& addr) const;
+
 private:
   wxString m_origHostname;
 };
 
-#ifdef ENABLE_IPV6
-class WXDLLEXPORT wxIPV6address : public wxSockAddress {
+
+// the IPv6 code probably doesn't work, untested -- set to 1 at your own risk
+#ifndef wxUSE_IPV6
+    #define wxUSE_IPV6 0
+#endif
+
+#if wxUSE_IPV6
+
+// Experimental Only:
+//
+// IPV6 has not yet been implemented in socket layer
+class WXDLLIMPEXP_NET wxIPV6address : public wxIPaddress {
   DECLARE_DYNAMIC_CLASS(wxIPV6address)
 private:
   struct sockaddr_in6 *m_addr;
@@ -87,27 +130,45 @@ public:
   wxIPV6address(const wxIPV6address& other);
   virtual ~wxIPV6address();
 
-  bool Hostname(const wxString& name);
+  // IPV6 name formats
+  //
+  //                          hostname
+  //                          3ffe:ffff:0100:f101:0210:a4ff:fee3:9566
+  // compact (base85)         Itu&-ZQ82s>J%s99FJXT
+  // compressed format        ::1
+  // ipv4 mapped              ::ffff:1.2.3.4
+  virtual bool Hostname(const wxString& name);
+
   bool Hostname(unsigned char addr[16]);
-  bool Service(const wxString& name);
-  bool Service(unsigned short port);
-  bool LocalHost();
+  virtual bool Service(const wxString& name);
+  virtual bool Service(unsigned short port);
+
+  // localhost (0000:0000:0000:0000:0000:0000:0000:0001 (::1))
+  virtual bool LocalHost();
+  virtual bool IsLocalHost() const;
+
+  // any (0000:0000:0000:0000:0000:0000:0000:0000 (::))
+  virtual bool AnyAddress();
 
-  wxString Hostname() const;
-  unsigned short Service() const;
+  // 3ffe:ffff:0100:f101:0210:a4ff:fee3:9566
+  virtual wxString IPAddress() const;
+
+  virtual wxString Hostname() const;
+  virtual unsigned short Service() const;
 
   virtual int Type() { return wxSockAddress::IPV6; }
   virtual wxSockAddress *Clone() const { return new wxIPV6address(*this); }
 };
-#endif
 
-#if defined(__UNIX__) && !defined(__WINE__) && (!defined(__WXMAC__) || defined(__DARWIN__))
+#endif // wxUSE_IPV6
+
+#if defined(__UNIX__) && !defined(__WINE__) && (!defined(__WXMAC__) || defined(__DARWIN__)) && !defined(__WXMSW__)
 #include <sys/socket.h>
 #ifndef __VMS__
 # include <sys/un.h>
 #endif
 
-class WXDLLEXPORT wxUNIXaddress : public wxSockAddress {
+class WXDLLIMPEXP_NET wxUNIXaddress : public wxSockAddress {
   DECLARE_DYNAMIC_CLASS(wxUNIXaddress)
 private:
   struct sockaddr_un *m_addr;