#include <SporadicTask.h>

Inheritance diagram for OpenDDS::DCPS::SporadicTask:

[legend]

Collaboration diagram for OpenDDS::DCPS::SporadicTask:

[legend]

Classes
struct	SporadicCommand

Public Member Functions
	SporadicTask (const TimeSource &time_source, RcHandle< ReactorInterceptor > interceptor)

virtual	~SporadicTask ()

void	schedule (const TimeDuration &delay)

void	cancel ()

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

Protected Member Functions
long	get_timer_id ()

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 ()

Private Member Functions
void	execute_i ()

int	handle_timeout (const ACE_Time_Value &tv, const void *)

Private Attributes
const TimeSource &	time_source_

WeakRcHandle< ReactorInterceptor >	interceptor_

bool	desired_scheduled_

MonotonicTimePoint	desired_next_time_

TimeDuration	desired_delay_

long	timer_id_

MonotonicTimePoint	actual_next_time_

RcHandle< SporadicCommand >	sporadic_command_

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 Attributes inherited from ACE_Event_Handler
Atomic_Reference_Count	reference_count_

Detailed Description

Definition at line 21 of file SporadicTask.h.

Constructor & Destructor Documentation

◆ SporadicTask()

OpenDDS::DCPS::SporadicTask::SporadicTask	(	const TimeSource &	time_source,
		RcHandle< ReactorInterceptor >	interceptor
	)

inline

Definition at line 23 of file SporadicTask.h.

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

     : time_source_(time_source)
     , interceptor_(interceptor)
     , desired_scheduled_(false)
     , timer_id_(-1)
     , sporadic_command_(make_rch<SporadicCommand>(rchandle_from(this)))
   {
     reactor(interceptor->reactor());
   }

◆ ~SporadicTask()

virtual OpenDDS::DCPS::SporadicTask::~SporadicTask ( )

inlinevirtual

Definition at line 34 of file SporadicTask.h.

34 {}

Member Function Documentation

◆ cancel()

void OpenDDS::DCPS::SporadicTask::cancel ( void )

inline

Definition at line 60 of file SporadicTask.h.

References ACE_ERROR, desired_scheduled_, OpenDDS::DCPS::LogLevel::Error, execute(), OpenDDS::DCPS::ReactorInterceptor::execute_or_enqueue(), interceptor_, LM_ERROR, OpenDDS::DCPS::log_level, mutex_, and sporadic_command_.

Referenced by OpenDDS::Security::AccessControlBuiltInImpl::RevokePermissionsTask::insert().

   {
     {
       ACE_Guard<ACE_Thread_Mutex> guard(mutex_);
       if (!desired_scheduled_) {
         return;
       }
 
       desired_scheduled_ = false;
     }
 
     RcHandle<ReactorInterceptor> interceptor = interceptor_.lock();
     if (interceptor) {
       interceptor->execute_or_enqueue(sporadic_command_);
     } else if (log_level >= LogLevel::Error) {
       ACE_ERROR((LM_ERROR,
                  "(%P|%t) ERROR: SporadicTask::cancel: "
                  "failed to receive ReactorInterceptor handle\n"));
     }
   }

◆ execute()

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

pure virtual

Implemented in OpenDDS::Security::AccessControlBuiltInImpl::RevokePermissionsTask, OpenDDS::DCPS::PmfSporadicTask< Delegate >, and OpenDDS::DCPS::PmfSporadicTask< OpenDDS::DCPS::WriteDataContainer >.

Referenced by cancel().

◆ execute_i()

void OpenDDS::DCPS::SporadicTask::execute_i ( )

inlineprivate

Definition at line 113 of file SporadicTask.h.

References ACE_ERROR, ACE_Reactor::cancel_timer(), desired_next_time_, OpenDDS::DCPS::LogLevel::Error, LM_ERROR, OpenDDS::DCPS::log_level, OpenDDS::DCPS::ReactorInterceptor::Command::reactor(), ACE_Reactor::schedule_timer(), and OpenDDS::DCPS::TimeDuration::value().

   {
     ACE_Guard<ACE_Thread_Mutex> guard(mutex_);
 
     if ((!desired_scheduled_ && timer_id_ != -1) ||
         (desired_scheduled_ && timer_id_ != -1 && desired_next_time_ != actual_next_time_)) {
       reactor()->cancel_timer(timer_id_);
       timer_id_ = -1;
     }
 
     if (desired_scheduled_ && timer_id_ == -1) {
       timer_id_ = reactor()->schedule_timer(this, 0, desired_delay_.value());
       if (timer_id_ == -1) {
         if (log_level >= LogLevel::Error) {
           ACE_ERROR((LM_ERROR,
                      "(%P|%t) ERROR: SporadicTask::execute_i: "
                      "failed to schedule timer %p\n", ""));
         }
       } else {
         actual_next_time_ = desired_next_time_;
       }
     }
   }

