ACE_Event_Handler_Handle_Timeout_Upcall(3)

NAME

ACE_Event_Handler_Handle_Timeout_Upcall - Functor for Timer_Queues.

SYNOPSIS

#include <ace/Timer_Queue_T.h>
template<class ACE_LOCK>
class ACE_Event_Handler_Handle_Timeout_Upcall
{
  public:
        typedef ACE_Timer_Queue_T<ACE_Event_Handler *, ACE_Event_Handler_Handle_Timeout_Upcall<ACE_LOCK>, ACE_LOCK> TIMER_QUEUE;
        
    ACE_Event_Handler_Handle_Timeout_Upcall (void);
    ~ACE_Event_Handler_Handle_Timeout_Upcall (void);
    int timeout (
        TIMER_QUEUE &timer_queue,
        ACE_Event_Handler *handler,
        const void *arg,
        const ACE_Time_Value &cur_time
        );
    int cancellation (
        TIMER_QUEUE &timer_queue,
        ACE_Event_Handler *handler
        );
    int deletion (
        TIMER_QUEUE &timer_queue,
        ACE_Event_Handler *handler,
        const void *arg
        );
};

DESCRIPTION

This class implements the functor required by the Timer Queue to call handle_timeout on ACE_Event_Handlers.

Initialization and termination methods.

ACE_Event_Handler_Handle_Timeout_Upcall (void);

Constructor.

~ACE_Event_Handler_Handle_Timeout_Upcall (void);

Destructor.

int timeout (
    TIMER_QUEUE &timer_queue,
    ACE_Event_Handler *handler,
    const void *arg,
    const ACE_Time_Value &cur_time
    );

This method is called when the timer expires

int cancellation (
    TIMER_QUEUE &timer_queue,
    ACE_Event_Handler *handler
    );

This method is called when the timer is canceled

int deletion (
    TIMER_QUEUE &timer_queue,
    ACE_Event_Handler *handler,
    const void *arg
    );

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

AUTHOR

Doug Schmidt, Irfan Pyarali, and Darrell Brunsch

LIBRARY

ace