File: ACE_POSIX_Asynch_Timer.3

package info (click to toggle)
ace 5.2.1-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 26,856 kB
  • ctags: 18,677
  • sloc: cpp: 171,831; makefile: 48,840; sh: 10,192; perl: 8,582; exp: 787; yacc: 387; lex: 140; csh: 20
file content (85 lines) | stat: -rw-r--r-- 2,572 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
.TH ACE_POSIX_Asynch_Timer 3 "1 Dec 2001" "ACE" \" -*- nroff -*-
.ad l
.nh
.SH NAME
ACE_POSIX_Asynch_Timer \- This class is posted to the completion port when a timer expires. When the <complete method> of this object is called, the <handler>'s <handle_timeout> method will be called. 
.SH SYNOPSIS
.br
.PP
\fC#include <POSIX_Proactor.h>\fR
.PP
Inherits \fBACE_POSIX_Asynch_Result\fR.
.PP
.SS Protected Methods

.in +1c
.ti -1c
.RI "\fBACE_POSIX_Asynch_Timer\fR (\fBACE_Handler\fR &handler, const void *act, const \fBACE_Time_Value\fR &tv, ACE_HANDLE event = ACE_INVALID_HANDLE, int priority = 0, int signal_number = ACE_SIGRTMIN)"
.br
.RI "\fIConstructor.\fR"
.ti -1c
.RI "virtual \fB~ACE_POSIX_Asynch_Timer\fR (void)"
.br
.RI "\fIDestructor.\fR"
.ti -1c
.RI "virtual void \fBcomplete\fR (u_long bytes_transferred, int success, const void *completion_key, u_long error = 0)"
.br
.RI "\fIThis method calls the <handler>'s handle_timeout method.\fR"
.in -1c
.SS Protected Attributes

.in +1c
.ti -1c
.RI "\fBACE_Time_Value\fR \fBtime_\fR"
.br
.RI "\fITime value requested by caller.\fR"
.in -1c
.SS Friends

.in +1c
.ti -1c
.RI "class \fBACE_POSIX_Proactor\fR"
.br
.ti -1c
.RI "class \fBACE_POSIX_SIG_Proactor\fR"
.br
.in -1c
.SH DETAILED DESCRIPTION
.PP 
This class is posted to the completion port when a timer expires. When the <complete method> of this object is called, the <handler>'s <handle_timeout> method will be called.
.PP
.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION
.PP 
.SS ACE_POSIX_Asynch_Timer::ACE_POSIX_Asynch_Timer (\fBACE_Handler\fR & handler, const void * act, const \fBACE_Time_Value\fR & tv, ACE_HANDLE event = ACE_INVALID_HANDLE, int priority = 0, int signal_number = ACE_SIGRTMIN)\fC [protected]\fR
.PP
Constructor.
.PP
.SS ACE_POSIX_Asynch_Timer::~ACE_POSIX_Asynch_Timer (void)\fC [inline, protected, virtual]\fR
.PP
Destructor.
.PP
.SH MEMBER FUNCTION DOCUMENTATION
.PP 
.SS void ACE_POSIX_Asynch_Timer::complete (u_long bytes_transferred, int success, const void * completion_key, u_long error = 0)\fC [protected, virtual]\fR
.PP
This method calls the <handler>'s handle_timeout method.
.PP
.SH FRIENDS AND RELATED FUNCTION DOCUMENTATION
.PP 
.SS class ACE_POSIX_Proactor\fC [friend]\fR
.PP
The factory method for this class is with the POSIX_Proactor class.
.PP
.SS class ACE_POSIX_SIG_Proactor\fC [friend]\fR
.PP
.SH MEMBER DATA DOCUMENTATION
.PP 
.SS \fBACE_Time_Value\fR ACE_POSIX_Asynch_Timer::time_\fC [protected]\fR
.PP
Time value requested by caller.
.PP


.SH AUTHOR
.PP 
Generated automatically by Doxygen for ACE from the source code.