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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
|
.TH ACE_POSIX_Asynch_Read_File_Result 3 "1 Dec 2001" "ACE" \" -*- nroff -*-
.ad l
.nh
.SH NAME
ACE_POSIX_Asynch_Read_File_Result \- This class provides concrete implementation for class for POSIX platforms.
.SH SYNOPSIS
.br
.PP
\fC#include <POSIX_Asynch_IO.h>\fR
.PP
Inherits \fBACE_Asynch_Read_File_Result_Impl\fR, and \fBACE_POSIX_Asynch_Read_Stream_Result\fR.
.PP
.SS Public Methods
.in +1c
.ti -1c
.RI "u_long \fBbytes_transferred\fR (void) const"
.br
.RI "\fINumber of bytes transferred by the operation.\fR"
.ti -1c
.RI "const void* \fBact\fR (void) const"
.br
.RI "\fIACT associated with the operation.\fR"
.ti -1c
.RI "int \fBsuccess\fR (void) const"
.br
.RI "\fIDid the operation succeed?\fR"
.ti -1c
.RI "const void* \fBcompletion_key\fR (void) const"
.br
.ti -1c
.RI "u_long \fBerror\fR (void) const"
.br
.RI "\fIError value if the operation fail.\fR"
.ti -1c
.RI "ACE_HANDLE \fBevent\fR (void) const"
.br
.RI "\fIThis returns ACE_INVALID_HANDLE on POSIX4 platforms.\fR"
.ti -1c
.RI "u_long \fBoffset\fR (void) const"
.br
.ti -1c
.RI "u_long \fBoffset_high\fR (void) const"
.br
.ti -1c
.RI "int \fBpriority\fR (void) const"
.br
.RI "\fIThe priority of the asynchronous operation.\fR"
.ti -1c
.RI "int \fBsignal_number\fR (void) const"
.br
.ti -1c
.RI "u_long \fBbytes_to_read\fR (void) const"
.br
.RI "\fIThe number of bytes which were requested at the start of the asynchronous read.\fR"
.ti -1c
.RI "\fBACE_Message_Block\fR& \fBmessage_block\fR (void) const"
.br
.RI "\fIMessage block which contains the read data.\fR"
.ti -1c
.RI "ACE_HANDLE \fBhandle\fR (void) const"
.br
.RI "\fII/O handle used for reading.\fR"
.ti -1c
.RI "int \fBpost_completion\fR (\fBACE_Proactor_Impl\fR *proactor)"
.br
.RI "\fIPost <this> to the Proactor.\fR"
.in -1c
.SS Protected Methods
.in +1c
.ti -1c
.RI "\fBACE_POSIX_Asynch_Read_File_Result\fR (\fBACE_Handler\fR &handler, ACE_HANDLE handle, \fBACE_Message_Block\fR &message_block, u_long bytes_to_read, const void* act, u_long offset, u_long offset_high, ACE_HANDLE event, int priority, int signal_number)"
.br
.ti -1c
.RI "virtual void \fBcomplete\fR (u_long bytes_transferred, int success, const void *completion_key, u_long error)"
.br
.RI "\fI\fBACE_Proactor\fR will call this method when the read completes.\fR"
.ti -1c
.RI "virtual \fB~ACE_POSIX_Asynch_Read_File_Result\fR (void)"
.br
.RI "\fIDestructor.\fR"
.in -1c
.SS Friends
.in +1c
.ti -1c
.RI "class \fBACE_POSIX_AIOCB_Asynch_Read_File\fR"
.br
.ti -1c
.RI "class \fBACE_POSIX_Proactor\fR"
.br
.in -1c
.SH DETAILED DESCRIPTION
.PP
This class provides concrete implementation for class for POSIX platforms.
.PP
.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION
.PP
.SS ACE_POSIX_Asynch_Read_File_Result::ACE_POSIX_Asynch_Read_File_Result (\fBACE_Handler\fR & handler, ACE_HANDLE handle, \fBACE_Message_Block\fR & message_block, u_long bytes_to_read, const void * act, u_long offset, u_long offset_high, ACE_HANDLE event, int priority, int signal_number)\fC [protected]\fR
.PP
.SS ACE_POSIX_Asynch_Read_File_Result::~ACE_POSIX_Asynch_Read_File_Result (void)\fC [protected, virtual]\fR
.PP
Destructor.
.PP
.SH MEMBER FUNCTION DOCUMENTATION
.PP
.SS const void * ACE_POSIX_Asynch_Read_File_Result::act (void) const
.PP
ACT associated with the operation.
.PP
Reimplemented from \fBACE_POSIX_Asynch_Read_Stream_Result\fR.
.SS u_long ACE_POSIX_Asynch_Read_File_Result::bytes_to_read (void) const
.PP
The number of bytes which were requested at the start of the asynchronous read.
.PP
Reimplemented from \fBACE_POSIX_Asynch_Read_Stream_Result\fR.
.SS u_long ACE_POSIX_Asynch_Read_File_Result::bytes_transferred (void) const
.PP
Number of bytes transferred by the operation.
.PP
Reimplemented from \fBACE_POSIX_Asynch_Read_Stream_Result\fR.
.SS void ACE_POSIX_Asynch_Read_File_Result::complete (u_long bytes_transferred, int success, const void * completion_key, u_long error)\fC [protected, virtual]\fR
.PP
\fBACE_Proactor\fR will call this method when the read completes.
.PP
Reimplemented from \fBACE_POSIX_Asynch_Read_Stream_Result\fR.
.SS const void * ACE_POSIX_Asynch_Read_File_Result::completion_key (void) const
.PP
This is the ACT associated with the handle on which the Asynch_Operation takes place.
.PP
@ This is not implemented for POSIX4 platforms.
.PP
Reimplemented from \fBACE_POSIX_Asynch_Read_Stream_Result\fR.
.SS u_long ACE_POSIX_Asynch_Read_File_Result::error (void) const
.PP
Error value if the operation fail.
.PP
Reimplemented from \fBACE_POSIX_Asynch_Read_Stream_Result\fR.
.SS ACE_HANDLE ACE_POSIX_Asynch_Read_File_Result::event (void) const
.PP
This returns ACE_INVALID_HANDLE on POSIX4 platforms.
.PP
Reimplemented from \fBACE_POSIX_Asynch_Read_Stream_Result\fR.
.SS ACE_HANDLE ACE_POSIX_Asynch_Read_File_Result::handle (void) const
.PP
I/O handle used for reading.
.PP
Reimplemented from \fBACE_POSIX_Asynch_Read_Stream_Result\fR.
.SS \fBACE_Message_Block\fR & ACE_POSIX_Asynch_Read_File_Result::message_block (void) const
.PP
Message block which contains the read data.
.PP
Reimplemented from \fBACE_POSIX_Asynch_Read_Stream_Result\fR.
.SS u_long ACE_POSIX_Asynch_Read_File_Result::offset (void) const
.PP
This really make sense only when doing file I/O.
.PP
@ On POSIX4-Unix, offset_high should be supported using aiocb64.
.PP
Reimplemented from \fBACE_POSIX_Asynch_Read_Stream_Result\fR.
.SS u_long ACE_POSIX_Asynch_Read_File_Result::offset_high (void) const
.PP
Reimplemented from \fBACE_POSIX_Asynch_Read_Stream_Result\fR.
.SS int ACE_POSIX_Asynch_Read_File_Result::post_completion (\fBACE_Proactor_Impl\fR * proactor)
.PP
Post <this> to the Proactor.
.PP
Reimplemented from \fBACE_POSIX_Asynch_Read_Stream_Result\fR.
.SS int ACE_POSIX_Asynch_Read_File_Result::priority (void) const
.PP
The priority of the asynchronous operation.
.PP
Reimplemented from \fBACE_POSIX_Asynch_Read_Stream_Result\fR.
.SS int ACE_POSIX_Asynch_Read_File_Result::signal_number (void) const
.PP
POSIX4 realtime signal number to be used for the operation. <signal_number> ranges from SIGRTMIN to SIGRTMAX. By default, SIGRTMIN is used to issue calls. This is a no-op on non-POSIX4 systems and returns 0.
.PP
Reimplemented from \fBACE_POSIX_Asynch_Read_Stream_Result\fR.
.SS int ACE_POSIX_Asynch_Read_File_Result::success (void) const
.PP
Did the operation succeed?
.PP
Reimplemented from \fBACE_POSIX_Asynch_Read_Stream_Result\fR.
.SH FRIENDS AND RELATED FUNCTION DOCUMENTATION
.PP
.SS class ACE_POSIX_AIOCB_Asynch_Read_File\fC [friend]\fR
.PP
Factory classes willl have special permissions.
.PP
.SS class ACE_POSIX_Proactor\fC [friend]\fR
.PP
The Proactor constructs the Result class for faking results.
.PP
Reimplemented from \fBACE_POSIX_Asynch_Read_Stream_Result\fR.
.SH AUTHOR
.PP
Generated automatically by Doxygen for ACE from the source code.
|
