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:

[legend]

Collaboration diagram for ACE_POSIX_Asynch_Transmit_File_Result:

[legend]

Public Member Functions
ACE_HANDLE	socket () const
	Socket used for transmitting the file.

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

ACE_Asynch_Transmit_File::Header_And_Trailer *	header_and_trailer () const
	Header and trailer data associated with this transmit file.

size_t	bytes_to_write () const

size_t	bytes_per_send () const

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

Public Member Functions inherited from ACE_Asynch_Transmit_File_Result_Impl
virtual	~ACE_Asynch_Transmit_File_Result_Impl ()

Public Member Functions inherited from ACE_Asynch_Result_Impl
virtual	~ACE_Asynch_Result_Impl ()

Public Member Functions inherited from ACE_POSIX_Asynch_Result
size_t	bytes_transferred () const
	Number of bytes transferred by the operation.

const void *	act () const
	ACT associated with the operation.

int	success () const
	Did the operation succeed?

const void *	completion_key () const

u_long	error () const
	Error value if the operation fails.

ACE_HANDLE	event () const
	This returns ACE_INVALID_HANDLE on POSIX4 platforms.

u_long	offset () const

u_long	offset_high () const

int	priority () const
	Priority of the operation.

int	signal_number () const

int	post_completion (ACE_Proactor_Impl *proactor)
	Post `this` to the Proactor.

virtual	~ACE_POSIX_Asynch_Result ()
	Destructor.

void	set_error (u_long errcode)
	Simulate error value to use in the post_completion ()

void	set_bytes_transferred (size_t nbytes)
	Simulate value to use in the post_completion ()

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.

virtual	~ACE_POSIX_Asynch_Transmit_File_Result ()
	Destructor.

Protected Member Functions inherited from ACE_Asynch_Transmit_File_Result_Impl
	ACE_Asynch_Transmit_File_Result_Impl ()
	Do-nothing constructor.

Protected Member Functions inherited from ACE_Asynch_Result_Impl
	ACE_Asynch_Result_Impl ()
	Do-nothing constructor.

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.

Protected Attributes
ACE_HANDLE	socket_
	Network I/O handle.

ACE_Asynch_Transmit_File::Header_And_Trailer *	header_and_trailer_
	Header and trailer data associated with this transmit file.

size_t	bytes_per_send_

u_long	flags_
	Flags which were passed into transmit file.

Protected Attributes inherited from ACE_POSIX_Asynch_Result
ACE_Handler::Proxy_Ptr	handler_proxy_
	Handler that will be called back.

const void *	act_

size_t	bytes_transferred_
	Bytes transferred by this operation.

int	success_
	Success indicator.

const void *	completion_key_
	ACT associated with handle.

u_long	error_
	Error if operation failed.

Friends
class	ACE_POSIX_Asynch_Transmit_File
	Factory classes will have special permissions.

class	ACE_POSIX_Asynch_Transmit_Handler
	Handlers do all the job.

class	ACE_POSIX_Proactor
	The Proactor constructs the Result class for faking results.

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_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::~ACE_POSIX_Asynch_Transmit_File_Result ( )

protectedvirtual

Destructor.

Member Function Documentation

◆ bytes_per_send()

size_t ACE_POSIX_Asynch_Transmit_File_Result::bytes_per_send ( ) const

virtual

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

Implements ACE_Asynch_Transmit_File_Result_Impl.

◆ bytes_to_write()

size_t ACE_POSIX_Asynch_Transmit_File_Result::bytes_to_write ( ) const

virtual

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

Implements ACE_Asynch_Transmit_File_Result_Impl.

◆ complete()

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.

◆ file()

ACE_HANDLE ACE_POSIX_Asynch_Transmit_File_Result::file ( ) const

virtual

File from which the data is read.

Implements ACE_Asynch_Transmit_File_Result_Impl.

◆ flags()

u_long ACE_POSIX_Asynch_Transmit_File_Result::flags ( ) const

virtual

Flags which were passed into transmit file.

Implements ACE_Asynch_Transmit_File_Result_Impl.

◆ header_and_trailer()

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

virtual

Header and trailer data associated with this transmit file.

Implements ACE_Asynch_Transmit_File_Result_Impl.

◆ socket()

ACE_HANDLE ACE_POSIX_Asynch_Transmit_File_Result::socket ( ) const

virtual

Socket used for transmitting the file.

Implements ACE_Asynch_Transmit_File_Result_Impl.

Friends And Related Symbol Documentation

◆ ACE_POSIX_Asynch_Transmit_File

friend class ACE_POSIX_Asynch_Transmit_File

friend

Factory classes will have special permissions.

◆ ACE_POSIX_Asynch_Transmit_Handler

friend class ACE_POSIX_Asynch_Transmit_Handler

friend

Handlers do all the job.

◆ ACE_POSIX_Proactor

friend class ACE_POSIX_Proactor

friend

The Proactor constructs the Result class for faking results.

Member Data Documentation

◆ bytes_per_send_

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.

◆ flags_

u_long ACE_POSIX_Asynch_Transmit_File_Result::flags_

protected

Flags which were passed into transmit file.

◆ header_and_trailer_

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.

◆ socket_

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:

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ACE_POSIX_Asynch_Transmit_File_Result()

◆ ~ACE_POSIX_Asynch_Transmit_File_Result()

Member Function Documentation

◆ bytes_per_send()

◆ bytes_to_write()

◆ complete()

◆ file()

◆ flags()

◆ header_and_trailer()

◆ socket()

Friends And Related Symbol Documentation

◆ ACE_POSIX_Asynch_Transmit_File

◆ ACE_POSIX_Asynch_Transmit_Handler

◆ ACE_POSIX_Proactor

Member Data Documentation

◆ bytes_per_send_

◆ flags_

◆ header_and_trailer_

◆ socket_