#include <PeriodicTask.h>

Inheritance diagram for OpenDDS::DCPS::PeriodicTask:

[legend]

Collaboration diagram for OpenDDS::DCPS::PeriodicTask:

[legend]

Classes
struct	ScheduleDisableCommand

struct	ScheduleEnableCommand

Public Member Functions
	PeriodicTask (RcHandle< ReactorInterceptor > interceptor)

virtual	~PeriodicTask ()

void	enable (bool reenable, const TimeDuration &period)

void	disable ()

bool	enabled () const

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 (bool reenable, const TimeDuration &per)

void	disable_i ()

Private Attributes
ACE_Thread_Mutex	mutex_

bool	user_enabled_

WeakRcHandle< ReactorInterceptor >	interceptor_

bool	enabled_

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 19 of file PeriodicTask.h.

Constructor & Destructor Documentation

◆ PeriodicTask()

OpenDDS::DCPS::PeriodicTask::PeriodicTask ( RcHandle< ReactorInterceptor > interceptor )

inlineexplicit

Definition at line 21 of file PeriodicTask.h.

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

     : user_enabled_(false)
     , interceptor_(interceptor)
     , enabled_(false)
   {
     reactor(interceptor->reactor());
   }

◆ ~PeriodicTask()

virtual OpenDDS::DCPS::PeriodicTask::~PeriodicTask ( )

inlinevirtual

Definition at line 29 of file PeriodicTask.h.

29 {}

Member Function Documentation

◆ disable()

void OpenDDS::DCPS::PeriodicTask::disable ( )

inline

Definition at line 43 of file PeriodicTask.h.

References ACE_GUARD, OpenDDS::DCPS::ReactorInterceptor::execute_or_enqueue(), interceptor_, mutex_, OpenDDS::DCPS::rchandle_from(), and user_enabled_.

   {
     {
       ACE_GUARD(ACE_Thread_Mutex, g, mutex_);
       user_enabled_ = false;
     }
     RcHandle<ReactorInterceptor> interceptor = interceptor_.lock();
     if (interceptor) {
       interceptor->execute_or_enqueue(make_rch<ScheduleDisableCommand>(rchandle_from(this)));
     }
   }

◆ disable_i()

void OpenDDS::DCPS::PeriodicTask::disable_i ( )

inlineprivate

Definition at line 131 of file PeriodicTask.h.

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

Referenced by enable_i().

   {
     if (enabled_) {
       reactor()->cancel_timer(this);
       enabled_ = false;
     }
   }

◆ enable()

void OpenDDS::DCPS::PeriodicTask::enable	(	bool	reenable,
		const TimeDuration &	period
	)

inline

Definition at line 31 of file PeriodicTask.h.

References ACE_GUARD, OpenDDS::DCPS::ReactorInterceptor::execute_or_enqueue(), interceptor_, mutex_, OpenDDS::DCPS::rchandle_from(), and user_enabled_.

   {
     {
       ACE_GUARD(ACE_Thread_Mutex, g, mutex_);
       user_enabled_ = true;
     }
     RcHandle<ReactorInterceptor> interceptor = interceptor_.lock();
     if (interceptor) {
       interceptor->execute_or_enqueue(make_rch<ScheduleEnableCommand>(rchandle_from(this), reenable, period));
     }
   }

◆ enable_i()

void OpenDDS::DCPS::PeriodicTask::enable_i	(	bool	reenable,
		const TimeDuration &	per
	)

inlineprivate

Definition at line 112 of file PeriodicTask.h.

References ACE_ERROR, ACE_TEXT(), disable_i(), LM_ERROR, OpenDDS::DCPS::ReactorInterceptor::Command::reactor(), ACE_Reactor::schedule_timer(), OpenDDS::DCPS::TimeDuration::value(), and ACE_Time_Value::zero.

   {
     if (!enabled_) {
       const long timer =
         reactor()->schedule_timer(this, 0, ACE_Time_Value::zero, per.value());
 
       if (timer == -1) {
         ACE_ERROR((LM_ERROR, "(%P|%t) PeriodicTask::enable"
                    " failed to schedule timer %p\n", ACE_TEXT("")));
       } else {
         enabled_ = true;
       }
     } else if (reenable) {
       disable_i();
       enable_i(false, per);
     }
   }

◆ enabled()

bool OpenDDS::DCPS::PeriodicTask::enabled ( ) const

inline

Definition at line 55 of file PeriodicTask.h.

References ACE_GUARD_RETURN, execute(), mutex_, and user_enabled_.

   {
     ACE_GUARD_RETURN(ACE_Thread_Mutex, g, mutex_, false);
     return user_enabled_;
   }

◆ execute()

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

pure virtual

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

Referenced by enabled().

◆ handle_timeout()

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

inlineprivatevirtual

Reimplemented from ACE_Event_Handler.

Definition at line 103 of file PeriodicTask.h.

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

   {
     ThreadStatusManager::Event ev(TheServiceParticipant->get_thread_status_manager());
 
     const MonotonicTimePoint now(tv);
     execute(now);
     return 0;
   }

Member Data Documentation

◆ enabled_

bool OpenDDS::DCPS::PeriodicTask::enabled_

private

Definition at line 67 of file PeriodicTask.h.

◆ interceptor_

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

private

Definition at line 66 of file PeriodicTask.h.

Referenced by disable(), and enable().

◆ mutex_

ACE_Thread_Mutex OpenDDS::DCPS::PeriodicTask::mutex_

mutableprivate

Definition at line 64 of file PeriodicTask.h.

Referenced by disable(), enable(), and enabled().

◆ user_enabled_

bool OpenDDS::DCPS::PeriodicTask::user_enabled_

private

Definition at line 65 of file PeriodicTask.h.

Referenced by disable(), enable(), and enabled().

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

PeriodicTask.h

Classes

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PeriodicTask()

◆ ~PeriodicTask()

Member Function Documentation

◆ disable()

◆ disable_i()

◆ enable()

◆ enable_i()

◆ enabled()

◆ execute()

◆ handle_timeout()

Member Data Documentation

◆ enabled_

◆ interceptor_

◆ mutex_

◆ user_enabled_