File: ACE_POSIX_AIOCB_Asynch_Read_Stream.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 (89 lines) | stat: -rw-r--r-- 3,055 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
.TH ACE_POSIX_AIOCB_Asynch_Read_Stream 3 "1 Dec 2001" "ACE" \" -*- nroff -*-
.ad l
.nh
.SH NAME
ACE_POSIX_AIOCB_Asynch_Read_Stream \- 
.SH SYNOPSIS
.br
.PP
\fC#include <POSIX_Asynch_IO.h>\fR
.PP
Inherits \fBACE_Asynch_Read_Stream_Impl\fR, and \fBACE_POSIX_AIOCB_Asynch_Operation\fR.
.PP
Inherited by \fBACE_POSIX_AIOCB_Asynch_Read_File\fR.
.PP
.SS Public Methods

.in +1c
.ti -1c
.RI "\fBACE_POSIX_AIOCB_Asynch_Read_Stream\fR (\fBACE_POSIX_AIOCB_Proactor\fR *posix_aiocb_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_POSIX_AIOCB_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 = 0)"
.br
.ti -1c
.RI "int \fBcancel\fR (void)"
.br
.RI "\fINot implemented. Returns 0.\fR"
.ti -1c
.RI "\fBACE_Proactor\fR* \fBproactor\fR (void) const"
.br
.RI "\fIReturn the underlying proactor.\fR"
.in -1c
.SH DETAILED DESCRIPTION
.PP 
This class implements  for  (Asynchronous I/O Control Blocks) based implementation of Proactor. 
.PP
.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION
.PP 
.SS ACE_POSIX_AIOCB_Asynch_Read_Stream::ACE_POSIX_AIOCB_Asynch_Read_Stream (\fBACE_POSIX_AIOCB_Proactor\fR * posix_aiocb_proactor)
.PP
Constructor.
.PP
.SS ACE_POSIX_AIOCB_Asynch_Read_Stream::~ACE_POSIX_AIOCB_Asynch_Read_Stream (void)\fC [virtual]\fR
.PP
Destructor.
.PP
.SH MEMBER FUNCTION DOCUMENTATION
.PP 
.SS int ACE_POSIX_AIOCB_Asynch_Read_Stream::cancel (void)
.PP
Not implemented. Returns 0.
.PP
@ 
.PP
Reimplemented from \fBACE_POSIX_Asynch_Operation\fR.
.PP
Reimplemented in \fBACE_POSIX_AIOCB_Asynch_Read_File\fR.
.SS int ACE_POSIX_AIOCB_Asynch_Read_Stream::open (\fBACE_Handler\fR & handler, ACE_HANDLE handle, const void * completion_key, \fBACE_Proactor\fR * proactor = 0)
.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_POSIX_Asynch_Operation\fR.
.PP
Reimplemented in \fBACE_POSIX_AIOCB_Asynch_Read_File\fR.
.SS \fBACE_Proactor\fR * ACE_POSIX_AIOCB_Asynch_Read_Stream::proactor (void) const
.PP
Return the underlying proactor.
.PP
Reimplemented from \fBACE_POSIX_Asynch_Operation\fR.
.PP
Reimplemented in \fBACE_POSIX_AIOCB_Asynch_Read_File\fR.
.SS int ACE_POSIX_AIOCB_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_POSIX_AIOCB_Asynch_Read_File\fR.

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