ACE  6.4.0
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
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]

Public Member Functions

ACE_HANDLE socket (void) const
 Socket used for transmitting the file. More...
 
ACE_HANDLE file (void) const
 File from which the data is read. More...
 
ACE_Asynch_Transmit_File::Header_And_Trailerheader_and_trailer (void) const
 Header and trailer data associated with this transmit file. More...
 
size_t bytes_to_write (void) const
 
size_t bytes_per_send (void) const
 
u_long flags (void) const
 Flags which were passed into transmit file. More...
 
- Public Member Functions inherited from ACE_Asynch_Transmit_File_Result_Impl
virtual ~ACE_Asynch_Transmit_File_Result_Impl (void)
 
- Public Member Functions inherited from ACE_Asynch_Result_Impl
virtual ~ACE_Asynch_Result_Impl (void)
 
- Public Member Functions inherited from ACE_POSIX_Asynch_Result
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 fails. More...
 
ACE_HANDLE event (void) const
 This returns ACE_INVALID_HANDLE on POSIX4 platforms. More...
 
u_long offset (void) const
 
u_long offset_high (void) const
 
int priority (void) const
 Priority of the operation. More...
 
int signal_number (void) const
 
int post_completion (ACE_Proactor_Impl *proactor)
 Post this to the Proactor. More...
 
virtual ~ACE_POSIX_Asynch_Result (void)
 Destructor. More...
 
void set_error (u_long errcode)
 Simulate error value to use in the post_completion () More...
 
void set_bytes_transferred (size_t nbytes)
 Simulate value to use in the post_completion () More...
 

Protected Member Functions

 ACE_POSIX_Asynch_Transmit_File_Result (const ACE_Handler::Proxy_Ptr &handler_proxy, ACE_HANDLE socket, ACE_HANDLE file, ACE_Asynch_Transmit_File::Header_And_Trailer *header_and_trailer, size_t bytes_to_write, u_long offset, u_long offset_high, size_t bytes_per_send, u_long flags, const void *act, ACE_HANDLE event, int priority, int signal_number)
 
virtual void complete (size_t bytes_transferred, int success, const void *completion_key, u_long error)
 ACE_Proactor will call this method when the write completes. More...
 
virtual ~ACE_POSIX_Asynch_Transmit_File_Result (void)
 Destructor. More...
 
- Protected Member Functions inherited from ACE_Asynch_Transmit_File_Result_Impl
 ACE_Asynch_Transmit_File_Result_Impl (void)
 Do-nothing constructor. More...
 
- Protected Member Functions inherited from ACE_Asynch_Result_Impl
 ACE_Asynch_Result_Impl (void)
 Do-nothing constructor. More...
 
- Protected Member Functions inherited from ACE_POSIX_Asynch_Result
 ACE_POSIX_Asynch_Result (const ACE_Handler::Proxy_Ptr &handler_proxy, const void *act, ACE_HANDLE event, u_long offset, u_long offset_high, int priority, int signal_number)
 Constructor. <Event> is not used on POSIX. More...
 

Protected Attributes

ACE_HANDLE socket_
 Network I/O handle. More...
 
ACE_Asynch_Transmit_File::Header_And_Trailerheader_and_trailer_
 Header and trailer data associated with this transmit file. More...
 
size_t bytes_per_send_
 
u_long flags_
 Flags which were passed into transmit file. More...
 
- Protected Attributes inherited from ACE_POSIX_Asynch_Result
ACE_Handler::Proxy_Ptr handler_proxy_
 Handler that will be called back. More...
 
const void * act_
 
size_t bytes_transferred_
 Bytes transferred by this operation. More...
 
int success_
 Success indicator. More...
 
const void * completion_key_
 ACT associated with handle. More...
 
u_long error_
 Error if operation failed. More...
 

Friends

class ACE_POSIX_Asynch_Transmit_File
 Factory classes will have special permissions. More...
 
class ACE_POSIX_Asynch_Transmit_Handler
 Handlers do all the job. More...
 
class ACE_POSIX_Proactor
 The Proactor constructs the Result class for faking results. More...
 

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 ( const ACE_Handler::Proxy_Ptr handler_proxy,
ACE_HANDLE  socket,
ACE_HANDLE  file,
ACE_Asynch_Transmit_File::Header_And_Trailer header_and_trailer,
size_t  bytes_to_write,
u_long  offset,
u_long  offset_high,
size_t  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  )
protectedvirtual

Destructor.

Member Function Documentation

size_t ACE_POSIX_Asynch_Transmit_File_Result::bytes_per_send ( void  ) const
virtual

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

Implements ACE_Asynch_Transmit_File_Result_Impl.

size_t ACE_POSIX_Asynch_Transmit_File_Result::bytes_to_write ( void  ) const
virtual

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

Implements ACE_Asynch_Transmit_File_Result_Impl.

void ACE_POSIX_Asynch_Transmit_File_Result::complete ( size_t  bytes_transferred,
int  success,
const void *  completion_key,
u_long  error 
)
protectedvirtual

ACE_Proactor will call this method when the write completes.

Implements ACE_Asynch_Result_Impl.

ACE_HANDLE ACE_POSIX_Asynch_Transmit_File_Result::file ( void  ) const
virtual

File from which the data is read.

Implements ACE_Asynch_Transmit_File_Result_Impl.

u_long ACE_POSIX_Asynch_Transmit_File_Result::flags ( void  ) const
virtual

Flags which were passed into transmit file.

Implements ACE_Asynch_Transmit_File_Result_Impl.

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

Header and trailer data associated with this transmit file.

Implements ACE_Asynch_Transmit_File_Result_Impl.

ACE_HANDLE ACE_POSIX_Asynch_Transmit_File_Result::socket ( void  ) const
virtual

Socket used for transmitting the file.

Implements ACE_Asynch_Transmit_File_Result_Impl.

Friends And Related Function Documentation

friend class ACE_POSIX_Asynch_Transmit_File
friend

Factory classes will have special permissions.

friend class ACE_POSIX_Asynch_Transmit_Handler
friend

Handlers do all the job.

friend class ACE_POSIX_Proactor
friend

The Proactor constructs the Result class for faking results.

Member Data Documentation

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