#include <MultiTask.h>

Inheritance diagram for OpenDDS::DCPS::MultiTask:

[legend]

Collaboration diagram for OpenDDS::DCPS::MultiTask:

[legend]

Classes
struct	ScheduleDisableCommand

struct	ScheduleEnableCommand

Public Member Functions
	MultiTask (RcHandle< ReactorInterceptor > interceptor, const TimeDuration &delay)

virtual	~MultiTask ()

void	enable (const TimeDuration &delay)

void	disable ()

virtual void	execute (const MonotonicTimePoint &now)=0

Public Member Functions inherited from OpenDDS::DCPS::RcEventHandler
	RcEventHandler ()

ACE_Event_Handler::Reference_Count	add_reference ()

ACE_Event_Handler::Reference_Count	remove_reference ()

Public Member Functions inherited from ACE_Event_Handler
virtual	~ACE_Event_Handler (void)

virtual ACE_HANDLE	get_handle (void) const

virtual void	set_handle (ACE_HANDLE)

virtual int	priority (void) const

virtual void	priority (int priority)

virtual int	handle_input (ACE_HANDLE fd=ACE_INVALID_HANDLE)

virtual int	handle_output (ACE_HANDLE fd=ACE_INVALID_HANDLE)

virtual int	handle_exception (ACE_HANDLE fd=ACE_INVALID_HANDLE)

virtual int	handle_exit (ACE_Process *)

virtual int	handle_close (ACE_HANDLE handle, ACE_Reactor_Mask close_mask)

virtual int	handle_signal (int signum, siginfo_t =0, ucontext_t =0)

virtual int	resume_handler (void)

virtual int	handle_qos (ACE_HANDLE=ACE_INVALID_HANDLE)

virtual int	handle_group_qos (ACE_HANDLE=ACE_INVALID_HANDLE)

virtual void	reactor (ACE_Reactor *reactor)

virtual ACE_Reactor *	reactor (void) const

virtual ACE_Reactor_Timer_Interface *	reactor_timer_interface (void) const

Reference_Counting_Policy &	reference_counting_policy (void)

Public Member Functions inherited from OpenDDS::DCPS::RcObject
virtual	~RcObject ()

virtual void	_add_ref ()

virtual void	_remove_ref ()

long	ref_count () const

WeakObject *	_get_weak_object () const

Private Member Functions
int	handle_timeout (const ACE_Time_Value &tv, const void *)

void	enable_i (const TimeDuration &per)

void	disable_i ()

Private Attributes
WeakRcHandle< ReactorInterceptor >	interceptor_

const TimeDuration	delay_

long	timer_

MonotonicTimePoint	next_time_

TimeDuration	cancel_estimate_

ACE_Thread_Mutex	mutex_

Additional Inherited Members
Public Types inherited from ACE_Event_Handler
typedef long	Reference_Count

Static Public Member Functions inherited from ACE_Event_Handler
static ACE_THR_FUNC_RETURN	read_adapter (void *event_handler)

static int	register_stdin_handler (ACE_Event_Handler eh, ACE_Reactor reactor, ACE_Thread_Manager *thr_mgr, int flags=THR_DETACHED)

static int	remove_stdin_handler (ACE_Reactor reactor, ACE_Thread_Manager thr_mgr)

Public Attributes inherited from ACE_Event_Handler
	LO_PRIORITY

	HI_PRIORITY

	NULL_MASK

	READ_MASK

	WRITE_MASK

	EXCEPT_MASK

	ACCEPT_MASK

	CONNECT_MASK

	TIMER_MASK

	QOS_MASK

	GROUP_QOS_MASK

	SIGNAL_MASK

	ALL_EVENTS_MASK

	RWE_MASK

	DONT_CALL

	ACE_EVENT_HANDLER_NOT_RESUMED

	ACE_REACTOR_RESUMES_HANDLER

	ACE_APPLICATION_RESUMES_HANDLER

