ACE/ace/FILE_Addr.h

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