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

ACE_POSIX_Asynch_Read_Stream_Result Class Reference

This class provides concrete implementation for <ACE_Asynch_Read_Stream::Result> class for POSIX platforms. More...

#include <POSIX_Asynch_IO.h>

Inheritance diagram for ACE_POSIX_Asynch_Read_Stream_Result:

Inheritance graph
[legend]
Collaboration diagram for ACE_POSIX_Asynch_Read_Stream_Result:

Collaboration graph
[legend]
List of all members.

Public Methods

u_long bytes_to_read (void) const
 The number of bytes which were requested at the start of the asynchronous read. More...

ACE_Message_Blockmessage_block (void) const
 Message block which contains the read data. More...

ACE_HANDLE handle (void) const
 I/O handle used for reading. More...

u_long bytes_transferred (void) const
 Number of bytes transferred by the operation. More...

const void * act (void) const
 ACT associated with the operation. More...

int success (void) const
 Did the operation succeed? More...

const void * completion_key (void) const
 This is the ACT associated with the handle on which the Asynch_Operation takes place. More...

u_long error (void) const
 Error value if the operation fail. More...

ACE_HANDLE event (void) const
 This returns ACE_INVALID_HANDLE. More...

u_long offset (void) const
 This really make sense only when doing file I/O. More...

u_long offset_high (void) const
int priority (void) const
 The priority of the asynchronous operation. More...

int signal_number (void) const
 POSIX4 realtime signal number to be used for the operation. More...

int post_completion (ACE_Proactor_Impl *proactor)
 Post <this> to the Proactor. More...


Protected Methods

 ACE_POSIX_Asynch_Read_Stream_Result (ACE_Handler &handler, ACE_HANDLE handle, ACE_Message_Block &message_block, u_long bytes_to_read, const void *act, ACE_HANDLE event, int priority, int signal_number)
virtual void complete (u_long bytes_transferred, int success, const void *completion_key, u_long error)
 Get the data copied to this class, before calling application handler. More...

virtual ~ACE_POSIX_Asynch_Read_Stream_Result (void)
 Destructor. More...


Protected Attributes

ACE_Message_Blockmessage_block_
 Message block for reading the data into. More...


Friends

class ACE_POSIX_Asynch_Read_Stream
 Factory classes will have special permissions. More...

class ACE_POSIX_Proactor
 The Proactor constructs the Result class for faking results. More...


Detailed Description

This class provides concrete implementation for <ACE_Asynch_Read_Stream::Result> class for POSIX platforms.


Constructor & Destructor Documentation

ACE_POSIX_Asynch_Read_Stream_Result::ACE_POSIX_Asynch_Read_Stream_Result ACE_Handler   handler,
ACE_HANDLE    handle,
ACE_Message_Block   message_block,
u_long    bytes_to_read,
const void *    act,
ACE_HANDLE    event,
int    priority,
int    signal_number
[protected]
 

ACE_POSIX_Asynch_Read_Stream_Result::~ACE_POSIX_Asynch_Read_Stream_Result void    [protected, virtual]
 

Destructor.


Member Function Documentation

const void * ACE_POSIX_Asynch_Read_Stream_Result::act void    const [virtual]
 

ACT associated with the operation.

Reimplemented from ACE_POSIX_Asynch_Result.

Reimplemented in ACE_POSIX_Asynch_Read_File_Result.

u_long ACE_POSIX_Asynch_Read_Stream_Result::bytes_to_read void    const [virtual]
 

The number of bytes which were requested at the start of the asynchronous read.

Reimplemented from ACE_Asynch_Read_Stream_Result_Impl.

Reimplemented in ACE_POSIX_Asynch_Read_File_Result.

u_long ACE_POSIX_Asynch_Read_Stream_Result::bytes_transferred void    const [virtual]
 

Number of bytes transferred by the operation.

Reimplemented from ACE_POSIX_Asynch_Result.

Reimplemented in ACE_POSIX_Asynch_Read_File_Result.

void ACE_POSIX_Asynch_Read_Stream_Result::complete u_long    bytes_transferred,
int    success,
const void *    completion_key,
u_long    error
[protected, virtual]
 

Get the data copied to this class, before calling application handler.

