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

ACE_WIN32_Asynch_Accept_Result Class Reference

This class implements ACE_Asynch_Accept::Result for WIN32 platform. More...

#include <WIN32_Asynch_IO.h>

Inheritance diagram for ACE_WIN32_Asynch_Accept_Result:

Inheritance graph
[legend]
Collaboration diagram for ACE_WIN32_Asynch_Accept_Result:

Collaboration graph
[legend]
List of all members.

Public Methods

size_t bytes_to_read (void) const
 The number of bytes which were requested at the start of the asynchronous accept. More...

ACE_Message_Block & message_block (void) const
 Message block which contains the read data. More...

ACE_HANDLE listen_handle (void) const
 I/O handle used for accepting new connections. More...

ACE_HANDLE accept_handle (void) const
 I/O handle for the new connection. More...

size_t bytes_transferred (void) const
 Number of bytes transferred by the operation. More...

const void * act (void) const
 ACT associated with the operation. More...

int success (void) const
 Did the operation succeed? More...

const void * completion_key (void) const
u_long error (void) const
 Error value if the operation fail. More...

ACE_HANDLE event (void) const
 Event associated with the OVERLAPPED structure. More...

u_long offset (void) const
 This really make sense only when doing file I/O. More...

u_long offset_high (void) const
 Offset_high associated with the OVERLAPPED structure. More...

int priority (void) const
 The priority of the asynchronous operation. Currently, this is not supported on Win32. More...

int signal_number (void) const
 No-op. Returns 0. More...

int post_completion (ACE_Proactor_Impl *proactor)
 Post <this> to the Proactor's completion port. More...


Protected Methods

 ACE_WIN32_Asynch_Accept_Result (ACE_Handler &handler, ACE_HANDLE listen_handle, ACE_HANDLE accept_handle, ACE_Message_Block &message_block, size_t bytes_to_read, const void *act, ACE_HANDLE event, int priority, int signal_number=0)
 Constructor is protected since creation is limited to ACE_Asynch_Accept factory. More...

virtual void complete (size_t bytes_transferred, int success, const void *completion_key, u_long error)
 ACE_Proactor will call this method when the accept completes. More...

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


Protected Attributes

size_t bytes_to_read_
 Bytes requested when the asynchronous read was initiated. More...

ACE_Message_Block & message_block_
 Message block for reading the data into. More...

ACE_HANDLE listen_handle_
 I/O handle used for accepting new connections. More...

ACE_HANDLE accept_handle_
 I/O handle for the new connection. More...


Friends

class ACE_WIN32_Asynch_Accept
 Factory will have special permission. More...

class ACE_WIN32_Proactor
 Proactor class has special permission. More...

Detailed Description

This class implements ACE_Asynch_Accept::Result for WIN32 platform.

This class has all the information necessary for the <handler> to uniquiely identify the completion of the asynchronous accept.

Definition at line 972 of file WIN32_Asynch_IO.h.

Constructor & Destructor Documentation

ACE_WIN32_Asynch_Accept_Result::ACE_WIN32_Asynch_Accept_Result (  ACE_Handler &    handler,
ACE_HANDLE    listen_handle,
ACE_HANDLE    accept_handle,
ACE_Message_Block &    message_block,
size_t    bytes_to_read,
const void *    act,
ACE_HANDLE    event,
int    priority,
int    signal_number = 0
)  [protected]
 

Constructor is protected since creation is limited to ACE_Asynch_Accept factory.

Definition at line 1856 of file WIN32_Asynch_IO.cpp. 

01865   : ACE_Asynch_Result_Impl (),
01866     ACE_Asynch_Accept_Result_Impl (),
01867     ACE_WIN32_Asynch_Result (handler, act, event, 0, 0, priority, signal_number),
01868     bytes_to_read_ (bytes_to_read),
01869     message_block_ (message_block),
01870     listen_handle_ (listen_handle),
01871     accept_handle_ (accept_handle)
01872 {
01873 }

ACE_WIN32_Asynch_Accept_Result::~ACE_WIN32_Asynch_Accept_Result (  void    )  [protected, virtual]
 

Destructor.

Definition at line 1897 of file WIN32_Asynch_IO.cpp. 

01898 {
01899 }

Member Function Documentation

ACE_HANDLE ACE_WIN32_Asynch_Accept_Result::accept_handle (  void    )  const [virtual]
 

I/O handle for the new connection.

Implements ACE_Asynch_Accept_Result_Impl.

Definition at line 1851 of file WIN32_Asynch_IO.cpp.

References accept_handle_.

Referenced by ACE_WIN32_Asynch_Accept::accept. 

