Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members Related Pages

# ACE_WIN32_Asynch_Read_File_Result Class Reference

This is class provides concrete implementation for ACE_Asynch_Read_File::Result class. More...

`#include <WIN32_Asynch_IO.h>`

Inheritance diagram for ACE_WIN32_Asynch_Read_File_Result

[legend]
Collaboration diagram for ACE_WIN32_Asynch_Read_File_Result:

[legend]
List of all members.

## Public Methods
u_long | bytes_transferred (void) const
| Number of bytes transferred by the operation.
const void* | act (void) const
| ACT associated with the operation.
int | success (void) const
| Did the operation succeed?
const void* | completion_key (void) const
u_long | error (void) const
| Error value if the operation fail.
ACE_HANDLE | event (void) const
| Event associated with the OVERLAPPED structure.
u_long | offset (void) const
| This really make sense only when doing file I/O.
u_long | offset_high (void) const
| Offset_high associated with the OVERLAPPED structure.
int | priority (void) const
| The priority of the asynchronous operation. Currently, this is not supported on Win32.
int | signal_number (void) const
| No-op. Returns 0.
u_long | bytes_to_read (void) const
| The number of bytes which were requested at the start of the asynchronous read.
ACE_Message_Block& | message_block (void) const
| Message block which contains the read data.
ACE_HANDLE | handle (void) const
| I/O handle used for reading.
int | post_completion (ACE_Proactor_Impl *proactor)
| Post <this> to the Proactor's completion port.
## Protected Methods
| ACE_WIN32_Asynch_Read_File_Result (ACE_Handler &handler, ACE_HANDLE handle, ACE_Message_Block &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 = 0)
virtual void | complete (u_long bytes_transferred, int success, const void *completion_key, u_long error)
| ACE_Proactor will call this method when the read completes.
virtual | ~ACE_WIN32_Asynch_Read_File_Result (void)
| Destructor.
## Friends
class | ACE_WIN32_Asynch_Read_File
class | ACE_WIN32_Proactor

## Detailed Description

This is class provides concrete implementation for ACE_Asynch_Read_File::Result class.

## Constructor & Destructor Documentation

ACE_WIN32_Asynch_Read_File_Result::ACE_WIN32_Asynch_Read_File_Result ( | ACE_Handler & handler,
| ACE_HANDLE handle,
| ACE_Message_Block & 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 = 0 )`[protected]`

ACE_WIN32_Asynch_Read_File_Result::~ACE_WIN32_Asynch_Read_File_Result ( | void )`[protected, virtual]`

| Destructor.

## Member Function Documentation

const void * ACE_WIN32_Asynch_Read_File_Result::act ( | void ) const

| ACT associated with the operation. Reimplemented from ACE_WIN32_Asynch_Read_Stream_Result.

u_long ACE_WIN32_Asynch_Read_File_Result::bytes_to_read ( | void ) const

| The number of bytes which were requested at the start of the asynchronous read. Reimplemented from ACE_WIN32_Asynch_Read_Stream_Result.

u_long ACE_WIN32_Asynch_Read_File_Result::bytes_transferred ( | void ) const

| Number of bytes transferred by the operation. Reimplemented from ACE_WIN32_Asynch_Read_Stream_Result.

void ACE_WIN32_Asynch_Read_File_Result::complete ( | u_long bytes_transferred,
| int success,
| const void * completion_key,
| u_long error )`[protected, virtual]`

| ACE_Proactor will call this method when the read completes. Reimplemented from ACE_WIN32_Asynch_Read_Stream_Result.

const void * ACE_WIN32_Asynch_Read_File_Result::completion_key ( | void ) const

| This returns the ACT associated with the handle when it was registered with the I/O completion port. This ACT is not the same as the ACT associated with the asynchronous operation. Reimplemented from ACE_WIN32_Asynch_Read_Stream_Result.

u_long ACE_WIN32_Asynch_Read_File_Result::error ( | void ) const

| Error value if the operation fail. Reimplemented from ACE_WIN32_Asynch_Read_Stream_Result.

ACE_HANDLE ACE_WIN32_Asynch_Read_File_Result::event ( | void ) const

| Event associated with the OVERLAPPED structure. Reimplemented from ACE_WIN32_Asynch_Read_Stream_Result.

ACE_HANDLE ACE_WIN32_Asynch_Read_File_Result::handle ( | void ) const

| I/O handle used for reading. Reimplemented from ACE_WIN32_Asynch_Read_Stream_Result.

ACE_Message_Block & ACE_WIN32_Asynch_Read_File_Result::message_block ( | void ) const

| Message block which contains the read data. Reimplemented from ACE_WIN32_Asynch_Read_Stream_Result.

u_long ACE_WIN32_Asynch_Read_File_Result::offset ( | void ) const

| This really make sense only when doing file I/O. Reimplemented from ACE_WIN32_Asynch_Read_Stream_Result.

u_long ACE_WIN32_Asynch_Read_File_Result::offset_high ( | void ) const

| Offset_high associated with the OVERLAPPED structure. Reimplemented from ACE_WIN32_Asynch_Read_Stream_Result.

int ACE_WIN32_Asynch_Read_File_Result::post_completion ( | ACE_Proactor_Impl * proactor )

| Post <this> to the Proactor's completion port. Reimplemented from ACE_WIN32_Asynch_Read_Stream_Result.

int ACE_WIN32_Asynch_Read_File_Result::priority ( | void ) const

| The priority of the asynchronous operation. Currently, this is not supported on Win32. Reimplemented from ACE_WIN32_Asynch_Read_Stream_Result.

int ACE_WIN32_Asynch_Read_File_Result::signal_number ( | void ) const

| No-op. Returns 0. Reimplemented from ACE_WIN32_Asynch_Read_Stream_Result.

int ACE_WIN32_Asynch_Read_File_Result::success ( | void ) const

| Did the operation succeed? Reimplemented from ACE_WIN32_Asynch_Read_Stream_Result.

## Friends And Related Function Documentation

class ACE_WIN32_Asynch_Read_File`[friend]`

| Factory class will have special permissions.

class ACE_WIN32_Proactor`[friend]`

| Proactor class has special permission. Reimplemented from ACE_WIN32_Asynch_Read_Stream_Result.

The documentation for this class was generated from the following files:

- WIN32_Asynch_IO.h
- WIN32_Asynch_IO.cpp