Reimplemented from ACE_Asynch_Result_Impl.

Reimplemented in ACE_POSIX_Asynch_Read_File_Result.

const void * ACE_POSIX_Asynch_Read_Stream_Result::completion_key void    const [virtual]
 

This is the ACT associated with the handle on which the Asynch_Operation takes place.

@ This is not implemented for POSIX4 platforms.

Reimplemented from ACE_POSIX_Asynch_Result.

Reimplemented in ACE_POSIX_Asynch_Read_File_Result.

u_long ACE_POSIX_Asynch_Read_Stream_Result::error void    const [virtual]
 

Error value if the operation fail.

Reimplemented from ACE_POSIX_Asynch_Result.

Reimplemented in ACE_POSIX_Asynch_Read_File_Result.

ACE_HANDLE ACE_POSIX_Asynch_Read_Stream_Result::event void    const [virtual]
 

This returns ACE_INVALID_HANDLE.

Reimplemented from ACE_POSIX_Asynch_Result.

Reimplemented in ACE_POSIX_Asynch_Read_File_Result.

ACE_HANDLE ACE_POSIX_Asynch_Read_Stream_Result::handle void    const [virtual]
 

I/O handle used for reading.

Reimplemented from ACE_Asynch_Read_Stream_Result_Impl.

Reimplemented in ACE_POSIX_Asynch_Read_File_Result.

ACE_Message_Block & ACE_POSIX_Asynch_Read_Stream_Result::message_block void    const [virtual]
 

Message block which contains the read data.

Reimplemented from ACE_Asynch_Read_Stream_Result_Impl.

Reimplemented in ACE_POSIX_Asynch_Read_File_Result.

u_long ACE_POSIX_Asynch_Read_Stream_Result::offset void    const [virtual]
 

This really make sense only when doing file I/O.

@ On POSIX4-Unix, offset_high should be supported using aiocb64.

Reimplemented from ACE_POSIX_Asynch_Result.

Reimplemented in ACE_POSIX_Asynch_Read_File_Result.

u_long ACE_POSIX_Asynch_Read_Stream_Result::offset_high void    const [virtual]
 

Reimplemented from ACE_POSIX_Asynch_Result.

Reimplemented in ACE_POSIX_Asynch_Read_File_Result.

int ACE_POSIX_Asynch_Read_Stream_Result::post_completion ACE_Proactor_Impl   proactor [virtual]
 

Post <this> to the Proactor.

Reimplemented from ACE_POSIX_Asynch_Result.

Reimplemented in ACE_POSIX_Asynch_Read_File_Result.

int ACE_POSIX_Asynch_Read_Stream_Result::priority void    const [virtual]
 

The priority of the asynchronous operation.

Reimplemented from ACE_POSIX_Asynch_Result.

Reimplemented in ACE_POSIX_Asynch_Read_File_Result.

int ACE_POSIX_Asynch_Read_Stream_Result::signal_number void    const [virtual]
 

POSIX4 realtime signal number to be used for the operation.

<signal_number> ranges from SIGRTMIN to SIGRTMAX. By default, SIGRTMIN is used to issue <aio_> calls. This is a no-op on non-POSIX4 systems and returns 0.

Reimplemented from ACE_POSIX_Asynch_Result.

Reimplemented in ACE_POSIX_Asynch_Read_File_Result.

int ACE_POSIX_Asynch_Read_Stream_Result::success void    const [virtual]
 

Did the operation succeed?

Reimplemented from ACE_POSIX_Asynch_Result.

Reimplemented in ACE_POSIX_Asynch_Read_File_Result.


Friends And Related Function Documentation

friend class ACE_POSIX_Asynch_Read_Stream [friend]
 

Factory classes will have special permissions.

friend class ACE_POSIX_Proactor [friend]
 

The Proactor constructs the Result class for faking results.

Reimplemented in ACE_POSIX_Asynch_Read_File_Result.


Member Data Documentation

ACE_Message_Block& ACE_POSIX_Asynch_Read_Stream_Result::message_block_ [protected]
 

Message block for reading the data into.


The documentation for this class was generated from the following files:
Generated on Tue Aug 20 15:25:22 2002 for ACE by doxygen1.2.13.1 written by Dimitri van Heesch, © 1997-2001