diff options
Diffstat (limited to 'ace/QoS_Manager.h')
| -rw-r--r-- | ace/QoS_Manager.h | 63 |
1 files changed, 30 insertions, 33 deletions
diff --git a/ace/QoS_Manager.h b/ace/QoS_Manager.h index 66936aeeb8e..bd456270fc3 100644 --- a/ace/QoS_Manager.h +++ b/ace/QoS_Manager.h @@ -1,18 +1,15 @@ /* -*- C++ -*- */ -// $Id$ -//============================================================================ -// -// = LIBRARY -// ace -// -// = FILENAME -// QoS_Manager.h -// -// = AUTHOR -// Vishal Kachroo -// -//============================================================================ +//============================================================================= +/** + * @file QoS_Manager.h + * + * $Id$ + * + * @author Vishal Kachroo + */ +//============================================================================= + #ifndef ACE_QOS_MANAGER_H #define ACE_QOS_MANAGER_H @@ -29,42 +26,42 @@ class ACE_QoS_Session; +/** + * @class ACE_QoS_Manager + * + * @brief This class manages the QoS sessions associated with ACE_SOCK. + * + * This class provides functions to manage the QoS + * associated with a socket. The idea is to keep the management of + * QoS for a socket separate from the socket itself. Currently, the + * manager is used to manage the QoS session set. It will handle more + * responsibilities in the future. + */ class ACE_Export ACE_QoS_Manager { - // = TITLE - // This class manages the QoS sessions associated with ACE_SOCK. - // - // = DESCRIPTION - // This class provides functions to manage the QoS - // associated with a socket. The idea is to keep the management of - // QoS for a socket separate from the socket itself. Currently, the - // manager is used to manage the QoS session set. It will handle more - // responsibilities in the future. public: + /// Default ctor/dtor. ACE_QoS_Manager (void); ~ACE_QoS_Manager (void); - // Default ctor/dtor. - + + /** + * Join the given QoS session. A socket can join multiple QoS + * sessions. This call adds the given QoS session to the list of + * QoS sessions that the socket has already joined. + */ int join_qos_session (ACE_QoS_Session *qos_session); - // Join the given QoS session. A socket can join multiple QoS - // sessions. This call adds the given QoS session to the list of - // QoS sessions that the socket has already joined. typedef ACE_Unbounded_Set <ACE_QoS_Session *> ACE_QOS_SESSION_SET; + /// Get the QoS session set. ACE_QOS_SESSION_SET qos_session_set (void); - // Get the QoS session set. private: + /// Set of QoS sessions that this socket has joined. ACE_QOS_SESSION_SET qos_session_set_; - // Set of QoS sessions that this socket has joined. }; #include "ace/post.h" #endif /* ACE_QOS_MANAGER_H */ - - - - |