File: ACE_Asynch_Transmit_File__Result.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 (141 lines) | stat: -rw-r--r-- 4,040 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
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
.TH ACE_Asynch_Transmit_File::Result 3 "1 Dec 2001" "ACE" \" -*- nroff -*-
.ad l
.nh
.SH NAME
ACE_Asynch_Transmit_File::Result \- This is that class which will be passed back to the <handler> when the asynchronous transmit file completes. 
.SH SYNOPSIS
.br
.PP
\fC#include <Asynch_IO.h>\fR
.PP
Inherits \fBACE_Asynch_Result\fR.
.PP
.SS Public Methods

.in +1c
.ti -1c
.RI "ACE_HANDLE \fBsocket\fR (void) const"
.br
.RI "\fISocket used for transmitting the file.\fR"
.ti -1c
.RI "ACE_HANDLE \fBfile\fR (void) const"
.br
.RI "\fIFile from which the data is read.\fR"
.ti -1c
.RI "\fBHeader_And_Trailer\fR* \fBheader_and_trailer\fR (void) const"
.br
.RI "\fIHeader and trailer data associated with this transmit file.\fR"
.ti -1c
.RI "u_long \fBbytes_to_write\fR (void) const"
.br
.RI "\fIThe number of bytes which were requested at the start of the asynchronous transmit file.\fR"
.ti -1c
.RI "u_long \fBbytes_per_send\fR (void) const"
.br
.RI "\fINumber of bytes per send requested at the start of the transmit file.\fR"
.ti -1c
.RI "u_long \fBflags\fR (void) const"
.br
.RI "\fIFlags which were passed into transmit file.\fR"
.ti -1c
.RI "\fBACE_Asynch_Transmit_File_Result_Impl\fR* \fBimplementation\fR (void) const"
.br
.RI "\fIGet the implementation class.\fR"
.in -1c
.SS Protected Methods

.in +1c
.ti -1c
.RI "\fBResult\fR (\fBACE_Asynch_Transmit_File_Result_Impl\fR *implementation)"
.br
.RI "\fIConstructor.\fR"
.ti -1c
.RI "virtual \fB~Result\fR (void)"
.br
.RI "\fIDestructor.\fR"
.in -1c
.SS Protected Attributes

.in +1c
.ti -1c
.RI "\fBACE_Asynch_Transmit_File_Result_Impl\fR* \fBimplementation_\fR"
.br
.RI "\fIThe implementation class.\fR"
.in -1c
.SS Friends

.in +1c
.ti -1c
.RI "class \fBACE_POSIX_Asynch_Transmit_File_Result\fR"
.br
.ti -1c
.RI "class \fBACE_WIN32_Asynch_Transmit_File_Result\fR"
.br
.in -1c
.SH DETAILED DESCRIPTION
.PP 
This is that class which will be passed back to the <handler> when the asynchronous transmit file completes.
.PP
.PP
 This class has all the information necessary for the <handler> to uniquiely identify the completion of the asynchronous transmit file. 
.PP
.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION
.PP 
.SS ACE_Asynch_Transmit_File::Result::Result (\fBACE_Asynch_Transmit_File_Result_Impl\fR * implementation)\fC [protected]\fR
.PP
Constructor.
.PP
.SS ACE_Asynch_Transmit_File::Result::~Result (void)\fC [protected, virtual]\fR
.PP
Destructor.
.PP
.SH MEMBER FUNCTION DOCUMENTATION
.PP 
.SS u_long ACE_Asynch_Transmit_File::Result::bytes_per_send (void) const
.PP
Number of bytes per send requested at the start of the transmit file.
.PP
.SS u_long ACE_Asynch_Transmit_File::Result::bytes_to_write (void) const
.PP
The number of bytes which were requested at the start of the asynchronous transmit file.
.PP
.SS ACE_HANDLE ACE_Asynch_Transmit_File::Result::file (void) const
.PP
File from which the data is read.
.PP
.SS u_long ACE_Asynch_Transmit_File::Result::flags (void) const
.PP
Flags which were passed into transmit file.
.PP
.SS \fBHeader_And_Trailer\fR * ACE_Asynch_Transmit_File::Result::header_and_trailer (void) const
.PP
Header and trailer data associated with this transmit file.
.PP
.SS \fBACE_Asynch_Transmit_File_Result_Impl\fR * ACE_Asynch_Transmit_File::Result::implementation (void) const
.PP
Get the implementation class.
.PP
Reimplemented from \fBACE_Asynch_Result\fR.
.SS ACE_HANDLE ACE_Asynch_Transmit_File::Result::socket (void) const
.PP
Socket used for transmitting the file.
.PP
.SH FRIENDS AND RELATED FUNCTION DOCUMENTATION
.PP 
.SS class ACE_POSIX_Asynch_Transmit_File_Result\fC [friend]\fR
.PP
The concrete implementation result classes only construct this class.
.PP
.SS class ACE_WIN32_Asynch_Transmit_File_Result\fC [friend]\fR
.PP
.SH MEMBER DATA DOCUMENTATION
.PP 
.SS \fBACE_Asynch_Transmit_File_Result_Impl\fR * ACE_Asynch_Transmit_File::Result::implementation_\fC [protected]\fR
.PP
The implementation class.
.PP
Reimplemented from \fBACE_Asynch_Result\fR.

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