71 lines
2.0 KiB
C++
71 lines
2.0 KiB
C++
/**
|
|
* @file include/ActivMiddleware/ActivFramework/ManagedEndPointEventManagee.h
|
|
*
|
|
* @brief Header file for router ManagedEndPointEventManagee.
|
|
*/
|
|
|
|
#if (!defined ACTIV_FRAMEWORK_MANAGED_END_POINT_EVENT_MANAGEE_H)
|
|
#define ACTIV_FRAMEWORK_MANAGED_END_POINT_EVENT_MANAGEE_H
|
|
|
|
#include "ActivMiddleware/ActivFramework/External.h"
|
|
#include "ActivMiddleware/ActivFramework/ManagedEndPoint.h"
|
|
#include "ActivMiddleware/ActivBase/Posix/EventManager.h"
|
|
|
|
#include ACTIV_BOOST_INCLUDE(scoped_ptr.hpp)
|
|
|
|
//! Activ namespace.
|
|
namespace Activ
|
|
{
|
|
|
|
/**
|
|
* @brief Helper class that allows us to plug the notification event of an endpoint
|
|
* into an existing external EventManager.
|
|
*
|
|
* Note this differs from the ManagedEndPoint GetEventManager() functionality, which creates an EventManager internally to the
|
|
* ManagedEndPoint which can then be used externally to the ManagedEndPoint.
|
|
*/
|
|
class ManagedEndPointEventManagee : public EventManagee
|
|
{
|
|
public:
|
|
/**
|
|
* @brief Constructor.
|
|
*
|
|
* @param manangedEndPoint
|
|
* @param eventManager
|
|
* @param pRunHelper optional RunHelper. Only use if you want to call EventManager::Distribute() externally,
|
|
* rather than using Run().
|
|
*/
|
|
ACTIV_FRAMEWORK_API ManagedEndPointEventManagee(ManagedEndPoint &manangedEndPoint, EventManager &eventManager,
|
|
ManagedEndPoint::RunHelper * const pRunHelper = 0);
|
|
|
|
/**
|
|
* @brief Destructor.
|
|
*/
|
|
ACTIV_FRAMEWORK_API ~ManagedEndPointEventManagee();
|
|
|
|
/**
|
|
* @brief Run the EventManager.
|
|
*/
|
|
ACTIV_FRAMEWORK_API void Run();
|
|
|
|
protected:
|
|
/**
|
|
* @brief Called when there are no more messages on the endpoint.
|
|
*
|
|
* This default implementation does nothing.
|
|
*/
|
|
ACTIV_FRAMEWORK_API virtual void OnNoMessages();
|
|
|
|
private:
|
|
ACTIV_FRAMEWORK_API virtual void OnEvents(const Events events) ACTIV_OVERRIDE;
|
|
|
|
ManagedEndPoint & m_managedEndPoint;
|
|
EventManager & m_eventManager;
|
|
ManagedEndPoint::RunHelper * m_pRunHelper;
|
|
Boost::scoped_ptr<ManagedEndPoint::RunHelper> m_pScopedRunHelper;
|
|
};
|
|
|
|
} // namespace Activ
|
|
|
|
#endif // (!defined ACTIV_FRAMEWORK_MANAGED_END_POINT_EVENT_MANAGEE_H)
|