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
[legend]
Collaboration diagram for ACE_Asynch_Read_Stream:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ACE_Asynch_Read_Stream (void)
 A do nothing constructor.
virtual ~ACE_Asynch_Read_Stream (void)
 Destructor.
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

ACE_Asynch_Read_Stream_Implimplementation_
 Implementation class that all methods will be forwarded to.

Classes

class  Result
 This is the class which will be passed back to the <handler> when the asynchronous read completes. This class forwards all the methods to the implementation classes. More...

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.


Constructor & Destructor Documentation

ACE_Asynch_Read_Stream::ACE_Asynch_Read_Stream void   ) 
 

A do nothing constructor.

ACE_Asynch_Read_Stream::~ACE_Asynch_Read_Stream void   )  [virtual]
 

Destructor.


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.

int ACE_Asynch_Read_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_Read_File.

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.


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.


The documentation for this class was generated from the following files:
Generated on Wed Nov 23 15:47:54 2005 for ACE by  doxygen 1.4.5