Protected Types inherited from ACE_Event_Handler
typedef ACE_Atomic_Op< ACE_SYNCH_MUTEX, Reference_Count >	Atomic_Reference_Count

Protected Member Functions inherited from ACE_Event_Handler
	ACE_Event_Handler (ACE_Reactor *=0, int priority=ACE_Event_Handler::LO_PRIORITY)

Protected Member Functions inherited from OpenDDS::DCPS::RcObject
	RcObject ()

Protected Attributes inherited from ACE_Event_Handler
Atomic_Reference_Count	reference_count_

Detailed Description

Definition at line 21 of file MultiTask.h.

Constructor & Destructor Documentation

◆ MultiTask()

OpenDDS::DCPS::MultiTask::MultiTask	(	RcHandle< ReactorInterceptor >	interceptor,
		const TimeDuration &	delay
	)

inlineexplicit

Definition at line 23 of file MultiTask.h.

References ACE_Event_Handler::reactor(), and OpenDDS::DCPS::ReactorInterceptor::reactor().

     : interceptor_(interceptor)
     , delay_(delay)
     , timer_(-1)
     , next_time_()
     , cancel_estimate_()
   {
     reactor(interceptor->reactor());
   }

◆ ~MultiTask()

virtual OpenDDS::DCPS::MultiTask::~MultiTask ( )

inlinevirtual

Definition at line 33 of file MultiTask.h.

33 {}

Member Function Documentation

◆ disable()

void OpenDDS::DCPS::MultiTask::disable ( )

inline

Definition at line 50 of file MultiTask.h.

References execute(), OpenDDS::DCPS::ReactorInterceptor::execute_or_enqueue(), interceptor_, and OpenDDS::DCPS::rchandle_from().

   {
     RcHandle<ReactorInterceptor> interceptor = interceptor_.lock();
     if (interceptor) {
       interceptor->execute_or_enqueue(make_rch<ScheduleDisableCommand>(rchandle_from(this)));
     }
   }

◆ disable_i()

void OpenDDS::DCPS::MultiTask::disable_i ( )

inlineprivate

Definition at line 146 of file MultiTask.h.

References ACE_Reactor::cancel_timer(), and OpenDDS::DCPS::ReactorInterceptor::Command::reactor().

   {
     ACE_Guard<ACE_Thread_Mutex> guard(mutex_);
     if (timer_ != -1) {
       reactor()->cancel_timer(timer_);
       timer_ = -1;
     }
   }

◆ enable()

void OpenDDS::DCPS::MultiTask::enable ( const TimeDuration & delay )

inline

Definition at line 35 of file MultiTask.h.

References cancel_estimate_, OpenDDS::DCPS::ReactorInterceptor::execute_or_enqueue(), interceptor_, mutex_, next_time_, OpenDDS::DCPS::TimePoint_T< MonotonicClock >::now(), OpenDDS::DCPS::rchandle_from(), and timer_.

   {
     bool worth_passing_along = false;
     {
       ACE_Guard<ACE_Thread_Mutex> guard(mutex_);
       worth_passing_along = (timer_ == -1) || ((MonotonicTimePoint::now() + delay + cancel_estimate_) < next_time_);
     }
     if (worth_passing_along) {
       RcHandle<ReactorInterceptor> interceptor = interceptor_.lock();
       if (interceptor) {
         interceptor->execute_or_enqueue(make_rch<ScheduleEnableCommand>(rchandle_from(this), delay));
       }
     }
   }

◆ enable_i()

void OpenDDS::DCPS::MultiTask::enable_i ( const TimeDuration & per )

inlineprivate

Definition at line 114 of file MultiTask.h.

