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
|
.TH ACE_Asynch_Read_Dgram::Result 3 "1 Dec 2001" "ACE" \" -*- nroff -*-
.ad l
.nh
.SH NAME
ACE_Asynch_Read_Dgram::Result \- This is the class which will be passed back to the <handler> when the asynchronous read completes. This class forwards all the methods to the implementation classes.
.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 "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 "int \fBflags\fR (void) const"
.br
.RI "\fIThe flags used in the read.\fR"
.ti -1c
.RI "int \fBremote_address\fR (\fBACE_Addr\fR& addr) const"
.br
.RI "\fIThe address of where the packet came from.\fR"
.ti -1c
.RI "ACE_HANDLE \fBhandle\fR (void) const"
.br
.RI "\fII/O handle used for reading.\fR"
.ti -1c
.RI "\fBACE_Asynch_Read_Dgram_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_Read_Dgram_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_Read_Dgram_Result_Impl\fR* \fBimplementation_\fR"
.br
.RI "\fIThe implementation class.\fR"
.in -1c
.SS Friends
.in +1c
.ti -1c
.RI "class \fBACE_POSIX_Asynch_Read_Dgram_Result\fR"
.br
.ti -1c
.RI "class \fBACE_WIN32_Asynch_Read_Dgram_Result\fR"
.br
.in -1c
.SH DETAILED DESCRIPTION
.PP
This is the class which will be passed back to the <handler> when the asynchronous read completes. This class forwards all the methods to the implementation classes.
.PP
.PP
This class has all the information necessary for the <handler> to uniquiely identify the completion of the asynchronous read.
.PP
.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION
.PP
.SS ACE_Asynch_Read_Dgram::Result::Result (\fBACE_Asynch_Read_Dgram_Result_Impl\fR * implementation)\fC [protected]\fR
.PP
Constructor.
.PP
.SS ACE_Asynch_Read_Dgram::Result::~Result (void)\fC [protected, virtual]\fR
.PP
Destructor.
.PP
.SH MEMBER FUNCTION DOCUMENTATION
.PP
.SS u_long ACE_Asynch_Read_Dgram::Result::bytes_to_read (void) const
.PP
The number of bytes which were requested at the start of the asynchronous read.
.PP
.SS int ACE_Asynch_Read_Dgram::Result::flags (void) const
.PP
The flags used in the read.
.PP
.SS ACE_HANDLE ACE_Asynch_Read_Dgram::Result::handle (void) const
.PP
I/O handle used for reading.
.PP
.SS \fBACE_Asynch_Read_Dgram_Result_Impl\fR * ACE_Asynch_Read_Dgram::Result::implementation (void) const
.PP
Get the implementation class.
.PP
Reimplemented from \fBACE_Asynch_Result\fR.
.SS \fBACE_Message_Block\fR * ACE_Asynch_Read_Dgram::Result::message_block (void) const
.PP
Message block which contains the read data.
.PP
.SS int ACE_Asynch_Read_Dgram::Result::remote_address (\fBACE_Addr\fR & addr) const
.PP
The address of where the packet came from.
.PP
.SH FRIENDS AND RELATED FUNCTION DOCUMENTATION
.PP
.SS class ACE_POSIX_Asynch_Read_Dgram_Result\fC [friend]\fR
.PP
The concrete implementation result classes only construct this class.
.PP
.SS class ACE_WIN32_Asynch_Read_Dgram_Result\fC [friend]\fR
.PP
.SH MEMBER DATA DOCUMENTATION
.PP
.SS \fBACE_Asynch_Read_Dgram_Result_Impl\fR * ACE_Asynch_Read_Dgram::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.
|