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
|
.TH ACE_WIN32_Asynch_Read_Stream 3 "1 Dec 2001" "ACE" \" -*- nroff -*-
.ad l
.nh
.SH NAME
ACE_WIN32_Asynch_Read_Stream \- This class is a factory for starting off asynchronous reads on a stream.
.SH SYNOPSIS
.br
.PP
\fC#include <WIN32_Asynch_IO.h>\fR
.PP
Inherits \fBACE_Asynch_Read_Stream_Impl\fR, and \fBACE_WIN32_Asynch_Operation\fR.
.PP
Inherited by \fBACE_WIN32_Asynch_Read_File\fR.
.PP
.SS Public Methods
.in +1c
.ti -1c
.RI "\fBACE_WIN32_Asynch_Read_Stream\fR (\fBACE_WIN32_Proactor\fR *win32_proactor)"
.br
.RI "\fIConstructor.\fR"
.ti -1c
.RI "int \fBread\fR (\fBACE_Message_Block\fR &message_block, u_long bytes_to_read, const void *act, int priority, int signal_number = 0)"
.br
.RI "\fIThis starts off an asynchronous read. Upto <bytes_to_read> will be read and stored in the <message_block>.\fR"
.ti -1c
.RI "virtual \fB~ACE_WIN32_Asynch_Read_Stream\fR (void)"
.br
.RI "\fIDestructor.\fR"
.ti -1c
.RI "int \fBopen\fR (\fBACE_Handler\fR &handler, ACE_HANDLE handle, const void *completion_key, \fBACE_Proactor\fR *proactor)"
.br
.ti -1c
.RI "int \fBcancel\fR (void)"
.br
.ti -1c
.RI "\fBACE_Proactor\fR* \fBproactor\fR (void) const"
.br
.RI "\fIReturn the underlying proactor.\fR"
.in -1c
.SS Protected Methods
.in +1c
.ti -1c
.RI "int \fBshared_read\fR (\fBACE_WIN32_Asynch_Read_Stream_Result\fR *result)"
.br
.RI "\fIThis is the method which does the real work and is there so that the \fBACE_Asynch_Read_File\fR class can use it too.\fR"
.in -1c
.SH DETAILED DESCRIPTION
.PP
This class is a factory for starting off asynchronous reads on a stream.
.PP
.PP
Once <open> is called, multiple asynchronous <read>s can started using this class. An \fBACE_Asynch_Read_Stream::Result\fR will be passed back to the <handler> when the asynchronous reads completes through the callback.
.PP
.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION
.PP
.SS ACE_WIN32_Asynch_Read_Stream::ACE_WIN32_Asynch_Read_Stream (\fBACE_WIN32_Proactor\fR * win32_proactor)
.PP
Constructor.
.PP
.SS ACE_WIN32_Asynch_Read_Stream::~ACE_WIN32_Asynch_Read_Stream (void)\fC [virtual]\fR
.PP
Destructor.
.PP
.SH MEMBER FUNCTION DOCUMENTATION
.PP
.SS int ACE_WIN32_Asynch_Read_Stream::cancel (void)
.PP
This cancels all pending accepts operations that were issued by the calling thread. The function does not cancel asynchronous operations issued by other threads.
.PP
Reimplemented from \fBACE_WIN32_Asynch_Operation\fR.
.PP
Reimplemented in \fBACE_WIN32_Asynch_Read_File\fR.
.SS int ACE_WIN32_Asynch_Read_Stream::open (\fBACE_Handler\fR & handler, ACE_HANDLE handle, const void * completion_key, \fBACE_Proactor\fR * proactor)
.PP
Initializes the factory with information which will be used with each asynchronous call. If (<handle> == ACE_INVALID_HANDLE), will be called on the <handler> to get the correct handle.
.PP
Reimplemented from \fBACE_WIN32_Asynch_Operation\fR.
.PP
Reimplemented in \fBACE_WIN32_Asynch_Read_File\fR.
.SS \fBACE_Proactor\fR * ACE_WIN32_Asynch_Read_Stream::proactor (void) const
.PP
Return the underlying proactor.
.PP
Reimplemented from \fBACE_WIN32_Asynch_Operation\fR.
.PP
Reimplemented in \fBACE_WIN32_Asynch_Read_File\fR.
.SS int ACE_WIN32_Asynch_Read_Stream::read (\fBACE_Message_Block\fR & message_block, u_long bytes_to_read, const void * act, int priority, int signal_number = 0)
.PP
This starts off an asynchronous read. Upto <bytes_to_read> will be read and stored in the <message_block>.
.PP
Reimplemented in \fBACE_WIN32_Asynch_Read_File\fR.
.SS int ACE_WIN32_Asynch_Read_Stream::shared_read (\fBACE_WIN32_Asynch_Read_Stream_Result\fR * result)\fC [protected]\fR
.PP
This is the method which does the real work and is there so that the \fBACE_Asynch_Read_File\fR class can use it too.
.PP
.SH AUTHOR
.PP
Generated automatically by Doxygen for ACE from the source code.
|
