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

ACE_Asynch_Write_Dgram Class Reference

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

#include <Asynch_IO.h>

Inheritance diagram for ACE_Asynch_Write_Dgram:

Inheritance graph
[legend]
Collaboration diagram for ACE_Asynch_Write_Dgram:

Collaboration graph
[legend]
List of all members.

Public Methods

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

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

int open (ACE_Handler &handler, ACE_HANDLE handle=ACE_INVALID_HANDLE, const void *completion_key=0, ACE_Proactor *proactor=0)
ssize_t send (ACE_Message_Block *message_block, size_t &number_of_bytes_sent, int flags, const ACE_Addr &remote_addr, const void *act=0, int priority=0, int signal_number=ACE_SIGRTMIN)
ACE_Asynch_Write_Dgram_Implimplementation (void) const
 Return the underlying implementation class. More...


Protected Methods

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


Protected Attributes

ACE_Asynch_Write_Dgram_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 UDP socket. 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_Dgram::Result will be passed back to the <handler> when the asynchronous write completes through the <ACE_Handler::handle_write_dgram> callback.

Definition at line 1347 of file Asynch_IO.h.


Constructor & Destructor Documentation

ACE_Asynch_Write_Dgram::ACE_Asynch_Write_Dgram void   
 

A do nothing constructor.

Definition at line 1341 of file Asynch_IO.cpp.

References ACE_Asynch_Read_Dgram::implementation_.

01342   : implementation_ (0)
01343 {
01344 }

ACE_Asynch_Write_Dgram::~ACE_Asynch_Write_Dgram void    [virtual]
 

Destructor.

Definition at line 1346 of file Asynch_IO.cpp.

01347 {
01348 }


Member Function Documentation

void ACE_Asynch_Write_Dgram::implementation ACE_Asynch_Write_Dgram_Impl   implementation [protected]
 

Set the implementation class.

Definition at line 1403 of file Asynch_IO.cpp.

References ACE_Asynch_Operation::implementation, and implementation_.

01404 {
01405   this->implementation_ = implementation;
01406 
01407   // Init the base class' implementation also.
01408   ACE_Asynch_Operation::implementation (this->implementation_);
01409 }

ACE_Asynch_Write_Dgram_Impl * ACE_Asynch_Write_Dgram::implementation void    const
 

Return the underlying implementation class.

Reimplemented from ACE_Asynch_Operation.

Definition at line 1397 of file Asynch_IO.cpp.

References implementation_.

Referenced by open, ACE_Asynch_Write_Dgram::Result::Result, and send.

01398 {
01399   return this->implementation_;
01400 }

int ACE_Asynch_Write_Dgram::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.

Definition at line 1351 of file Asynch_IO.cpp.

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

01355 {
01356   // Get a proactor for/from the user.
01357   proactor = this->get_proactor (proactor, handler);
01358 
01359   // Delete the old implementation.
01360   delete this->implementation_;
01361   this->implementation_ = 0;
01362 
01363   // Now let us get the implementation initialized.
01364   ACE_Asynch_Write_Dgram_Impl *implementation = proactor->create_asynch_write_dgram ();
01365   if (implementation == 0)
01366     return -1;
01367   
01368   // Set the implementation class
01369   this->implementation (implementation);
01370   
01371   // Call the <open> method of the base class.
01372   return ACE_Asynch_Operation::open (handler,
01373                                      handle,
01374                                      completion_key,
01375                                      proactor);
01376 }

ssize_t ACE_Asynch_Write_Dgram::send ACE_Message_Block   message_block,
size_t &    number_of_bytes_sent,
int    flags,
const ACE_Addr   remote_addr,
const void *    act = 0,
int    priority = 0,
int    signal_number = ACE_SIGRTMIN
 

This starts off an asynchronous send. Upto <message_block->total_length()> will be sent. <message_block>'s <rd_ptr> will be updated to reflect the sent bytes if the send operation is successfully completed. Return code of 1 means immediate success and <number_of_bytes_sent> is updated to number of bytes sent. The <ACE_Handler::handle_write_dgram> method will still be called. Return code of 0 means the IO will complete proactively. Return code of -1 means there was an error, use errno to get the error code.

Scatter/gather is supported on WIN32 by using the <message_block->cont()> method. Up to ACE_IOV_MAX <message_block>'s are supported. Upto <message_block->length()> bytes will be sent from each <message block> for a total of <message_block->total_length()> bytes. All <message_block>'s <rd_ptr>'s will be updated to reflect the bytes sent from each <message_block>.

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 1379 of file Asynch_IO.cpp.

References implementation, and ACE_Asynch_Write_Dgram_Impl::send.

01386 {
01387   return this->implementation ()->send (message_block,
01388                                         number_of_bytes_sent,
01389                                         flags,
01390                                         remote_addr,
01391                                         act,
01392                                         priority,
01393                                         signal_number);
01394 }


Member Data Documentation

ACE_Asynch_Write_Dgram_Impl* ACE_Asynch_Write_Dgram::implementation_ [protected]
 

Implementation class that all methods will be forwarded to.

Reimplemented from ACE_Asynch_Operation.

Definition at line 1410 of file Asynch_IO.h.

Referenced by implementation, open, and ACE_Asynch_Write_Dgram::Result::Result.


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