◆ get_timer_id()

long OpenDDS::DCPS::SporadicTask::get_timer_id ( )

inlineprotected

Definition at line 84 of file SporadicTask.h.

References timer_id_.

84 { return timer_id_; }

OpenDDS::DCPS::SporadicTask::timer_id_

long timer_id_

Definition: SporadicTask.h:108

◆ handle_timeout()

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

inlineprivatevirtual

Reimplemented from ACE_Event_Handler.

Definition at line 137 of file SporadicTask.h.

References OpenDDS::DCPS::SporadicTask::SporadicCommand::execute(), and TheServiceParticipant.

   {
     ThreadStatusManager::Event ev(TheServiceParticipant->get_thread_status_manager());
 
     const MonotonicTimePoint now(tv);
     {
       ACE_Guard<ACE_Thread_Mutex> guard(mutex_);
       desired_scheduled_ = false;
       timer_id_ = -1;
     }
     execute(now);
     return 0;
   }

◆ schedule()

void OpenDDS::DCPS::SporadicTask::schedule ( const TimeDuration & delay )

inline

Definition at line 36 of file SporadicTask.h.

References ACE_ERROR, desired_delay_, desired_next_time_, desired_scheduled_, OpenDDS::DCPS::LogLevel::Error, OpenDDS::DCPS::ReactorInterceptor::execute_or_enqueue(), interceptor_, LM_ERROR, OpenDDS::DCPS::log_level, OpenDDS::DCPS::TimeSource::monotonic_time_point_now(), mutex_, sporadic_command_, and time_source_.

Referenced by OpenDDS::Security::AccessControlBuiltInImpl::RevokePermissionsTask::execute(), and OpenDDS::Security::AccessControlBuiltInImpl::RevokePermissionsTask::insert().

   {
     const MonotonicTimePoint next_time = time_source_.monotonic_time_point_now() + delay;
     {
       ACE_Guard<ACE_Thread_Mutex> guard(mutex_);
       if (!desired_scheduled_ || next_time < desired_next_time_) {
         desired_scheduled_ = true;
         desired_next_time_ = next_time;
         desired_delay_ = delay;
       } else {
         return;
       }
     }
 
     RcHandle<ReactorInterceptor> interceptor = interceptor_.lock();
     if (interceptor) {
       interceptor->execute_or_enqueue(sporadic_command_);
     } else if (log_level >= LogLevel::Error) {
       ACE_ERROR((LM_ERROR,
                  "(%P|%t) ERROR: SporadicTask::schedule: "
                  "failed to receive ReactorInterceptor handle\n"));
     }
   }

Member Data Documentation

◆ actual_next_time_

MonotonicTimePoint OpenDDS::DCPS::SporadicTask::actual_next_time_

private

Definition at line 109 of file SporadicTask.h.

◆ desired_delay_

TimeDuration OpenDDS::DCPS::SporadicTask::desired_delay_

private

Definition at line 107 of file SporadicTask.h.

Referenced by schedule().

◆ desired_next_time_

MonotonicTimePoint OpenDDS::DCPS::SporadicTask::desired_next_time_

private

Definition at line 106 of file SporadicTask.h.

Referenced by execute_i(), and schedule().

◆ desired_scheduled_

bool OpenDDS::DCPS::SporadicTask::desired_scheduled_

private

Definition at line 105 of file SporadicTask.h.

Referenced by cancel(), and schedule().

◆ interceptor_

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

private

Definition at line 104 of file SporadicTask.h.

Referenced by cancel(), and schedule().

◆ mutex_

ACE_Thread_Mutex OpenDDS::DCPS::SporadicTask::mutex_

mutableprivate

Definition at line 111 of file SporadicTask.h.

Referenced by cancel(), and schedule().

◆ sporadic_command_

RcHandle<SporadicCommand> OpenDDS::DCPS::SporadicTask::sporadic_command_

private

Definition at line 110 of file SporadicTask.h.

Referenced by cancel(), and schedule().

◆ time_source_

const TimeSource& OpenDDS::DCPS::SporadicTask::time_source_

private

Definition at line 103 of file SporadicTask.h.

Referenced by schedule().

◆ timer_id_

long OpenDDS::DCPS::SporadicTask::timer_id_

private

Definition at line 108 of file SporadicTask.h.

Referenced by get_timer_id().

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

SporadicTask.h

Classes

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SporadicTask()

◆ ~SporadicTask()

Member Function Documentation

◆ cancel()

◆ execute()

◆ execute_i()

◆ get_timer_id()

◆ handle_timeout()

◆ schedule()

Member Data Documentation

◆ actual_next_time_

◆ desired_delay_

◆ desired_next_time_

◆ desired_scheduled_

◆ interceptor_

◆ mutex_

◆ sporadic_command_

◆ time_source_

◆ timer_id_