ACE/ace/ATM_QoS.h

   1 // -*- C++ -*-
   2
   3 //==========================================================================
   4 /**
   5  *  @file    ATM_QoS.h
   6  *
   7  *  @author Joe Hoffert
   8  */
   9 //==========================================================================
  10
  11 #ifndef ACE_ATM_QoS_H
  12 #define ACE_ATM_QoS_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 #if defined (ACE_HAS_FORE_ATM_WS2)
  24 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  25 // just map to WS2 GQOS struct
  26 typedef ACE_QoS ATM_QoS;
  27 ACE_END_VERSIONED_NAMESPACE_DECL
  28 #elif defined (ACE_HAS_FORE_ATM_XTI)
  29 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  30 typedef struct netbuf ATM_QoS;
  31 ACE_END_VERSIONED_NAMESPACE_DECL
  32 #elif defined (ACE_HAS_LINUX_ATM)
  33 #include /**/ "atm.h"
  34 #include "ace/ATM_Params.h"
  35 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  36 typedef struct atm_qos ATM_QoS;
  37 ACE_END_VERSIONED_NAMESPACE_DECL
  38 #else
  39 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  40 typedef int ATM_QoS;
  41 ACE_END_VERSIONED_NAMESPACE_DECL
  42 #endif /* ACE_HAS_FORE_ATM_WS2 || ACE_HAS_FORE_ATM_XTI || ACE_HAS_LINUX_ATM */
  43
  44 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  45
  46 /**
  47  * @class ACE_ATM_QoS
  48  *
  49  * @brief Define the QoS parameters for ATM
  50  *
  51  * This class wraps up QoS parameters for both ATM/XTI and
  52  * ATM/WinSock2 to make the mechanism for the ATM protocol
  53  * transparent.
  54  */
  55 class ACE_Export ACE_ATM_QoS
  56 {
  57 public:
  58   // Constants used for ATM options
  59   static const long LINE_RATE;
  60   static const int OPT_FLAGS_CPID;
  61   static const int OPT_FLAGS_PMP;
  62   static const int DEFAULT_SELECTOR;
  63   static const int DEFAULT_PKT_SIZE;
  64
  65   /// Default constructor.
  66   ACE_ATM_QoS(int = DEFAULT_PKT_SIZE);
  67
  68   /// Constructor with a CBR rate.
  69   ACE_ATM_QoS(int,
  70               int = DEFAULT_PKT_SIZE);
  71
  72   ~ACE_ATM_QoS ();
  73
  74   /// Set the rate.
  75   void set_rate (ACE_HANDLE,
  76                  int,
  77                  int);
  78
  79   /// Set CBR rate in cells per second.
  80   void set_cbr_rate (int,
  81                      int = DEFAULT_PKT_SIZE);
  82
  83   /// Get ATM_QoS struct.
  84   ATM_QoS get_qos ();
  85
  86   /// Dump the state of an object.
  87   void dump () const;
  88
  89   /// Declare the dynamic allocation hooks.
  90   ACE_ALLOC_HOOK_DECLARE;
  91
  92 protected:
  93   /// Construct QoS options.
  94   char* construct_options(ACE_HANDLE,
  95                           int,
  96                           int,
  97                           long*);
  98
  99 private:
 100   ATM_QoS qos_;
 101 };
 102
 103 ACE_END_VERSIONED_NAMESPACE_DECL
 104
 105 #if defined (__ACE_INLINE__)
 106 #include "ace/ATM_QoS.inl"
 107 #endif /* __ACE_INLINE__ */
 108
 109 #endif /* ACE_HAS_ATM */
 110 #include /**/ "ace/post.h"
 111 #endif /* ACE_ATM_QoS_H */