01852 {
01853   return this->accept_handle_;
01854 }

const void * ACE_WIN32_Asynch_Accept_Result::act (  void    )  const [virtual]
 

ACT associated with the operation.

Reimplemented from ACE_WIN32_Asynch_Result.

Definition at line 1911 of file WIN32_Asynch_IO.cpp.

References ACE_WIN32_Asynch_Result::act. 

01912 {
01913   return ACE_WIN32_Asynch_Result::act ();
01914 }

size_t ACE_WIN32_Asynch_Accept_Result::bytes_to_read (  void    )  const [virtual]
 

The number of bytes which were requested at the start of the asynchronous accept.

Implements ACE_Asynch_Accept_Result_Impl.

Definition at line 1833 of file WIN32_Asynch_IO.cpp.

References bytes_to_read_. 

01834 {
01835   return this->bytes_to_read_;
01836 }

size_t ACE_WIN32_Asynch_Accept_Result::bytes_transferred (  void    )  const [virtual]
 

Number of bytes transferred by the operation.

Reimplemented from ACE_WIN32_Asynch_Result.

Definition at line 1905 of file WIN32_Asynch_IO.cpp.

References ACE_WIN32_Asynch_Result::bytes_transferred.

Referenced by complete. 

01906 {
01907   return ACE_WIN32_Asynch_Result::bytes_transferred ();
01908 }

void ACE_WIN32_Asynch_Accept_Result::complete (  size_t    bytes_transferred,
int    success,
const void *    completion_key,
u_long    error
)  [protected, virtual]
 

ACE_Proactor will call this method when the accept completes.

Implements ACE_Asynch_Result_Impl.

Definition at line 1876 of file WIN32_Asynch_IO.cpp.

References bytes_transferred, ACE_WIN32_Asynch_Result::bytes_transferred_, completion_key, ACE_WIN32_Asynch_Result::completion_key_, error, ACE_WIN32_Asynch_Result::error_, ACE_Handler::handle_accept, ACE_WIN32_Asynch_Result::handler_, message_block_, success, ACE_WIN32_Asynch_Result::success_, and ACE_Message_Block::wr_ptr. 

01880 {
01881   // Copy the data which was returned by GetQueuedCompletionStatus
01882   this->bytes_transferred_ = bytes_transferred;
01883   this->success_ = success;
01884   this->completion_key_ = completion_key;
01885   this->error_ = error;
01886 
01887   // Appropriately move the pointers in the message block.
01888   this->message_block_.wr_ptr (bytes_transferred);
01889 
01890   // Create the interface result class.
01891   ACE_Asynch_Accept::Result result (this);
01892 
01893   // Call the application handler.
01894   this->handler_.handle_accept (result);
01895 }

const void * ACE_WIN32_Asynch_Accept_Result::completion_key (  void    )  const [virtual]
 

This returns the ACT associated with the handle when it was registered with the I/O completion port. This ACT is not the same as the ACT associated with the asynchronous operation.

Reimplemented from ACE_WIN32_Asynch_Result.

Definition at line 1923 of file WIN32_Asynch_IO.cpp.

References ACE_WIN32_Asynch_Result::completion_key.

Referenced by complete. 

01924 {
01925   return ACE_WIN32_Asynch_Result::completion_key ();
01926 }

u_long ACE_WIN32_Asynch_Accept_Result::error (  void    )  const [virtual]
 

Error value if the operation fail.

Reimplemented from ACE_WIN32_Asynch_Result.

Definition at line 1929 of file WIN32_Asynch_IO.cpp.

References ACE_WIN32_Asynch_Result::error.

Referenced by complete. 

01930 {
01931   return ACE_WIN32_Asynch_Result::error ();
01932 }

ACE_HANDLE ACE_WIN32_Asynch_Accept_Result::event (  void    )  const [virtual]
 

Event associated with the OVERLAPPED structure.

Reimplemented from ACE_WIN32_Asynch_Result.

Definition at line 1935 of file WIN32_Asynch_IO.cpp.

References ACE_WIN32_Asynch_Result::event. 

01936 {
01937   return ACE_WIN32_Asynch_Result::event ();
01938 }

ACE_HANDLE ACE_WIN32_Asynch_Accept_Result::listen_handle (  void    )  const [virtual]
 

I/O handle used for accepting new connections.

Implements ACE_Asynch_Accept_Result_Impl.

Definition at line 1845 of file WIN32_Asynch_IO.cpp.

References listen_handle_.

Referenced by ACE_WIN32_Asynch_Accept::accept. 

01846 {
01847   return this->listen_handle_;
01848 }

