ACE/ace/ATM_Addr.h

   1 // -*- C++ -*-
   2
   3 //==========================================================================
   4 /**
   5  *  @file    ATM_Addr.h
   6  *
   7  *  @author Joe Hoffert <joeh@cs.wustl.edu>
   8  */
   9 //==========================================================================
  10
  11 #ifndef ACE_ATM_ADDR_H
  12 #define ACE_ATM_ADDR_H
  13 #include /**/ "ace/pre.h"
  14
  15 #include /**/ "ace/config-all.h"
  16
  17 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  18 # pragma once
  19 #endif /* ACE_LACKS_PRAGMA_ONCE */
  20
  21 #if defined (ACE_HAS_ATM)
  22
  23 #include /**/ "ace/ACE_export.h"
  24 #include "ace/Addr.h"
  25
  26 #if defined (ACE_HAS_FORE_ATM_XTI)
  27 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  28 typedef ATMSAPAddress ATM_Addr;
  29 ACE_END_VERSIONED_NAMESPACE_DECL
  30 #elif defined (ACE_HAS_FORE_ATM_WS2)
  31 #define FORE_NAME_SPACE NS_ALL
  32 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  33 typedef struct sockaddr_atm ATM_Addr;
  34 ACE_END_VERSIONED_NAMESPACE_DECL
  35 #elif defined (ACE_HAS_LINUX_ATM)
  36
  37 #include /**/ "atm.h"
  38
  39 // Open versioned namespace, if enabled by the user.
  40 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  41
  42 //pbrandao:as Linux has this 2 structs separeted we "link it" here
  43 typedef struct _linux_atm_addr
  44 {
  45   struct sockaddr_atmsvc sockaddratmsvc;
  46   struct atm_sap atmsap;
  47 } ATM_Addr;
  48 #else
  49 typedef int ATM_Addr;
  50 #endif /* ACE_HAS_FORE_ATM_XTI/ACE_HAS_FORE_ATM_WS2/ACE_HAS_LINUX_ATM */
  51
  52 /**
  53  * @class ACE_ATM_Addr
  54  *
  55  * @brief Defines the ATM domain address family address format.
  56  */
  57 class ACE_Export ACE_ATM_Addr : public ACE_Addr
  58 {
  59 public:
  60   // Constants used for ATM options
  61   static const long LINE_RATE;
  62   static const int OPT_FLAGS_CPID;
  63   static const int OPT_FLAGS_PMP;
  64   static const int DEFAULT_SELECTOR;
  65
  66   /// Default constructor.
  67   ACE_ATM_Addr (u_char selector = DEFAULT_SELECTOR);
  68
  69   /// Copy constructor.
  70   ACE_ATM_Addr (const ACE_ATM_Addr &,
  71                 u_char selector = DEFAULT_SELECTOR);
  72
  73   /**
  74    * Creates an ACE_ATM_Addr from an ATMSAPAddress structure. This
  75    * is vendor specific (FORE systems). May need to change when other
  76    * vendors are supported.
  77    */
  78   ACE_ATM_Addr (const ATM_Addr *,
  79                 u_char selector = DEFAULT_SELECTOR);
  80
  81   /**
  82    * Initializes an ACE_ATM_Addr from the <sap> which can be
  83    * "atm-address" (e.g.,
  84    * "47.0005.80.ffe100.0000.f20f.2200.0020480694f9.00") or "hostname"
  85    * (e.g., "frisbee.cs.wustl.edu").
  86    */
  87   ACE_ATM_Addr (const ACE_TCHAR sap[],
  88                 u_char selector = DEFAULT_SELECTOR);
  89
  90   /// Default dtor.
  91   ~ACE_ATM_Addr () = default;
  92
  93   /// Default initialization for non-address values (e.g.,
  94   /// t_atm_sap_addr.SVE_tag_addr, t_atm_sap_addr.SVE_tag_selector)
  95   void init (u_char selector = DEFAULT_SELECTOR);
  96
  97   /// Initializes from another ACE_ATM_Addr.
  98   int set (const ACE_ATM_Addr &,
  99            u_char selector = DEFAULT_SELECTOR);
 100
 101   /**
 102    * Initializes an ACE_ATM_Addr from an ATMSAPAddress/sockaddr_atm
 103    * structure. This is vendor specific (FORE systems). May need to
 104    * change when other vendors are supported.
 105    */
 106   int set (const ATM_Addr *,
 107            u_char selector = DEFAULT_SELECTOR);
 108
 109   /**
 110    * Initializes an ACE_ATM_Addr from the <sap> which can be
 111    * "atm-address" (e.g.,
 112    * "47.0005.80.ffe100.0000.f20f.2200.0020480694f9.00") or "hostname"
 113    * (e.g., "frisbee.cs.wustl.edu").
 114    */
 115   int set (const ACE_TCHAR sap[],
 116            u_char selector = DEFAULT_SELECTOR);
 117
 118   /**
 119    * Initializes an ACE_ATM_Addr from the <sap> which can be
 120    * "atm-address" (e.g.,
 121    * "47.0005.80.ffe100.0000.f20f.2200.0020480694f9.00") or "hostname"
 122    * (e.g., "frisbee.cs.wustl.edu").
 123    */
 124   virtual int string_to_addr (const ACE_TCHAR sap[]);
 125
 126   /**
 127    * Return the character representation of the ATM address (e.g.,
 128    * "47.0005.80.ffe100.0000.f20f.2200.0020480694f9.00") storing it in
 129    * the @a addr (which is assumed to be <addrlen> bytes long). This
 130    * version is reentrant.  Returns -1 if the <addrlen> of the @a addr
 131    * is too small, else 0.
 132    */
 133   virtual int addr_to_string (ACE_TCHAR addr[],
 134                               size_t addrlen) const;
 135
 136   /**
 137    * Return the character representation of the ATM address (e.g.,
 138    * "47.0005.80.ffe100.0000.f20f.2200.0020480694f9.00"). Returns -1
 139    * if the <size> of the <buffer> is too small, else 0.(This version
 140    * is non-reentrant since it returns a pointer to a static data
 141    * area.)
 142    */
 143   const ACE_TCHAR *addr_to_string () const;
 144
 145   /// Return a pointer to the underlying network address.
 146   virtual void *get_addr () const;
 147
 148   /// Set a pointer to the address.
 149   virtual void set_addr (const void *, int);
 150
 151   /// Return the selector for network address.
 152   u_char get_selector () const;
 153
 154   /// Set the selector for the network address.
 155   void set_selector (u_char selector);
 156
 157   /**
 158    * Compare two addresses for equality.  The addresses are considered
 159    * equal if they contain the same ATM address.  Q: Is there any
 160    * other check for equality needed for ATM?
 161    */
 162   bool operator == (const ACE_ATM_Addr &SAP) const;
 163
 164   /// Compare two addresses for inequality.
 165   bool operator != (const ACE_ATM_Addr &SAP) const;
 166
 167   /// Dump the state of an object.
 168   void dump () const;
 169
 170   /// Declare the dynamic allocation hooks.
 171   ACE_ALLOC_HOOK_DECLARE;
 172
 173 //   char *construct_options (ACE_HANDLE fd,
 174 //                            int qos_kb,
 175 //                            int flags,
 176 //                            long *optsize);
 177 //   // Construct options for ATM connections
 178
 179 private:
 180   ATM_Addr atm_addr_;
 181 };
 182
 183 // Close versioned namespace, if enabled by the user.
 184 ACE_END_VERSIONED_NAMESPACE_DECL
 185
 186
 187 #if defined (__ACE_INLINE__)
 188 #include "ace/ATM_Addr.inl"
 189 #endif /* __ACE_INLINE__ */
 190
 191 #endif /* ACE_HAS_ATM */
 192 #include /**/ "ace/post.h"
 193 #endif /* ACE_ATM_ADDR_H */