ACE_Handler Class Reference

This base class defines the interface for receiving the results of asynchronous operations. More...

#include <Asynch_IO.h>

Inheritance diagram for ACE_Handler:

Collaboration diagram for ACE_Handler:

Classes
class	Proxy
	The Proxy class acts as a proxy for dispatch of completions to operations issued for the associated handler. It allows the handler to be deleted while operations are outstanding. The proxy must be used to get the ACE_Handler pointer for dispatching, and if it's 0, the handler is no longer valid and the result should not be dispatched. More...

Public Types
typedef ACE_Refcounted_Auto_Ptr< Proxy, ACE_SYNCH_MUTEX >	Proxy_Ptr

Public Member Functions
	ACE_Handler ()
	A do nothing constructor.
	ACE_Handler (ACE_Proactor *p)
	A do nothing constructor which allows proactor to be set to <p>.
virtual	~ACE_Handler ()
	Virtual destruction.
virtual void	handle_read_stream (const ACE_Asynch_Read_Stream::Result &result)
virtual void	handle_write_dgram (const ACE_Asynch_Write_Dgram::Result &result)
virtual void	handle_read_dgram (const ACE_Asynch_Read_Dgram::Result &result)
virtual void	handle_write_stream (const ACE_Asynch_Write_Stream::Result &result)
virtual void	handle_read_file (const ACE_Asynch_Read_File::Result &result)
virtual void	handle_write_file (const ACE_Asynch_Write_File::Result &result)
virtual void	handle_accept (const ACE_Asynch_Accept::Result &result)
	This method will be called when an asynchronous accept completes.
virtual void	handle_connect (const ACE_Asynch_Connect::Result &result)
	This method will be called when an asynchronous connect completes.
virtual void	handle_transmit_file (const ACE_Asynch_Transmit_File::Result &result)
virtual void	handle_time_out (const ACE_Time_Value &tv, const void *act=0)
virtual void	handle_wakeup ()
ACE_Proactor *	proactor ()
	Get the proactor associated with this handler.
void	proactor (ACE_Proactor *p)
	Set the proactor.
virtual ACE_HANDLE	handle () const
virtual void	handle (ACE_HANDLE)
	Set the ACE_HANDLE value for this Handler.
Proxy_Ptr &	proxy ()

Protected Attributes
ACE_Proactor *	proactor_
	The proactor associated with this handler.
ACE_HANDLE	handle_
	The ACE_HANDLE in use with this handler.
ACE_Refcounted_Auto_Ptr< Proxy, ACE_SYNCH_MUTEX >	proxy_
	Refers to proxy for this handler.

Private Member Functions
	ACE_Handler (const ACE_Handler &)=delete
ACE_Handler	operator= (const ACE_Handler &)=delete

Detailed Description

This base class defines the interface for receiving the results of asynchronous operations.

Subclasses of this class will fill in appropriate methods.

Member Typedef Documentation

Proxy_Ptr

typedef ACE_Refcounted_Auto_Ptr<Proxy, ACE_SYNCH_MUTEX> ACE_Handler::Proxy_Ptr

Constructor & Destructor Documentation

ACE_Handler() [1/3]

ACE_Handler::ACE_Handler

(

)

A do nothing constructor.

ACE_Handler() [2/3]

ACE_Handler::ACE_Handler

(

ACE_Proactor *

p

)

A do nothing constructor which allows proactor to be set to <p>.

~ACE_Handler()

ACE_Handler::~ACE_Handler ( )

virtual

Virtual destruction.

ACE_Handler() [3/3]

ACE_Handler::ACE_Handler ( const ACE_Handler & )

privatedelete

Member Function Documentation

handle() [1/2]

ACE_HANDLE ACE_Handler::handle ( ) const

virtual

Get the I/O handle used by this {handler}. This method will be called by the ACE_Asynch_* classes when an ACE_INVALID_HANDLE is passed to {open}.

Reimplemented in ACE_Asynch_Acceptor< HANDLER >.

handle() [2/2]

void ACE_Handler::handle ( ACE_HANDLE h )

virtual

Set the ACE_HANDLE value for this Handler.

Reimplemented in ACE_Asynch_Acceptor< HANDLER >.

handle_accept()

void ACE_Handler::handle_accept ( const ACE_Asynch_Accept::Result & result )

virtual

This method will be called when an asynchronous accept completes.

Reimplemented in ACE_Asynch_Acceptor< HANDLER >.

handle_connect()

void ACE_Handler::handle_connect ( const ACE_Asynch_Connect::Result & result )

virtual

This method will be called when an asynchronous connect completes.

Reimplemented in ACE_Asynch_Connector< HANDLER >.

handle_read_dgram()

void ACE_Handler::handle_read_dgram ( const ACE_Asynch_Read_Dgram::Result & result )

virtual

This method will be called when an asynchronous read completes on a UDP socket.

handle_read_file()

void ACE_Handler::handle_read_file ( const ACE_Asynch_Read_File::Result & result )

virtual

This method will be called when an asynchronous read completes on a file.

Reimplemented in ACE_POSIX_Asynch_Transmit_Handler.

handle_read_stream()

void ACE_Handler::handle_read_stream ( const ACE_Asynch_Read_Stream::Result & result )

virtual

This method will be called when an asynchronous read completes on a stream.

Reimplemented in ACE_AIOCB_Notify_Pipe_Manager.

handle_time_out()

void ACE_Handler::handle_time_out ( const ACE_Time_Value & tv, const void * act = 0 )

virtual

Called when timer expires. {tv} was the requested time value and {act} is the ACT passed when scheduling the timer.

handle_transmit_file()

void ACE_Handler::handle_transmit_file ( const ACE_Asynch_Transmit_File::Result & result )

virtual

This method will be called when an asynchronous transmit file completes.

handle_wakeup()

void ACE_Handler::handle_wakeup ( )

virtual

This is method works with the {run_event_loop} of the ACE_Proactor. A special {Wake_Up_Completion} is used to wake up all the threads that are blocking for completions.

handle_write_dgram()

void ACE_Handler::handle_write_dgram ( const ACE_Asynch_Write_Dgram::Result & result )

virtual

This method will be called when an asynchronous write completes on a UDP socket.

handle_write_file()

void ACE_Handler::handle_write_file ( const ACE_Asynch_Write_File::Result & result )

virtual

This method will be called when an asynchronous write completes on a file.

handle_write_stream()

void ACE_Handler::handle_write_stream ( const ACE_Asynch_Write_Stream::Result & result )

virtual

This method will be called when an asynchronous write completes on a stream.

Reimplemented in ACE_POSIX_Asynch_Transmit_Handler.

operator=()

ACE_Handler ACE_Handler::operator= ( const ACE_Handler & )

privatedelete

proactor() [1/2]

ACE_Proactor * ACE_Handler::proactor

(

)

Get the proactor associated with this handler.

proactor() [2/2]

void ACE_Handler::proactor

(

ACE_Proactor *

p

)

Set the proactor.

proxy()

ACE_Refcounted_Auto_Ptr< ACE_Handler::Proxy, ACE_SYNCH_MUTEX > & ACE_Handler::proxy

(

)

Member Data Documentation

handle_

ACE_HANDLE ACE_Handler::handle_

protected

The ACE_HANDLE in use with this handler.

proactor_

ACE_Proactor* ACE_Handler::proactor_

protected

The proactor associated with this handler.

proxy_

ACE_Refcounted_Auto_Ptr<Proxy, ACE_SYNCH_MUTEX> ACE_Handler::proxy_

protected

Refers to proxy for this handler.

---

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

• Asynch_IO.h
• Asynch_IO.cpp