# 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:

[legend]
Collaboration diagram for ACE_WIN32_Asynch_Accept_Result:

[legend]
List of all members.

## Public Member Functions

size_t | bytes_to_read (void) const
ACE_Message_Block & | message_block (void) const
| Message block which contains the read data.
ACE_HANDLE | listen_handle (void) const
| I/O handle used for accepting new connections.
ACE_HANDLE | accept_handle (void) const
| I/O handle for the new connection.
size_t | bytes_transferred (void) const
| Number of bytes transferred by the operation.
const void * | act (void) const
| ACT associated with the operation.
int | success (void) const
| Did the operation succeed?
const void * | completion_key (void) const
u_long | error (void) const
| Error value if the operation fail.
ACE_HANDLE | event (void) const
| Event associated with the OVERLAPPED structure.
u_long | offset (void) const
| This really make sense only when doing file I/O.
u_long | offset_high (void) const
| Offset_high associated with the OVERLAPPED structure.
int | priority (void) const
int | signal_number (void) const
| No-op. Returns 0.
int | post_completion (ACE_Proactor_Impl *proactor)
| Post <this> to the Proactor's completion port.

## Protected Member Functions

| ACE_WIN32_Asynch_Accept_Result (const ACE_Handler::Proxy_Ptr &handler_proxy, 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)
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.
virtual | ~ACE_WIN32_Asynch_Accept_Result (void)
| Destructor.

## Protected Attributes

size_t | bytes_to_read_
| Bytes requested when the asynchronous read was initiated.
ACE_Message_Block & | message_block_
| Message block for reading the data into.
ACE_HANDLE | listen_handle_
| I/O handle used for accepting new connections.
ACE_HANDLE | accept_handle_
| I/O handle for the new connection.

## Friends

class | ACE_WIN32_Asynch_Accept
| Factory will have special permission.
class | ACE_WIN32_Proactor
| Proactor class has special permission.

## 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.

## Constructor & Destructor Documentation

ACE_WIN32_Asynch_Accept_Result::ACE_WIN32_Asynch_Accept_Result | ( | const ACE_Handler::Proxy_Ptr & | handler_proxy,
|  | 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.

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

| Destructor.

## 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.

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

| ACT associated with the operation. Reimplemented from ACE_WIN32_Asynch_Result.

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.

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.

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.

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.

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

| Error value if the operation fail. Reimplemented from ACE_WIN32_Asynch_Result.

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

| Event associated with the OVERLAPPED structure. Reimplemented from ACE_WIN32_Asynch_Result.

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.

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.

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.

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.

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.

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.

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

| No-op. Returns 0. Reimplemented from ACE_WIN32_Asynch_Result.

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

| Did the operation succeed? Reimplemented from ACE_WIN32_Asynch_Result.

## Friends And Related Function Documentation

friend class ACE_WIN32_Asynch_Accept `[friend]`

| Factory will have special permission. Reimplemented from ACE_WIN32_Asynch_Result.

friend class ACE_WIN32_Proactor `[friend]`

| Proactor class has special permission. Reimplemented from ACE_WIN32_Asynch_Result.

## Member Data Documentation

ACE_HANDLE ACE_WIN32_Asynch_Accept_Result::accept_handle_ `[protected]`

| I/O handle for the new connection.

size_t ACE_WIN32_Asynch_Accept_Result::bytes_to_read_ `[protected]`

| Bytes requested when the asynchronous read was initiated.

ACE_HANDLE ACE_WIN32_Asynch_Accept_Result::listen_handle_ `[protected]`

| I/O handle used for accepting new connections.

ACE_Message_Block& ACE_WIN32_Asynch_Accept_Result::message_block_ `[protected]`

| Message block for reading the data into.

The documentation for this class was generated from the following files:

- WIN32_Asynch_IO.h
- WIN32_Asynch_IO.cpp