ACE/ace/QoS/QoS_Decorator.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file    QoS_Decorator.h
   6  *
   7  *  @author Vishal Kachroo <vishal@cs.wustl.edu>
   8  */
   9 //=============================================================================
  10
  11
  12 #ifndef QOS_DECORATOR_H
  13 #define QOS_DECORATOR_H
  14 #include /**/ "ace/pre.h"
  15
  16 #include "ace/Reactor.h"
  17
  18 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  19 # pragma once
  20 #endif /* ACE_LACKS_PRAGMA_ONCE */
  21
  22 #include "ace/INET_Addr.h"
  23 #include "ace/Event_Handler.h"
  24 #include "SOCK_Dgram_Mcast_QoS.h"
  25 #include "ACE_QoS_Export.h"
  26
  27 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  28
  29 /**
  30  * @class ACE_QoS_Decorator_Base
  31  *
  32  * @brief This class is the Decorator Pattern Base class for decorating
  33  * ACE_Event_Handler.
  34  *
  35  * It simply forwards the requests for get_handle (),
  36  * handle_input () and handle_qos () to its event_handler_
  37  * component. Concrete decorators for ACE_Event_Handler will use
  38  * this class to access the basic event handler functionality and
  39  * decorate that by their own implementation.
  40  */
  41 class ACE_QoS_Export ACE_QoS_Decorator_Base : public ACE_Event_Handler
  42 {
  43 public:
  44   // Initialization and termination methods.
  45   /// Constructor.
  46   ACE_QoS_Decorator_Base ();
  47
  48   /// Constructor.
  49   ACE_QoS_Decorator_Base (ACE_Event_Handler *event_handler);
  50
  51   /// Destructor.
  52   ~ACE_QoS_Decorator_Base ();
  53
  54   /// Forwards the request to its event_handler_ component.
  55   virtual ACE_HANDLE get_handle () const;
  56
  57   /// Forwards the request to its event_handler_ component.
  58   virtual int handle_input (ACE_HANDLE fd);
  59
  60   /// Forwards the request to its event_handler_ component.
  61   virtual int handle_qos (ACE_HANDLE fd);
  62
  63 private:
  64   /// The event handler that is decorated by this class.
  65   ACE_Event_Handler *event_handler_;
  66 };
  67
  68 /**
  69  * @class ACE_QoS_Event_Handler
  70  *
  71  * @brief This Handler is registered with the Reactor for QoS events.
  72  *
  73  * Concrete QoS decorator uses this class to receive QoS events
  74  * for RAPI.  It hides the application from knowing that it is
  75  * receiving QoS events on a different socket so the application
  76  * doesnt have to be designed differently for RAPI and GQoS.
  77  */
  78 class ACE_QoS_Export ACE_QoS_Event_Handler : public ACE_Event_Handler
  79 {
  80   /// Destructor.
  81   ~ACE_QoS_Event_Handler ();
  82
  83   /// Returns the RAPI file descriptor for receiving QoS events.
  84   virtual ACE_HANDLE get_handle () const;
  85
  86   /// Calls the base class handle_input ().
  87   virtual int handle_input (ACE_HANDLE fd);
  88
  89   /// Sets the QoS session.
  90   void qos_session (ACE_QoS_Session *qos_session);
  91
  92   friend class ACE_QoS_Decorator;
  93
  94 private:
  95   /// Constructor is private because only ACE_QoS_Decorator should
  96   /// create this object.
  97   ACE_QoS_Event_Handler ();
  98
  99   /// The QoS Decorator passes in its base for this handler to use.
 100   ACE_QoS_Event_Handler (ACE_QoS_Decorator_Base *decorator_base);
 101
 102   /// Used to get to the RAPI file descriptor for QoS Events.
 103   ACE_QoS_Session *qos_session_;
 104
 105   /// Requests on the class are forwarded to this base class;
 106   ACE_QoS_Decorator_Base *decorator_base_;
 107 };
 108
 109 /**
 110  * @class ACE_QoS_Decorator
 111  *
 112  * @brief Concrete QoS Decorator.
 113  *
 114  * Decorates the ACE_Event_Handler to additionally handle QoS
 115  * events uniformly for different QoS mechanisms like RAPI and
 116  * GQoS.
 117  */
 118 class ACE_QoS_Export ACE_QoS_Decorator : public ACE_QoS_Decorator_Base
 119 {
 120 public:
 121   // Initialization and termination methods.
 122   /// Constructor.
 123   ACE_QoS_Decorator ();
 124
 125   /// Constructor.
 126   ACE_QoS_Decorator (ACE_Event_Handler *event_handler,
 127                      ACE_QoS_Session *qos_session,
 128                      ACE_Reactor *reactor = ACE_Reactor::instance ());
 129
 130   /// Destructor.
 131   ~ACE_QoS_Decorator ();
 132
 133   /// Calls the base class get_handle ().
 134   virtual ACE_HANDLE get_handle () const;
 135
 136   /// Calls the base class handle_input ().
 137   virtual int handle_input (ACE_HANDLE fd);
 138
 139   /// Calls the base class handle_qos ().
 140   virtual int handle_qos (ACE_HANDLE fd);
 141
 142   /// This method registers the QoS Event Handler with the Reactor
 143   /// to receive RAPI events.
 144   int init ();
 145
 146 private:
 147   /// Requests on the class are forwarded to this base class;
 148   ACE_QoS_Decorator_Base *decorator_base_;
 149
 150   /// Handles the QoS events and in that sense decorates the usual
 151   /// ACE_Event_Handler.
 152   ACE_QoS_Event_Handler *qos_event_handler_;
 153
 154   /// Passed to the ACE_QoS_Event_Handler for retrieving the RAPI
 155   /// session specific information like rapi_fd.
 156   ACE_QoS_Session *qos_session_;
 157
 158   /// If the application wants to use an instance of Reactor other
 159   /// than the Singleton one.
 160   ACE_Reactor *reactor_;
 161 };
 162
 163 ACE_END_VERSIONED_NAMESPACE_DECL
 164
 165 #include /**/ "ace/post.h"
 166 #endif  /* QOS_DECORATOR_H */