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

ACE_Asynch_Write_Stream Class Reference

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

#include <Asynch_IO.h>

Inheritance diagram for ACE_Asynch_Write_Stream:

Inheritance graph
[legend]
Collaboration diagram for ACE_Asynch_Write_Stream:

Collaboration graph
[legend]
List of all members.

Public Methods

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

virtual ~ACE_Asynch_Write_Stream (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, const void *act=0, int priority=0, int signal_number=ACE_SIGRTMIN)
int writev (ACE_Message_Block &message_block, size_t bytes_to_write, const void *act=0, int priority=0, int signal_number=ACE_SIGRTMIN)
ACE_Asynch_Write_Stream_Implimplementation (void) const
 Return the underlying implementation class. More...


Protected Methods

void implementation (ACE_Asynch_Write_Stream_Impl *implementation)
 Set the implementation class. More...


Protected Attributes

ACE_Asynch_Write_Stream_Implimplementation_
 Implementation class that all methods will be forwarded to. More...


Detailed Description

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

Once <open> is called, multiple asynchronous <writes>s can started using this class. An ACE_Asynch_Write_Stream::Result will be passed back to the <handler> when the asynchronous write completes through the <ACE_Handler::handle_write_stream> callback.

Definition at line 382 of file Asynch_IO.h.


Constructor & Destructor Documentation

ACE_Asynch_Write_Stream::ACE_Asynch_Write_Stream void   
 

A do nothing constructor.

Definition at line 280 of file Asynch_IO.cpp.

References ACE_Asynch_Read_Stream::implementation_.

00281   : implementation_ (0)
00282 {
00283 }

ACE_Asynch_Write_Stream::~ACE_Asynch_Write_Stream void    [virtual]
 

Destructor.

Definition at line 285 of file Asynch_IO.cpp.

00286 {
00287 }


Member Function Documentation

void ACE_Asynch_Write_Stream::implementation ACE_Asynch_Write_Stream_Impl   implementation [protected]
 

Set the implementation class.

Definition at line 354 of file Asynch_IO.cpp.

References ACE_Asynch_Operation::implementation, and implementation_.

00355 {
00356   this->implementation_ = implementation;
00357 
00358   // Init the base class' implementation also.
00359   ACE_Asynch_Operation::implementation (this->implementation_);
00360 }

ACE_Asynch_Write_Stream_Impl * ACE_Asynch_Write_Stream::implementation void    const
 

Return the underlying implementation class.

Reimplemented from ACE_Asynch_Operation.

Reimplemented in ACE_Asynch_Write_File.

Definition at line 348 of file Asynch_IO.cpp.

References implementation_.

Referenced by ACE_Asynch_Write_File::implementation, open, ACE_Asynch_Write_Stream::Result::Result, and write.

00349 {
00350   return this->implementation_;
00351 }

int ACE_Asynch_Write_Stream::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_Operation.

Reimplemented in ACE_Asynch_Write_File.

Definition at line 290 of file Asynch_IO.cpp.

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

00294 {
00295   // Get a proactor for/from the user.
00296   proactor = this->get_proactor (proactor, handler);
00297 
00298   // Delete the old implementation.
00299   delete this->implementation_;
00300   this->implementation_ = 0;
00301 
00302   // Now let us get the implementation initialized.
00303   ACE_Asynch_Write_Stream_Impl *implementation = proactor->create_asynch_write_stream ();
00304   if (implementation == 0)
00305     return -1;
00306   
00307   // Set the implementation class
00308   this->implementation (implementation);
00309   
00310   // Call the <open> method of the base class.
00311   return ACE_Asynch_Operation::open (handler,
00312                                      handle,
00313                                      completion_key,
00314                                      proactor);
00315 }

int ACE_Asynch_Write_Stream::write ACE_Message_Block   message_block,
size_t    bytes_to_write,
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>. Upon successful completion of the write operation, <message_block>'s <rd_ptr> is updated to reflect the data that was written. 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 argument 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 318 of file Asynch_IO.cpp.

References implementation, and ACE_Asynch_Write_Stream_Impl::write.

00323 {
00324   return this->implementation ()->write (message_block,
00325                                          bytes_to_write,
00326                                          act,
00327                                          priority,
00328                                         signal_number);
00329 }

int ACE_Asynch_Write_Stream::writev ACE_Message_Block   message_block,
size_t    bytes_to_write,
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.


Member Data Documentation

ACE_Asynch_Write_Stream_Impl* ACE_Asynch_Write_Stream::implementation_ [protected]
 

Implementation class that all methods will be forwarded to.

Reimplemented from ACE_Asynch_Operation.

Reimplemented in ACE_Asynch_Write_File.

Definition at line 443 of file Asynch_IO.h.

Referenced by ACE_Asynch_Read_File::ACE_Asynch_Read_File, implementation, open, and ACE_Asynch_Write_Stream::Result::Result.


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