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
Collaboration diagram for ACE_Asynch_Write_Dgram:

Collaboration graph
List of all members.

Public Member Functions

 ACE_Asynch_Write_Dgram (void)
 A do nothing constructor.

virtual ~ACE_Asynch_Write_Dgram (void)

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)
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 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 1391 of file Asynch_IO.h.

Constructor & Destructor Documentation

ACE_Asynch_Write_Dgram::ACE_Asynch_Write_Dgram void   ) 

A do nothing constructor.

Definition at line 1235 of file Asynch_IO.cpp.

01236   : implementation_ (0)
01237 {
01238 }

ACE_Asynch_Write_Dgram::~ACE_Asynch_Write_Dgram void   )  [virtual]


Definition at line 1240 of file Asynch_IO.cpp.

01241 {
01242   // Delete the implementation.
01243   delete this->implementation_;
01244   this->implementation_ = 0;
01245 }

Member Function Documentation

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

Return the underlying implementation class.

Implements ACE_Asynch_Operation.

Definition at line 1286 of file Asynch_IO.cpp.

01287 {
01288   return this->implementation_;
01289 }

int ACE_Asynch_Write_Dgram::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. 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 1248 of file Asynch_IO.cpp.

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

01252 {
01253   // Get a proactor for/from the user.
01254   proactor = this->get_proactor (proactor, handler);
01256   // Now let us get the implementation initialized.
01257   if ((this->implementation_ = proactor->create_asynch_write_dgram ()) == 0)
01258     return -1;
01260   // Call the <open> method of the base class.
01261   return ACE_Asynch_Operation::open (handler,
01262                                      handle,
01263                                      completion_key,
01264                                      proactor);
01265 }

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

References ACE_Asynch_Write_Dgram_Impl::send().

01275 {
01276   return this->implementation_->send (message_block,
01277                                       number_of_bytes_sent,
01278                                       flags,
01279                                       remote_addr,
01280                                       act,
01281                                       priority,
01282                                       signal_number);
01283 }

Member Data Documentation

ACE_Asynch_Write_Dgram_Impl* ACE_Asynch_Write_Dgram::implementation_ [protected]

Implementation class that all methods will be forwarded to.

Definition at line 1452 of file Asynch_IO.h.

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