ACE_Message_Block & ACE_WIN32_Asynch_Accept_Result::message_block (  void    )  const [virtual]
 

Message block which contains the read data.

Implements ACE_Asynch_Accept_Result_Impl.

Definition at line 1839 of file WIN32_Asynch_IO.cpp.

References message_block_.

Referenced by ACE_WIN32_Asynch_Accept::accept. 

01840 {
01841   return this->message_block_;
01842 }

u_long ACE_WIN32_Asynch_Accept_Result::offset (  void    )  const [virtual]
 

This really make sense only when doing file I/O.

Reimplemented from ACE_WIN32_Asynch_Result.

Definition at line 1941 of file WIN32_Asynch_IO.cpp.

References ACE_WIN32_Asynch_Result::offset. 

01942 {
01943   return ACE_WIN32_Asynch_Result::offset ();
01944 }

u_long ACE_WIN32_Asynch_Accept_Result::offset_high (  void    )  const [virtual]
 

Offset_high associated with the OVERLAPPED structure.

Reimplemented from ACE_WIN32_Asynch_Result.

Definition at line 1947 of file WIN32_Asynch_IO.cpp.

References ACE_WIN32_Asynch_Result::offset_high. 

01948 {
01949   return ACE_WIN32_Asynch_Result::offset_high ();
01950 }

int ACE_WIN32_Asynch_Accept_Result::post_completion (  ACE_Proactor_Impl *    proactor )  [virtual]
 

Post <this> to the Proactor's completion port.

Reimplemented from ACE_WIN32_Asynch_Result.

Definition at line 1965 of file WIN32_Asynch_IO.cpp.

References ACE_WIN32_Asynch_Result::post_completion. 

01966 {
01967   return ACE_WIN32_Asynch_Result::post_completion (proactor);
01968 }

int ACE_WIN32_Asynch_Accept_Result::priority (  void    )  const [virtual]
 

The priority of the asynchronous operation. Currently, this is not supported on Win32.

Reimplemented from ACE_WIN32_Asynch_Result.

Definition at line 1953 of file WIN32_Asynch_IO.cpp.

References ACE_WIN32_Asynch_Result::priority. 

01954 {
01955   return ACE_WIN32_Asynch_Result::priority ();
01956 }

int ACE_WIN32_Asynch_Accept_Result::signal_number (  void    )  const [virtual]
 

No-op. Returns 0.

Reimplemented from ACE_WIN32_Asynch_Result.

Definition at line 1959 of file WIN32_Asynch_IO.cpp.

References ACE_WIN32_Asynch_Result::signal_number. 

01960 {
01961   return ACE_WIN32_Asynch_Result::signal_number ();
01962 }

int ACE_WIN32_Asynch_Accept_Result::success (  void    )  const [virtual]
 

Did the operation succeed?

Reimplemented from ACE_WIN32_Asynch_Result.

Definition at line 1917 of file WIN32_Asynch_IO.cpp.

References ACE_WIN32_Asynch_Result::success.

Referenced by complete. 

01918 {
01919   return ACE_WIN32_Asynch_Result::success ();
01920 }

Friends And Related Function Documentation

friend class ACE_WIN32_Asynch_Accept [friend]
 

Factory will have special permission.

Reimplemented from ACE_WIN32_Asynch_Result.

Definition at line 976 of file WIN32_Asynch_IO.h.

friend class ACE_WIN32_Proactor [friend]
 

Proactor class has special permission.

Reimplemented from ACE_WIN32_Asynch_Result.

Definition at line 979 of file WIN32_Asynch_IO.h.

Member Data Documentation

ACE_HANDLE ACE_WIN32_Asynch_Accept_Result::accept_handle_ [protected]
 

I/O handle for the new connection.

Definition at line 1068 of file WIN32_Asynch_IO.h.

Referenced by accept_handle.

size_t ACE_WIN32_Asynch_Accept_Result::bytes_to_read_ [protected]
 

Bytes requested when the asynchronous read was initiated.

Definition at line 1059 of file WIN32_Asynch_IO.h.

Referenced by bytes_to_read.

ACE_HANDLE ACE_WIN32_Asynch_Accept_Result::listen_handle_ [protected]
 

I/O handle used for accepting new connections.

Definition at line 1065 of file WIN32_Asynch_IO.h.

Referenced by listen_handle.

ACE_Message_Block& ACE_WIN32_Asynch_Accept_Result::message_block_ [protected]
 

Message block for reading the data into.

Definition at line 1062 of file WIN32_Asynch_IO.h.

Referenced by complete, and message_block.

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