ACE/ace/DEV_Addr.h

   1 // -*- C++ -*-
   2
   3 //==========================================================================
   4 /**
   5  *  @file    DEV_Addr.h
   6  *
   7  *  @author Gerhard Lenzer and Douglas C. Schmidt
   8  */
   9 //==========================================================================
  10
  11 #ifndef ACE_DEV_ADDR_H
  12 #define ACE_DEV_ADDR_H
  13
  14 #include /**/ "ace/pre.h"
  15
  16 #include "ace/Addr.h"
  17
  18 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  19 # pragma once
  20 #endif /* ACE_LACKS_PRAGMA_ONCE */
  21
  22 #include "ace/os_include/os_dirent.h"
  23
  24 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  25
  26 /**
  27  * @class ACE_DEV_Addr
  28  *
  29  * @brief Defines device address family address format.
  30  */
  31 class ACE_Export ACE_DEV_Addr : public ACE_Addr
  32 {
  33 public:
  34   /// Default constructor.
  35   ACE_DEV_Addr (void);
  36
  37   /// Copy constructor.
  38   ACE_DEV_Addr (const ACE_DEV_Addr &sa);
  39
  40   /// Acts like a copy constructor.
  41   int set (const ACE_DEV_Addr &sa);
  42
  43   /// Create a ACE_DEV_Addr from a device name.
  44   explicit ACE_DEV_Addr (const ACE_TCHAR *devname);
  45
  46   /// Create a ACE_Addr from a ACE_DEV pathname.
  47   void set (const ACE_TCHAR *devname);
  48
  49   /// Assignment operator.
  50   ACE_DEV_Addr &operator= (const ACE_DEV_Addr &);
  51
  52   /// Return a pointer to the address.
  53   virtual void *get_addr (void) const;
  54
  55   /// Transform the current address into string format.
  56   virtual int addr_to_string (ACE_TCHAR *addr, size_t) const;
  57
  58   /// Compare two addresses for equality.
  59   bool operator == (const ACE_DEV_Addr &SAP) const;
  60
  61   /// Compare two addresses for inequality.
  62   bool operator != (const ACE_DEV_Addr &SAP) const;
  63
  64   /// Return the path name used for the rendezvous point.
  65   const ACE_TCHAR *get_path_name (void) const;
  66
  67   /// Dump the state of an object.
  68   void dump () const;
  69
  70   /// Declare the dynamic allocation hooks.
  71   ACE_ALLOC_HOOK_DECLARE;
  72
  73 private:
  74   enum { DEVNAME_LENGTH = MAXPATHLEN + 1 };
  75   /// Name of the device.
  76   ACE_TCHAR devname_[DEVNAME_LENGTH];
  77 };
  78
  79 ACE_END_VERSIONED_NAMESPACE_DECL
  80
  81 #if defined (__ACE_INLINE__)
  82 #include "ace/DEV_Addr.inl"
  83 #endif /* __ACE_INLINE__ */
  84
  85 #include /**/ "ace/post.h"
  86
  87 #endif /* ACE_DEV_ADDR_H */