# ACE_Proactor_Handle_Timeout_Upcall Class Reference

Functor for ACE_Timer_Queue. More...

`#include <Proactor.h>`

Collaboration diagram for ACE_Proactor_Handle_Timeout_Upcall:

[legend]
List of all members.

## Public Member Functions

| ACE_Proactor_Handle_Timeout_Upcall (void)
| Constructor.
int | registration (TIMER_QUEUE &timer_queue, ACE_Handler *handler, const void *arg)
| This method is called when a timer is registered.
int | preinvoke (TIMER_QUEUE &timer_queue, ACE_Handler *handler, const void *arg, int recurring_timer, const ACE_Time_Value &cur_time, const void *&upcall_act)
| This method is called before the timer expires.
int | timeout (TIMER_QUEUE &timer_queue, ACE_Handler *handler, const void *arg, int recurring_timer, const ACE_Time_Value &cur_time)
| This method is called when the timer expires.
int | postinvoke (TIMER_QUEUE &timer_queue, ACE_Handler *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.
int | cancel_type (TIMER_QUEUE &timer_queue, ACE_Handler *handler, int dont_call_handle_close, int &requires_reference_counting)
| This method is called when a handler is canceled.
int | cancel_timer (TIMER_QUEUE &timer_queue, ACE_Handler *handler, int dont_call_handle_close, int requires_reference_counting)
| This method is called when a timer is canceled.
int | deletion (TIMER_QUEUE &timer_queue, ACE_Handler *handler, const void *arg)

## Protected Member Functions

int | proactor (ACE_Proactor &proactor)
| Set the proactor. This will fail, if one is already set!

## Protected Attributes

ACE_Proactor * | proactor_

## Private Types

typedef ACE_Timer_Queue_T< ACE_Handler *, ACE_Proactor_Handle_Timeout_Upcall, ACE_SYNCH_RECURSIVE_MUTEX > | TIMER_QUEUE
| Type def for the timer queue.

## Friends

class | ACE_Proactor
| The main Proactor class has special permissions.

## Detailed Description

Functor for ACE_Timer_Queue.

This class implements the functor required by the Timer Queue to call <handle_timeout> on ACE_Handlers.

## Member Typedef Documentation

typedef ACE_Timer_Queue_T<ACE_Handler *, ACE_Proactor_Handle_Timeout_Upcall, ACE_SYNCH_RECURSIVE_MUTEX> ACE_Proactor_Handle_Timeout_Upcall::TIMER_QUEUE`[private]`

| Type def for the timer queue.

## Constructor & Destructor Documentation

ACE_Proactor_Handle_Timeout_Upcall::ACE_Proactor_Handle_Timeout_Upcall | ( | void |  | ) |

| Constructor.

## Member Function Documentation

int ACE_Proactor_Handle_Timeout_Upcall::cancel_timer | ( | TIMER_QUEUE & | timer_queue,
|  | ACE_Handler * | handler,
|  | int | dont_call_handle_close,
|  | int | requires_reference_counting
| ) |

| This method is called when a timer is canceled.

int ACE_Proactor_Handle_Timeout_Upcall::cancel_type | ( | TIMER_QUEUE & | timer_queue,
|  | ACE_Handler * | handler,
|  | int | dont_call_handle_close,
|  | int & | requires_reference_counting
| ) |

| This method is called when a handler is canceled.

int ACE_Proactor_Handle_Timeout_Upcall::deletion | ( | TIMER_QUEUE & | timer_queue,
|  | ACE_Handler * | handler,
|  | const void * | arg
| ) |

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

int ACE_Proactor_Handle_Timeout_Upcall::postinvoke | ( | TIMER_QUEUE & | timer_queue,
|  | ACE_Handler * | 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.

int ACE_Proactor_Handle_Timeout_Upcall::preinvoke | ( | TIMER_QUEUE & | timer_queue,
|  | ACE_Handler * | handler,
|  | const void * | arg,
|  | int | recurring_timer,
|  | const ACE_Time_Value & | cur_time,
|  | const void *& | upcall_act
| ) |

| This method is called before the timer expires.

int ACE_Proactor_Handle_Timeout_Upcall::proactor | ( | ACE_Proactor & | proactor | ) | `[protected]`

| Set the proactor. This will fail, if one is already set!

int ACE_Proactor_Handle_Timeout_Upcall::registration | ( | TIMER_QUEUE & | timer_queue,
|  | ACE_Handler * | handler,
|  | const void * | arg
| ) |

| This method is called when a timer is registered.

int ACE_Proactor_Handle_Timeout_Upcall::timeout | ( | TIMER_QUEUE & | timer_queue,
|  | ACE_Handler * | handler,
|  | const void * | arg,
|  | int | recurring_timer,
|  | const ACE_Time_Value & | cur_time
| ) |

| This method is called when the timer expires.

## Friends And Related Function Documentation

friend class ACE_Proactor`[friend]`

| The main Proactor class has special permissions.

## Member Data Documentation

ACE_Proactor* ACE_Proactor_Handle_Timeout_Upcall::proactor_`[protected]`

| Handle to the proactor. This is needed for posting a timer result to the Proactor's completion queue.

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

- Proactor.h
- Proactor.cpp