ACE_POSIX_Asynch_Write_Stream_Result Class Reference

This class provides concrete implementation for <ACE_Asynch_Write_Stream::Result> on POSIX platforms. More...

#include <POSIX_Asynch_IO.h>

Inheritance diagram for ACE_POSIX_Asynch_Write_Stream_Result:

Collaboration diagram for ACE_POSIX_Asynch_Write_Stream_Result:

Public Member Functions
size_t	bytes_to_write () const
ACE_Message_Block &	message_block () const
	Message block that contains the data to be written.
ACE_HANDLE	handle () const
	I/O handle used for writing.
Public Member Functions inherited from ACE_Asynch_Write_Stream_Result_Impl
virtual	~ACE_Asynch_Write_Stream_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_Write_Stream_Result (const ACE_Handler::Proxy_Ptr &handler_proxy, ACE_HANDLE handle, ACE_Message_Block &message_block, size_t bytes_to_write, 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_Write_Stream_Result ()
	Destructor.
Protected Member Functions inherited from ACE_Asynch_Write_Stream_Result_Impl
	ACE_Asynch_Write_Stream_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_Message_Block &	message_block_
	Message block that contains the data to be written.
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_Write_Stream
	Factory classes will have special privilages.
class	ACE_POSIX_Proactor
	The Proactor constructs the Result class for faking results.

Detailed Description

This class provides concrete implementation for <ACE_Asynch_Write_Stream::Result> on POSIX platforms.

This class has all the information necessary for the handler to uniquiely identify the completion of the asynchronous write.

Constructor & Destructor Documentation

ACE_POSIX_Asynch_Write_Stream_Result()

ACE_POSIX_Asynch_Write_Stream_Result::ACE_POSIX_Asynch_Write_Stream_Result ( const ACE_Handler::Proxy_Ptr & handler_proxy, ACE_HANDLE handle, ACE_Message_Block & message_block, size_t bytes_to_write, const void * act, ACE_HANDLE event, int priority, int signal_number )

protected

Constructor is protected since creation is limited to ACE_Asynch_Write_Stream factory.

~ACE_POSIX_Asynch_Write_Stream_Result()

ACE_POSIX_Asynch_Write_Stream_Result::~ACE_POSIX_Asynch_Write_Stream_Result ( )

protectedvirtual

Destructor.

Member Function Documentation

bytes_to_write()

size_t ACE_POSIX_Asynch_Write_Stream_Result::bytes_to_write ( ) const

virtual

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

Implements ACE_Asynch_Write_Stream_Result_Impl.

complete()

void ACE_POSIX_Asynch_Write_Stream_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.

Reimplemented in ACE_POSIX_Asynch_Write_File_Result.

handle()

ACE_HANDLE ACE_POSIX_Asynch_Write_Stream_Result::handle ( ) const

virtual

I/O handle used for writing.

Implements ACE_Asynch_Write_Stream_Result_Impl.

message_block()

ACE_Message_Block & ACE_POSIX_Asynch_Write_Stream_Result::message_block ( ) const

virtual

Message block that contains the data to be written.

Implements ACE_Asynch_Write_Stream_Result_Impl.

Friends And Related Symbol Documentation

ACE_POSIX_Asynch_Write_Stream

friend class ACE_POSIX_Asynch_Write_Stream

friend

Factory classes will have special privilages.

ACE_POSIX_Proactor

friend class ACE_POSIX_Proactor

friend

The Proactor constructs the Result class for faking results.

Member Data Documentation

message_block_

ACE_Message_Block& ACE_POSIX_Asynch_Write_Stream_Result::message_block_

protected

Message block that contains the data to be written.

---

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

• POSIX_Asynch_IO.h
• POSIX_Asynch_IO.cpp