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

ACE_POSIX_Asynch_Write_File_Result Class Reference

This class provides implementation for <ACE_Asynch_Write_File_Result> for POSIX platforms. More...

#include <POSIX_Asynch_IO.h>

Inheritance diagram for ACE_POSIX_Asynch_Write_File_Result:

Inheritance graph
[legend]
Collaboration diagram for ACE_POSIX_Asynch_Write_File_Result:

Collaboration graph
[legend]
List of all members.

Public Methods

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 on POSIX4 platforms. 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...

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

ACE_Message_Blockmessage_block (void) const
 Message block that contains the data to be written. More...

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

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


Protected Methods

 ACE_POSIX_Asynch_Write_File_Result (ACE_Handler &handler, ACE_HANDLE handle, ACE_Message_Block &message_block, u_long bytes_to_write, const void *act, u_long offset, u_long offset_high, ACE_HANDLE event, int priority, int signal_number)
 Constructor is protected since creation is limited to ACE_Asynch_Write_File factory. More...

virtual void complete (u_long bytes_transferred, int success, const void *completion_key, u_long error)
 ACE_Proactor will call this method when the write completes. More...

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


Friends

class ACE_POSIX_Asynch_Write_File
 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 implementation for <ACE_Asynch_Write_File_Result> for POSIX platforms.

This class has all the information necessary for the <handler> to uniquiely identify the completion of the asynchronous write.

This class differs slightly from <ACE_Asynch_Write_Stream::Result> as it calls back <ACE_Handler::handle_write_file> on the <handler> instead of <ACE_Handler::handle_write_stream>. No additional state is required by this class as <ACE_Asynch_Result> can store the <offset>.


Constructor & Destructor Documentation

ACE_POSIX_Asynch_Write_File_Result::ACE_POSIX_Asynch_Write_File_Result ACE_Handler   handler,
ACE_HANDLE    handle,
ACE_Message_Block   message_block,
u_long    bytes_to_write,
const void *    act,
u_long    offset,
u_long    offset_high,
ACE_HANDLE    event,
int    priority,
int    signal_number
[protected]
 

Constructor is protected since creation is limited to ACE_Asynch_Write_File factory.

ACE_POSIX_Asynch_Write_File_Result::~ACE_POSIX_Asynch_Write_File_Result void    [protected, virtual]
 

Destructor.


Member Function Documentation

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

ACT associated with the operation.

Reimplemented from ACE_POSIX_Asynch_Write_Stream_Result.

u_long ACE_POSIX_Asynch_Write_File_Result::bytes_to_write void    const [virtual]
 

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

Reimplemented from ACE_POSIX_Asynch_Write_Stream_Result.

u_long ACE_POSIX_Asynch_Write_File_Result::bytes_transferred void    const [virtual]
 

Number of bytes transferred by the operation.

Reimplemented from ACE_POSIX_Asynch_Write_Stream_Result.

void ACE_POSIX_Asynch_Write_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 write completes.

Reimplemented from ACE_POSIX_Asynch_Write_Stream_Result.

const void * ACE_POSIX_Asynch_Write_File_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_Write_Stream_Result.

u_long ACE_POSIX_Asynch_Write_File_Result::error void    const [virtual]
 

Error value if the operation fail.

Reimplemented from ACE_POSIX_Asynch_Write_Stream_Result.

ACE_HANDLE ACE_POSIX_Asynch_Write_File_Result::event void    const [virtual]
 

This returns ACE_INVALID_HANDLE on POSIX4 platforms.

Reimplemented from ACE_POSIX_Asynch_Write_Stream_Result.

ACE_HANDLE ACE_POSIX_Asynch_Write_File_Result::handle void    const [virtual]
 

I/O handle used for writing.

Reimplemented from ACE_POSIX_Asynch_Write_Stream_Result.

ACE_Message_Block & ACE_POSIX_Asynch_Write_File_Result::message_block void    const [virtual]
 

Message block that contains the data to be written.

Reimplemented from ACE_POSIX_Asynch_Write_Stream_Result.

u_long ACE_POSIX_Asynch_Write_File_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_Write_Stream_Result.

u_long ACE_POSIX_Asynch_Write_File_Result::offset_high void    const [virtual]
 

Reimplemented from ACE_POSIX_Asynch_Write_Stream_Result.

int ACE_POSIX_Asynch_Write_File_Result::post_completion ACE_Proactor_Impl   proactor [virtual]
 

Post <this> to the Proactor.

Reimplemented from ACE_POSIX_Asynch_Write_Stream_Result.

int ACE_POSIX_Asynch_Write_File_Result::priority void    const [virtual]
 

The priority of the asynchronous operation.

Reimplemented from ACE_POSIX_Asynch_Write_Stream_Result.

int ACE_POSIX_Asynch_Write_File_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_Write_Stream_Result.

int ACE_POSIX_Asynch_Write_File_Result::success void    const [virtual]
 

Did the operation succeed?

Reimplemented from ACE_POSIX_Asynch_Write_Stream_Result.


Friends And Related Function Documentation

friend class ACE_POSIX_Asynch_Write_File [friend]
 

Factory classes will have special permissions.

friend class ACE_POSIX_Proactor [friend]
 

The Proactor constructs the Result class for faking results.

Reimplemented from ACE_POSIX_Asynch_Write_Stream_Result.


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