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

ACE_POSIX_Asynch_Transmit_File_Result Class Reference

This is that class which will be passed back to the <handler> when the asynchronous transmit file completes. More...

#include <POSIX_Asynch_IO.h>

Inheritance diagram for ACE_POSIX_Asynch_Transmit_File_Result

Inheritance graph
[legend]
Collaboration diagram for ACE_POSIX_Asynch_Transmit_File_Result:

Collaboration graph
[legend]
List of all members.

Public Methods

ACE_HANDLE socket (void) const
 Socket used for transmitting the file.

ACE_HANDLE file (void) const
 File from which the data is read.

ACE_Asynch_Transmit_File::Header_And_Trailerheader_and_trailer (void) const
 Header and trailer data associated with this transmit file.

u_long bytes_to_write (void) const
 The number of bytes which were requested at the start of the asynchronous transmit file.

u_long bytes_per_send (void) const
 Number of bytes per send requested at the start of the transmit file.

u_long flags (void) const
 Flags which were passed into transmit file.

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
 This returns ACE_INVALID_HANDLE.

u_long offset (void) const
u_long offset_high (void) const
int priority (void) const
 The priority of the asynchronous operation.

int signal_number (void) const
int post_completion (ACE_Proactor_Impl *proactor)
 Post <this> to the Proactor.


Protected Methods

 ACE_POSIX_Asynch_Transmit_File_Result (ACE_Handler &handler, ACE_HANDLE socket, ACE_HANDLE file, ACE_Asynch_Transmit_File::Header_And_Trailer *header_and_trailer, u_long bytes_to_write, u_long offset, u_long offset_high, u_long bytes_per_send, u_long flags, const void *act, ACE_HANDLE event, int priority, int signal_number)
virtual void complete (u_long bytes_transferred, int success, const void *completion_key, u_long error)
 ACE_Proactor will call this method when the write completes.

virtual ~ACE_POSIX_Asynch_Transmit_File_Result (void)
 Destructor.


Protected Attributes

ACE_HANDLE socket_
 Network I/O handle.

ACE_Asynch_Transmit_File::Header_And_Trailerheader_and_trailer_
 Header and trailer data associated with this transmit file.

u_long bytes_per_send_
 Number of bytes per send requested at the start of the transmit file.

u_long flags_
 Flags which were passed into transmit file.


Friends

class  ACE_POSIX_AIOCB_Asynch_Transmit_File
class  ACE_POSIX_Asynch_Transmit_Handler
class  ACE_POSIX_AIOCB_Asynch_Transmit_Handler
class  ACE_POSIX_Proactor

Detailed Description

This is that class which will be passed back to the <handler> when the asynchronous transmit file completes.

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


Constructor & Destructor Documentation

ACE_POSIX_Asynch_Transmit_File_Result::ACE_POSIX_Asynch_Transmit_File_Result ( ACE_Handler & handler,
ACE_HANDLE socket,
ACE_HANDLE file,
ACE_Asynch_Transmit_File::Header_And_Trailer * header_and_trailer,
u_long bytes_to_write,
u_long offset,
u_long offset_high,
u_long bytes_per_send,
u_long flags,
const void * act,
ACE_HANDLE event,
int priority,
int signal_number ) [protected]
 

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

Destructor.


Member Function Documentation

const void * ACE_POSIX_Asynch_Transmit_File_Result::act ( void ) const
 

ACT associated with the operation.

Reimplemented from ACE_POSIX_Asynch_Result.

u_long ACE_POSIX_Asynch_Transmit_File_Result::bytes_per_send ( void ) const
 

Number of bytes per send requested at the start of the transmit file.

u_long ACE_POSIX_Asynch_Transmit_File_Result::bytes_to_write ( void ) const
 

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

u_long ACE_POSIX_Asynch_Transmit_File_Result::bytes_transferred ( void ) const
 

Number of bytes transferred by the operation.

Reimplemented from ACE_POSIX_Asynch_Result.

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

ACE_Proactor will call this method when the write completes.

