dep/ACE_wrappers/ace/MEM_Addr.h

   1 // -*- C++ -*-
   2
   3 //==========================================================================
   4 /**
   5  *  @file    MEM_Addr.h
   6  *
   7  *  $Id: MEM_Addr.h 80826 2008-03-04 14:51:23Z wotte $
   8  *
   9  *  @author Nanbor Wang <nanbor@cs.wustl.edu>
  10  */
  11 //==========================================================================
  12
  13
  14 #ifndef ACE_MEM_ADDR_H
  15 #define ACE_MEM_ADDR_H
  16 #include /**/ "ace/pre.h"
  17
  18 #include /**/ "ace/ACE_export.h"
  19
  20 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  21 # pragma once
  22 #endif /* ACE_LACKS_PRAGMA_ONCE */
  23
  24 #if (ACE_HAS_POSITION_INDEPENDENT_POINTERS == 1)
  25
  26 #include "ace/INET_Addr.h"
  27
  28 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  29
  30 /**
  31  * @class ACE_MEM_Addr
  32  *
  33  * @brief Defines a C++ wrapper facade for the shared memory transport
  34  * address family format.
  35  */
  36 class ACE_Export ACE_MEM_Addr : public ACE_Addr
  37 {
  38 public:
  39   // = Initialization methods.
  40   /// Default constructor.
  41   ACE_MEM_Addr (void);
  42
  43   /// Copy constructor.
  44   ACE_MEM_Addr (const ACE_MEM_Addr &);
  45
  46   /// Creates an ACE_MEM_Addr from a @a port_number
  47   ACE_MEM_Addr (u_short port_number);
  48
  49   /// Creates an ACE_MEM_Addr from a @a port_name.
  50   explicit ACE_MEM_Addr (const ACE_TCHAR port_name[]);
  51
  52   /// Default dtor.
  53   ~ACE_MEM_Addr (void);
  54
  55   // = Direct initialization methods.
  56
  57   /// Default initialization routine.
  58   int initialize_local (u_short port);
  59
  60   /// Check if @a sap designates an endpoint on the same host.
  61   int same_host (const ACE_INET_Addr& sap);
  62
  63   // These methods are useful after the object has been constructed.
  64
  65   /**
  66    * Initializes an ACE_MEM_Addr from a @a port_number.  If @a encode
  67    * is enabled then @a port_number is converted into network byte order,
  68    * otherwise it is assumed to be in network byte order already and
  69    * are passed straight through.
  70    */
  71   int set (u_short port_number, int encode = 1);
  72
  73   /// Uses <getservbyname> to initialize an ACE_MEM_Addr from a
  74   /// <port_name>, the remote <host_name>, and the <protocol>.
  75   int set (const ACE_TCHAR port_name[]);
  76
  77   /// Return a pointer to the underlying network address.
  78   virtual void *get_addr (void) const;
  79
  80   /// Set a pointer to the address.
  81   virtual void set_addr (void *, int len);
  82
  83   /// Transform the external ACE_MEM_Addr address into string
  84   /// format.
  85   virtual int addr_to_string (ACE_TCHAR buffer[],
  86                               size_t size,
  87                               int ipaddr_format = 1) const;
  88
  89   /// Initializes the external ACE_MEM_Addr from the @a address.
  90   virtual int string_to_addr (const ACE_TCHAR address[]);
  91
  92   /// Sets the port number.
  93   void set_port_number (u_short,
  94                         int encode = 1);
  95
  96   /// Return the port number, converting it into host byte order.
  97   u_short get_port_number (void) const;
  98
  99   /// Return the character representation of the hostname.
 100   int get_host_name (ACE_TCHAR hostname[],
 101                      size_t hostnamelen) const;
 102
 103   /**
 104    * Return the character representation of the hostname (this version
 105    * is non-reentrant since it returns a pointer to a static data
 106    * area).
 107    */
 108   const char *get_host_name (void) const;
 109
 110   /// Return the "dotted decimal" external address.
 111   const char *get_host_addr (void) const;
 112
 113   /// Return the 4-byte external IP address, converting it into host byte
 114   /// order.
 115   ACE_UINT32 get_ip_address (void) const;
 116
 117   const ACE_INET_Addr &get_remote_addr (void) const;
 118   const ACE_INET_Addr &get_local_addr (void) const;
 119
 120   /// Compare two addresses for equality.  The addresses are considered
 121   /// equal if they contain the same IP address and port number.
 122   bool operator == (const ACE_MEM_Addr &SAP) const;
 123   bool operator == (const ACE_INET_Addr &SAP) const;
 124
 125   /// Compare two addresses for inequality.
 126   bool operator != (const ACE_MEM_Addr &SAP) const;
 127   bool operator != (const ACE_INET_Addr &SAP) const;
 128
 129   /// Computes and returns hash value.
 130   virtual u_long hash (void) const;
 131
 132   /// Dump the state of an object.
 133   void dump (void) const;
 134
 135   /// Declare the dynamic allocation hooks.
 136   ACE_ALLOC_HOOK_DECLARE;
 137
 138 private:
 139   /// External INET addr used for identifying host.
 140   ACE_INET_Addr external_;
 141
 142   /// Internal INET addr for accepting/connecting.
 143   ACE_INET_Addr internal_;
 144 };
 145
 146 ACE_END_VERSIONED_NAMESPACE_DECL
 147
 148 #if defined (__ACE_INLINE__)
 149 #include "ace/MEM_Addr.inl"
 150 #endif /* __ACE_INLINE__ */
 151
 152 #endif /* ACE_HAS_POSITION_INDEPENDENT_POINTERS == 1 */
 153
 154 #include /**/ "ace/post.h"
 155 #endif /* ACE_MEM_ADDR_H */