ACE_Asynch_Read_Stream Class Reference

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

#include <Asynch_IO.h>

Inheritance diagram for ACE_Asynch_Read_Stream:

Inheritance graph
Collaboration diagram for ACE_Asynch_Read_Stream:

Collaboration graph
List of all members.

Public Member Functions

 ACE_Asynch_Read_Stream (void)
 A do nothing constructor.

virtual ~ACE_Asynch_Read_Stream (void)

int open (ACE_Handler &handler, ACE_HANDLE handle=ACE_INVALID_HANDLE, const void *completion_key=0, ACE_Proactor *proactor=0)
int read (ACE_Message_Block &message_block, size_t num_bytes_to_read, const void *act=0, int priority=0, int signal_number=ACE_SIGRTMIN)
virtual ACE_Asynch_Operation_Implimplementation (void) const
 Return the underlying implementation class.

Protected Attributes

 Implementation class that all methods will be forwarded to.

Detailed Description

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

Once {open} is called, multiple asynchronous {read}s can started using this class. An ACE_Asynch_Read_Stream::Result will be passed back to the {handler} when the asynchronous reads completes through the {ACE_Handler::handle_read_stream} callback.

Definition at line 292 of file Asynch_IO.h.

Constructor & Destructor Documentation

ACE_Asynch_Read_Stream::ACE_Asynch_Read_Stream void   ) 

A do nothing constructor.

Definition at line 144 of file Asynch_IO.cpp.

00145   : implementation_ (0)
00146 {
00147 }

ACE_Asynch_Read_Stream::~ACE_Asynch_Read_Stream void   )  [virtual]


Definition at line 149 of file Asynch_IO.cpp.

00150 {
00151   // Delete the implementation.
00152   delete this->implementation_;
00153   this->implementation_ = 0;
00154 }

Member Function Documentation

ACE_Asynch_Operation_Impl * ACE_Asynch_Read_Stream::implementation void   )  const [virtual]

Return the underlying implementation class.

Implements ACE_Asynch_Operation.

Reimplemented in ACE_Asynch_Read_File.

Definition at line 207 of file Asynch_IO.cpp.

00208 {
00209   return this->implementation_;
00210 }

int ACE_Asynch_Read_Stream::open ACE_Handler handler,
const void *  completion_key = 0,
ACE_Proactor proactor = 0

Initializes the factory with information which will be used with each asynchronous call.

  • handler The ACE_Handler that will be called to handle completions for operations initiated using this factory.
  • handle The handle that future read operations will use. If handle == ACE_INVALID_HANDLE, ACE_Handler::handle() will be called on @ handler to get the correct handle.
Return values:
0 for success.
-1 for failure; consult errno for further information.

Reimplemented from ACE_Asynch_Operation.

Reimplemented in ACE_Asynch_Read_File.

Definition at line 157 of file Asynch_IO.cpp.

References ACE_Proactor::create_asynch_read_stream(), ACE_Asynch_Operation::get_proactor(), and ACE_Asynch_Operation::open().

00161 {
00162   // Get a proactor for/from the user.
00163   proactor = this->get_proactor (proactor, handler);
00165   // Now let us get the implementation initialized.
00166   if ((this->implementation_ = proactor->create_asynch_read_stream ()) == 0)
00167     return -1;
00169   // Call the <open> method of the base class.
00170   return ACE_Asynch_Operation::open (handler,
00171                                      handle,
00172                                      completion_key,
00173                                      proactor);
00174 }

int ACE_Asynch_Read_Stream::read ACE_Message_Block message_block,
size_t  num_bytes_to_read,
const void *  act = 0,
int  priority = 0,
int  signal_number = ACE_SIGRTMIN

This starts off an asynchronous read. Upto {bytes_to_read} will be read and stored in the {message_block}. {message_block}'s {wr_ptr} will be updated to reflect the added bytes if the read operation is successful completed. 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, {priority} 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 177 of file Asynch_IO.cpp.

References ACE_Asynch_Read_Stream_Impl::read().

00182 {
00183   return this->implementation_->read (message_block,
00184                                       bytes_to_read,
00185                                       act,
00186                                       priority,
00187                                       signal_number);
00188 }

Member Data Documentation

ACE_Asynch_Read_Stream_Impl* ACE_Asynch_Read_Stream::implementation_ [protected]

Implementation class that all methods will be forwarded to.

Reimplemented in ACE_Asynch_Read_File.

Definition at line 359 of file Asynch_IO.h.

The documentation for this class was generated from the following files:
Generated on Thu Nov 9 11:19:41 2006 for ACE by doxygen 1.3.6