const void * ACE_POSIX_Asynch_Transmit_File_Result::completion_key ( void ) const
 

This is the ACT associated with the handle on which the Asynch_Operation takes place.

@ This is not implemented for POSIX4 platforms.

Reimplemented from ACE_POSIX_Asynch_Result.

u_long ACE_POSIX_Asynch_Transmit_File_Result::error ( void ) const
 

Error value if the operation fail.

Reimplemented from ACE_POSIX_Asynch_Result.

ACE_HANDLE ACE_POSIX_Asynch_Transmit_File_Result::event ( void ) const
 

This returns ACE_INVALID_HANDLE.

Reimplemented from ACE_POSIX_Asynch_Result.

ACE_HANDLE ACE_POSIX_Asynch_Transmit_File_Result::file ( void ) const
 

File from which the data is read.

u_long ACE_POSIX_Asynch_Transmit_File_Result::flags ( void ) const
 

Flags which were passed into transmit file.

ACE_Asynch_Transmit_File::Header_And_Trailer * ACE_POSIX_Asynch_Transmit_File_Result::header_and_trailer ( void ) const
 

Header and trailer data associated with this transmit file.

u_long ACE_POSIX_Asynch_Transmit_File_Result::offset ( void ) const
 

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

@ On POSIX4-Unix, offset_high should be supported using aiocb64.

Reimplemented from ACE_POSIX_Asynch_Result.

u_long ACE_POSIX_Asynch_Transmit_File_Result::offset_high ( void ) const
 

Reimplemented from ACE_POSIX_Asynch_Result.

int ACE_POSIX_Asynch_Transmit_File_Result::post_completion ( ACE_Proactor_Impl * proactor )
 

Post <this> to the Proactor.

Reimplemented from ACE_POSIX_Asynch_Result.

int ACE_POSIX_Asynch_Transmit_File_Result::priority ( void ) const
 

The priority of the asynchronous operation.

Reimplemented from ACE_POSIX_Asynch_Result.

int ACE_POSIX_Asynch_Transmit_File_Result::signal_number ( void ) const
 

POSIX4 realtime signal number to be used for the operation. <signal_number> ranges from SIGRTMIN to SIGRTMAX. By default, SIGRTMIN is used to issue calls. This is a no-op on non-POSIX4 systems and returns 0.

Reimplemented from ACE_POSIX_Asynch_Result.

ACE_HANDLE ACE_POSIX_Asynch_Transmit_File_Result::socket ( void ) const
 

Socket used for transmitting the file.

int ACE_POSIX_Asynch_Transmit_File_Result::success ( void ) const
 

Did the operation succeed?

Reimplemented from ACE_POSIX_Asynch_Result.


Friends And Related Function Documentation

class ACE_POSIX_AIOCB_Asynch_Transmit_File [friend]
 

Factory classes willl have special permissions.

class ACE_POSIX_AIOCB_Asynch_Transmit_Handler [friend]
 

class ACE_POSIX_Asynch_Transmit_Handler [friend]
 

Handlers do all the job.

class ACE_POSIX_Proactor [friend]
 

The Proactor constructs the Result class for faking results.


Member Data Documentation

u_long ACE_POSIX_Asynch_Transmit_File_Result::bytes_per_send_ [protected]
 

Number of bytes per send requested at the start of the transmit file.

u_long ACE_POSIX_Asynch_Transmit_File_Result::flags_ [protected]
 

Flags which were passed into transmit file.

ACE_Asynch_Transmit_File::Header_And_Trailer * ACE_POSIX_Asynch_Transmit_File_Result::header_and_trailer_ [protected]
 

Header and trailer data associated with this transmit file.

ACE_HANDLE ACE_POSIX_Asynch_Transmit_File_Result::socket_ [protected]
 

Network I/O handle.


The documentation for this class was generated from the following files:
Generated at Fri Oct 5 07:03:47 2001 for ACE by doxygen1.2.3 written by Dimitri van Heesch, © 1997-2000