---

ACE_WIN32_Asynch_Transmit_File Class Reference

This class is a factory for starting off asynchronous transmit files on a stream. More...

#include <WIN32_Asynch_IO.h>

Inheritance diagram for ACE_WIN32_Asynch_Transmit_File:

[legend]Collaboration diagram for ACE_WIN32_Asynch_Transmit_File:

[legend]List of all members.

Public Methods
	ACE_WIN32_Asynch_Transmit_File (ACE_WIN32_Proactor *win32_proactor)
	Constructor.
int	transmit_file (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, int priority, int signal_number=0)
	~ACE_WIN32_Asynch_Transmit_File (void)
	Destructor.
int	open (ACE_Handler &handler, ACE_HANDLE handle, const void *completion_key, ACE_Proactor *proactor)
int	cancel (void)
ACE_Proactor *	proactor (void) const
	Return the underlying proactor.

---

Detailed Description

This class is a factory for starting off asynchronous transmit files on a stream.

Once <open> is called, multiple asynchronous <transmit_file>s can started using this class. A ACE_Asynch_Transmit_File::Result will be passed back to the <handler> when the asynchronous transmit file completes through the <ACE_Handler::handle_transmit_file> callback.

The transmit_file function transmits file data over a connected network connection. The function uses the operating system's cache manager to retrieve the file data. This function provides high-performance file data transfer over network connections. This function would be of great use in a Web Server, Image Server, etc.

---

Constructor & Destructor Documentation

ACE_WIN32_Asynch_Transmit_File::ACE_WIN32_Asynch_Transmit_File (  ACE_WIN32_Proactor *    win32_proactor )

Constructor.

ACE_WIN32_Asynch_Transmit_File::~ACE_WIN32_Asynch_Transmit_File (  void    )

Destructor.

---

Member Function Documentation

int ACE_WIN32_Asynch_Transmit_File::cancel (  void    )  [virtual]

This cancels all pending accepts operations that were issued by the calling thread. The function does not cancel asynchronous operations issued by other threads. Reimplemented from ACE_WIN32_Asynch_Operation.

int ACE_WIN32_Asynch_Transmit_File::open (  ACE_Handler &    handler, ACE_HANDLE    handle, const void *    completion_key, ACE_Proactor *    proactor )  [virtual]

Initializes the factory with information which will be used with each asynchronous call. If (<handle> == ACE_INVALID_HANDLE), <ACE_Handler::handle> will be called on the <handler> to get the correct handle. Reimplemented from ACE_WIN32_Asynch_Operation.

ACE_Proactor * ACE_WIN32_Asynch_Transmit_File::proactor (  void    )  const [virtual]

Return the underlying proactor. Reimplemented from ACE_WIN32_Asynch_Operation.

int ACE_WIN32_Asynch_Transmit_File::transmit_file (  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, int    priority, int    signal_number = 0 )  [virtual]

This starts off an asynchronous transmit file. The <file> is a handle to an open file. <header_and_trailer> is a pointer to a data structure that contains pointers to data to send before and after the file data is sent. Set this parameter to 0 if you only want to transmit the file data. Upto <bytes_to_write> will be written to the <socket>. If you want to send the entire file, let <bytes_to_write> = 0. <bytes_per_send> is the size of each block of data sent per send operation. Please read the Win32 documentation on what the flags should be. Implements ACE_Asynch_Transmit_File_Impl.

---

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

• /export2/deucetmp/bala/release_try/ACE_wrappers/ace/WIN32_Asynch_IO.h
• /export2/deucetmp/bala/release_try/ACE_wrappers/ace/WIN32_Asynch_IO.cpp

---