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

ACE_POSIX_Asynch_Read_Dgram_Result Class Reference

This is class provides concrete implementation for ACE_Asynch_Read_Dgram::Result class. More...

#include <POSIX_Asynch_IO.h>

Inheritance diagram for ACE_POSIX_Asynch_Read_Dgram_Result

Inheritance graph
[legend]
Collaboration diagram for ACE_POSIX_Asynch_Read_Dgram_Result:

Collaboration graph
[legend]
List of all members.

Public Methods

u_long bytes_to_read (void) const
 The number of bytes which were requested at the start of the asynchronous read.

ACE_Message_Blockmessage_block (void) const
 Message block which contains the read data.

int remote_address (ACE_Addr& addr) const
 The address of where the packet came from.

sockaddr* saddr () const
int flags (void) const
 The flags used in the read.

ACE_HANDLE handle (void) const
 I/O handle used for reading.

u_long 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
 The priority of the asynchronous operation. Currently, this is not supported on Win32.

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 Methods

 ACE_POSIX_Asynch_Read_Dgram_Result (ACE_Handler &handler, ACE_HANDLE handle, ACE_Message_Block *message_block, u_long bytes_to_read, int flags, int protocol_family, const void* act, ACE_HANDLE event, int priority, int signal_number = 0)
virtual void complete (u_long bytes_transferred, int success, const void *completion_key, u_long error)
 Proactor will call this method when the read completes.

virtual ~ACE_POSIX_Asynch_Read_Dgram_Result (void)
 Destructor.


Protected Attributes

u_long bytes_to_read_
 Bytes requested when the asynchronous read was initiated.

ACE_Message_Blockmessage_block_
 Message block for reading the data into.

ACE_Addrremote_address_
 The address of where the packet came from.

int addr_len_
int flags_
 The flags used in the read.

ACE_HANDLE handle_
 I/O handle used for reading.


Friends

class  ACE_POSIX_AIOCB_Asynch_Read_Dgram
class  ACE_POSIX_Proactor

Detailed Description

This is class provides concrete implementation for ACE_Asynch_Read_Dgram::Result class.


Constructor & Destructor Documentation

ACE_POSIX_Asynch_Read_Dgram_Result::ACE_POSIX_Asynch_Read_Dgram_Result ( ACE_Handler & handler,
ACE_HANDLE handle,
ACE_Message_Block * message_block,
u_long bytes_to_read,
int flags,
int protocol_family,
const void * act,
ACE_HANDLE event,
int priority,
int signal_number = 0 ) [protected]
 

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

Destructor.


Member Function Documentation

const void * ACE_POSIX_Asynch_Read_Dgram_Result::act ( void ) const
 

ACT associated with the operation.

Reimplemented from ACE_POSIX_Asynch_Result.

u_long ACE_POSIX_Asynch_Read_Dgram_Result::bytes_to_read ( void ) const
 

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

u_long ACE_POSIX_Asynch_Read_Dgram_Result::bytes_transferred ( void ) const
 

Number of bytes transferred by the operation.

Reimplemented from ACE_POSIX_Asynch_Result.

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

Proactor will call this method when the read completes.

const void * ACE_POSIX_Asynch_Read_Dgram_Result::completion_key ( void ) const
 

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

u_long ACE_POSIX_Asynch_Read_Dgram_Result::error ( void ) const
 

Error value if the operation fail.

Reimplemented from ACE_POSIX_Asynch_Result.

ACE_HANDLE ACE_POSIX_Asynch_Read_Dgram_Result::event ( void ) const
 

Event associated with the OVERLAPPED structure.

Reimplemented from ACE_POSIX_Asynch_Result.

int ACE_POSIX_Asynch_Read_Dgram_Result::flags ( void ) const
 

The flags used in the read.

ACE_HANDLE ACE_POSIX_Asynch_Read_Dgram_Result::handle ( void ) const
 

I/O handle used for reading.

ACE_Message_Block * ACE_POSIX_Asynch_Read_Dgram_Result::message_block ( void ) const
 

Message block which contains the read data.

u_long ACE_POSIX_Asynch_Read_Dgram_Result::offset ( void ) const
 

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

Reimplemented from ACE_POSIX_Asynch_Result.

u_long ACE_POSIX_Asynch_Read_Dgram_Result::offset_high ( void ) const
 

Offset_high associated with the OVERLAPPED structure.

Reimplemented from ACE_POSIX_Asynch_Result.

int ACE_POSIX_Asynch_Read_Dgram_Result::post_completion ( ACE_Proactor_Impl * proactor )
 

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

Reimplemented from ACE_POSIX_Asynch_Result.

int ACE_POSIX_Asynch_Read_Dgram_Result::priority ( void ) const
 

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

Reimplemented from ACE_POSIX_Asynch_Result.

int ACE_POSIX_Asynch_Read_Dgram_Result::remote_address ( ACE_Addr & addr ) const
 

The address of where the packet came from.

sockaddr * ACE_POSIX_Asynch_Read_Dgram_Result::saddr ( ) const
 

int ACE_POSIX_Asynch_Read_Dgram_Result::signal_number ( void ) const
 

No-op. Returns 0.

Reimplemented from ACE_POSIX_Asynch_Result.

int ACE_POSIX_Asynch_Read_Dgram_Result::success ( void ) const
 

Did the operation succeed?

Reimplemented from ACE_POSIX_Asynch_Result.


Friends And Related Function Documentation

class ACE_POSIX_AIOCB_Asynch_Read_Dgram [friend]
 

Factory classes will have special permissions.

class ACE_POSIX_Proactor [friend]
 

Proactor class has special permission.


Member Data Documentation

int ACE_POSIX_Asynch_Read_Dgram_Result::addr_len_ [protected]
 

u_long ACE_POSIX_Asynch_Read_Dgram_Result::bytes_to_read_ [protected]
 

Bytes requested when the asynchronous read was initiated.

int ACE_POSIX_Asynch_Read_Dgram_Result::flags_ [protected]
 

The flags used in the read.

ACE_HANDLE ACE_POSIX_Asynch_Read_Dgram_Result::handle_ [protected]
 

I/O handle used for reading.

ACE_Message_Block * ACE_POSIX_Asynch_Read_Dgram_Result::message_block_ [protected]
 

Message block for reading the data into.

ACE_Addr * ACE_POSIX_Asynch_Read_Dgram_Result::remote_address_ [protected]
 

The address of where the packet came from.


The documentation for this class was generated from the following files:
Generated at Wed Nov 21 10:32:20 2001 for ACE by doxygen1.2.3 written by Dimitri van Heesch, © 1997-2000