AceSmartSoft API Documentation
Public Types | Public Member Functions | List of all members
SmartACE::TimerHandlerHandleUpcall< ACE_LOCK > Class Template Reference

Functor for Timer_Queues. More...

#include <smartTimerManagerThread.hh>

Public Types

typedef ACE_Timer_Queue_T< Smart::ITimerHandler *, TimerHandlerHandleUpcall< ACE_LOCK >, ACE_LOCK > TIMER_QUEUE
 

Public Member Functions

 TimerHandlerHandleUpcall ()
 Constructor. More...
 
 ~TimerHandlerHandleUpcall ()
 Destructor. More...
 
int timeout (TIMER_QUEUE &timer_queue, Smart::ITimerHandler *handler, const void *arg, int recurring_timer, const ACE_Time_Value &cur_time)
 This method is called when the timer expires. More...
 
int cancel_timer (TIMER_QUEUE &timer_queue, Smart::ITimerHandler *handler, int dont_call_handle_close, int requires_reference_counting)
 This method is called when the timer is cancelled. More...
 
int deletion (TIMER_QUEUE &timer_queue, Smart::ITimerHandler *handler, const void *arg)
 This method is called when the timer queue is destroyed and the timer is still contained in it. More...
 
int registration (TIMER_QUEUE &timer_queue, Smart::ITimerHandler *handler, const void *arg)
 This method is called when a time is registered. More...
 
int preinvoke (TIMER_QUEUE &timer_queue, Smart::ITimerHandler *handler, const void *arg, int reccuring_timer, const ACE_Time_Value &cur_time, const void *upcall_act)
 This method is called before the timer expires. More...
 
int postinvoke (TIMER_QUEUE &timer_queue, Smart::ITimerHandler *handler, const void *arg, int recurring_timer, const ACE_Time_Value &cur_time, const void *upcall_act)
 This method is called after the timer expires. More...
 
int cancel_type (TIMER_QUEUE &timer_queue, Smart::ITimerHandler *handler, int dont_call_handle_close, int &requires_reference_counting)
 This method is called when a handler is canceled. More...
 

Detailed Description

template<class ACE_LOCK>
class SmartACE::TimerHandlerHandleUpcall< ACE_LOCK >

Functor for Timer_Queues.

This class implements the functor required by ACE_Timer_Queue to call the Handler method in a TimerHandler Object

Member Typedef Documentation

◆ TIMER_QUEUE

template<class ACE_LOCK >
typedef ACE_Timer_Queue_T<Smart::ITimerHandler *, TimerHandlerHandleUpcall<ACE_LOCK>, ACE_LOCK> SmartACE::TimerHandlerHandleUpcall< ACE_LOCK >::TIMER_QUEUE

Constructor & Destructor Documentation

◆ TimerHandlerHandleUpcall()

template<class ACE_LOCK >
SmartACE::TimerHandlerHandleUpcall< ACE_LOCK >::TimerHandlerHandleUpcall ( )
inline

Constructor.

◆ ~TimerHandlerHandleUpcall()

template<class ACE_LOCK >
SmartACE::TimerHandlerHandleUpcall< ACE_LOCK >::~TimerHandlerHandleUpcall ( )
inline

Destructor.

Member Function Documentation

◆ cancel_timer()

template<class ACE_LOCK >
int SmartACE::TimerHandlerHandleUpcall< ACE_LOCK >::cancel_timer ( TIMER_QUEUE timer_queue,
Smart::ITimerHandler *  handler,
int  dont_call_handle_close,
int  requires_reference_counting 
)
inline

This method is called when the timer is cancelled.

◆ cancel_type()

template<class ACE_LOCK >
int SmartACE::TimerHandlerHandleUpcall< ACE_LOCK >::cancel_type ( TIMER_QUEUE timer_queue,
Smart::ITimerHandler *  handler,
int  dont_call_handle_close,
int &  requires_reference_counting 
)
inline

This method is called when a handler is canceled.

◆ deletion()

template<class ACE_LOCK >
int SmartACE::TimerHandlerHandleUpcall< ACE_LOCK >::deletion ( TIMER_QUEUE timer_queue,
Smart::ITimerHandler *  handler,
const void *  arg 
)
inline

This method is called when the timer queue is destroyed and the timer is still contained in it.

◆ postinvoke()

template<class ACE_LOCK >
int SmartACE::TimerHandlerHandleUpcall< ACE_LOCK >::postinvoke ( TIMER_QUEUE timer_queue,
Smart::ITimerHandler *  handler,
const void *  arg,
int  recurring_timer,
const ACE_Time_Value &  cur_time,
const void *  upcall_act 
)
inline

This method is called after the timer expires.

◆ preinvoke()

template<class ACE_LOCK >
int SmartACE::TimerHandlerHandleUpcall< ACE_LOCK >::preinvoke ( TIMER_QUEUE timer_queue,
Smart::ITimerHandler *  handler,
const void *  arg,
int  reccuring_timer,
const ACE_Time_Value &  cur_time,
const void *  upcall_act 
)
inline

This method is called before the timer expires.

◆ registration()

template<class ACE_LOCK >
int SmartACE::TimerHandlerHandleUpcall< ACE_LOCK >::registration ( TIMER_QUEUE timer_queue,
Smart::ITimerHandler *  handler,
const void *  arg 
)
inline

This method is called when a time is registered.

◆ timeout()

template<class ACE_LOCK >
int SmartACE::TimerHandlerHandleUpcall< ACE_LOCK >::timeout ( TIMER_QUEUE timer_queue,
Smart::ITimerHandler *  handler,
const void *  arg,
int  recurring_timer,
const ACE_Time_Value &  cur_time 
)
inline

This method is called when the timer expires.


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