References ACE_ERROR, ACE_TEXT(), cancel_estimate_, ACE_Reactor::cancel_timer(), LM_ERROR, OpenDDS::DCPS::TimePoint_T< MonotonicClock >::now(), OpenDDS::DCPS::ReactorInterceptor::Command::reactor(), ACE_Reactor::schedule_timer(), and OpenDDS::DCPS::TimeDuration::value().

   {
     ACE_Guard<ACE_Thread_Mutex> guard(mutex_);
     const MonotonicTimePoint now = MonotonicTimePoint::now();
     if (timer_ == -1) {
       timer_ = reactor()->schedule_timer(this, 0, per.value(), delay_.value());
 
       if (timer_ == -1) {
         ACE_ERROR((LM_ERROR, "(%P|%t) MultiTask::enable"
                    " failed to schedule timer %p\n", ACE_TEXT("")));
       } else {
         next_time_ = now + per;
       }
     } else {
       const MonotonicTimePoint estimated_next_time = now + per + cancel_estimate_;
       if (estimated_next_time < next_time_) {
         reactor()->cancel_timer(timer_);
         const MonotonicTimePoint now2 = MonotonicTimePoint::now();
         timer_ = reactor()->schedule_timer(this, 0, per.value(), delay_.value());
         cancel_estimate_ = now2 - now;
 
         if (timer_ == -1) {
           ACE_ERROR((LM_ERROR, "(%P|%t) MultiTask::enable"
                      " failed to reschedule timer %p\n", ACE_TEXT("")));
         } else {
           next_time_ = now2 + per;
         }
       }
     }
   }

◆ execute()

virtual void OpenDDS::DCPS::MultiTask::execute ( const MonotonicTimePoint & now )

pure virtual

Implemented in OpenDDS::DCPS::PmfMultiTask< Delegate >.

Referenced by disable().

◆ handle_timeout()

int OpenDDS::DCPS::MultiTask::handle_timeout	(	const ACE_Time_Value &	tv,
		const void *
	)

inlineprivatevirtual

Reimplemented from ACE_Event_Handler.

Definition at line 101 of file MultiTask.h.

References OpenDDS::DCPS::MultiTask::ScheduleEnableCommand::delay_, OpenDDS::DCPS::MultiTask::ScheduleEnableCommand::execute(), and TheServiceParticipant.

   {
     ThreadStatusManager::Event ev(TheServiceParticipant->get_thread_status_manager());
 
     const MonotonicTimePoint now(tv);
     {
       ACE_Guard<ACE_Thread_Mutex> guard(mutex_);
       next_time_ = now + delay_;
     }
     execute(now);
     return 0;
   }

Member Data Documentation

◆ cancel_estimate_

TimeDuration OpenDDS::DCPS::MultiTask::cancel_estimate_

private

Definition at line 65 of file MultiTask.h.

Referenced by enable(), and enable_i().

◆ delay_

const TimeDuration OpenDDS::DCPS::MultiTask::delay_

private

Definition at line 62 of file MultiTask.h.

◆ interceptor_

WeakRcHandle<ReactorInterceptor> OpenDDS::DCPS::MultiTask::interceptor_

private

Definition at line 61 of file MultiTask.h.

Referenced by disable(), and enable().

◆ mutex_

ACE_Thread_Mutex OpenDDS::DCPS::MultiTask::mutex_

mutableprivate

Definition at line 66 of file MultiTask.h.

Referenced by enable().

◆ next_time_

MonotonicTimePoint OpenDDS::DCPS::MultiTask::next_time_

private

Definition at line 64 of file MultiTask.h.

Referenced by enable().

◆ timer_

long OpenDDS::DCPS::MultiTask::timer_

private

Definition at line 63 of file MultiTask.h.

Referenced by enable().

The documentation for this class was generated from the following file:

MultiTask.h

Classes

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MultiTask()

◆ ~MultiTask()

Member Function Documentation

◆ disable()

◆ disable_i()

◆ enable()

◆ enable_i()

◆ execute()

◆ handle_timeout()

Member Data Documentation

◆ cancel_estimate_

◆ delay_

◆ interceptor_

◆ mutex_

◆ next_time_

◆ timer_