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

ACE_Asynch_Write_File Class Reference

This class is a factory for starting off asynchronous writes on a file. This class forwards all methods to its implementation class. More...

#include <Asynch_IO.h>

Inheritance diagram for ACE_Asynch_Write_File:

Inheritance graph
[legend]
Collaboration diagram for ACE_Asynch_Write_File:

Collaboration graph
[legend]
List of all members.

Public Methods

 ACE_Asynch_Write_File (void)
 A do nothing constructor. More...

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

int open (ACE_Handler &handler, ACE_HANDLE handle=ACE_INVALID_HANDLE, const void *completion_key=0, ACE_Proactor *proactor=0)
int write (ACE_Message_Block &message_block, size_t bytes_to_write, u_long offset=0, u_long offset_high=0, const void *act=0, int priority=0, int signal_number=ACE_SIGRTMIN)
int writev (ACE_Message_Block &message_block, size_t bytes_to_write, u_long offset=0, u_long offset_high=0, const void *act=0, int priority=0, int signal_number=ACE_SIGRTMIN)
ACE_Asynch_Write_File_Implimplementation (void) const
 Return the underlying implementation class. More...


Protected Methods

void implementation (ACE_Asynch_Write_File_Impl *implementation)
 Set the implementation. More...


Protected Attributes

ACE_Asynch_Write_File_Implimplementation_
 Implementation object. More...


Detailed Description

This class is a factory for starting off asynchronous writes on a file. This class forwards all methods to its implementation class.

Once <open> is called, multiple asynchronous <write>s can be started using this class. A ACE_Asynch_Write_File::Result will be passed back to the <handler> when the asynchronous writes completes through the <ACE_Handler::handle_write_file> callback. This class differs slightly from ACE_Asynch_Write_Stream as it allows the user to specify an offset for the write.

Definition at line 645 of file Asynch_IO.h.


Constructor & Destructor Documentation

ACE_Asynch_Write_File::ACE_Asynch_Write_File void   
 

A do nothing constructor.

Definition at line 514 of file Asynch_IO.cpp.

References ACE_Asynch_Read_File::implementation_.

00515   : implementation_ (0)
00516 {
00517 }

ACE_Asynch_Write_File::~ACE_Asynch_Write_File void    [virtual]
 

Destructor.

Definition at line 519 of file Asynch_IO.cpp.

00520 {
00521 }


Member Function Documentation

void ACE_Asynch_Write_File::implementation ACE_Asynch_Write_File_Impl   implementation [protected]
 

Set the implementation.

Definition at line 596 of file Asynch_IO.cpp.

References ACE_Asynch_Write_Stream::implementation, and implementation_.

00597 {
00598   this->implementation_ = implementation;
00599   
00600   // Init the base class' implementation also.
00601   ACE_Asynch_Write_Stream::implementation (implementation);
00602 }

ACE_Asynch_Write_File_Impl * ACE_Asynch_Write_File::implementation void    const
 

Return the underlying implementation class.

Reimplemented from ACE_Asynch_Write_Stream.

Definition at line 590 of file Asynch_IO.cpp.

References implementation_.

Referenced by open, write, and writev.

00591 {
00592   return this->implementation_;
00593 }

int ACE_Asynch_Write_File::open ACE_Handler   handler,
ACE_HANDLE    handle = ACE_INVALID_HANDLE,
const void *    completion_key = 0,
ACE_Proactor   proactor = 0
 

Initializes the factory with information which will be used with each asynchronous call. If (<handle> == ACE_INVALID_HANDLE), <ACE_Handler::handle> will be called on the <handler> to get the correct handle.

Reimplemented from ACE_Asynch_Write_Stream.

Definition at line 524 of file Asynch_IO.cpp.

References ACE_Proactor::create_asynch_write_file, ACE_Asynch_Operation::get_proactor, implementation, implementation_, and ACE_Asynch_Operation::open.

00528 {
00529   // Get a proactor for/from the user.
00530   proactor = this->get_proactor (proactor, handler);
00531 
00532   // Delete the old implementation.
00533   delete this->implementation_;
00534   this->implementation_ = 0;
00535 
00536   // Now let us get the implementation initialized.
00537   ACE_Asynch_Write_File_Impl *implementation = proactor->create_asynch_write_file ();
00538   if (implementation == 0)
00539     return -1;
00540   
00541   // Set the implementation class
00542   this->implementation (implementation);
00543   
00544   // Call the <open> method of the base class.
00545   return ACE_Asynch_Operation::open (handler,
00546                                      handle,
00547                                      completion_key,
00548                                      proactor);
00549 }

int ACE_Asynch_Write_File::write ACE_Message_Block   message_block,
size_t    bytes_to_write,
u_long    offset = 0,
u_long    offset_high = 0,
const void *    act = 0,
int    priority = 0,
int    signal_number = ACE_SIGRTMIN
 

This starts off an asynchronous write. Upto <bytes_to_write> will be written from the <message_block>, starting at the block's <rd_ptr>. The write will go to the file, starting <offset> bytes from the beginning of the file. Priority of the operation is specified by <priority>. On POSIX4-Unix, this is supported. Works like <nice> in Unix. Negative values are not allowed. 0 means priority of the operation same as the process priority. 1 means priority of the operation is one less than process. And so forth. On Win32, this is a no-op. <signal_number> is the POSIX4 real-time signal number to be used for the operation. <signal_number> ranges from ACE_SIGRTMIN to ACE_SIGRTMAX. This argument is a no-op on non-POSIX4 systems.

Definition at line 552 of file Asynch_IO.cpp.

References implementation, and ACE_Asynch_Write_File_Impl::write.

00559 {
00560   return this->implementation ()->write (message_block,
00561                                          bytes_to_write,
00562                                          offset,
00563                                          offset_high,
00564                                          act,
00565                                          priority,
00566                                          signal_number);
00567 }

int ACE_Asynch_Write_File::writev ACE_Message_Block   message_block,
size_t    bytes_to_write,
u_long    offset = 0,
u_long    offset_high = 0,
const void *    act = 0,
int    priority = 0,
int    signal_number = ACE_SIGRTMIN
 

Same as above but with gather support, through chaining of composite message blocks using the continuation field. NOTE: In win32 Each data block payload must be at least the size of a system memory page and must be aligned on a system memory page size boundary

Definition at line 571 of file Asynch_IO.cpp.

References implementation, and ACE_Asynch_Write_File_Impl::writev.

00578 {
00579   return this->implementation ()->writev (message_block,
00580                                           bytes_to_write,
00581                                           offset,
00582                                           offset_high,
00583                                           act,
00584                                           priority,
00585                                           signal_number);
00586 }


Member Data Documentation

ACE_Asynch_Write_File_Impl* ACE_Asynch_Write_File::implementation_ [protected]
 

Implementation object.

Reimplemented from ACE_Asynch_Write_Stream.

Definition at line 712 of file Asynch_IO.h.

Referenced by ACE_Asynch_Accept::ACE_Asynch_Accept, implementation, and open.


The documentation for this class was generated from the following files:
Generated on Mon Jun 16 12:45:41 2003 for ACE by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002