ACE_WIN32_Proactor Class Reference

A manager for asynchronous event demultiplexing on Win32. More...

#include <WIN32_Proactor.h>

Inheritance diagram for ACE_WIN32_Proactor:

Collaboration diagram for ACE_WIN32_Proactor:

Public Member Functions
	ACE_WIN32_Proactor (size_t number_of_threads=0, bool used_with_reactor_event_loop=false)
	A do nothing constructor.
virtual	~ACE_WIN32_Proactor ()
	Virtual destruction.
virtual int	close ()
	Close the IO completion port.
virtual int	register_handle (ACE_HANDLE handle, const void *completion_key)
virtual int	handle_events (ACE_Time_Value &wait_time)
virtual int	handle_events ()
virtual int	post_completion (ACE_WIN32_Asynch_Result *result)
int	wake_up_dispatch_threads ()
	Add wakeup dispatch threads (reinit).
int	close_dispatch_threads (int wait)
	Close all dispatch threads.
size_t	number_of_threads () const
	Get number of thread used as a parameter to CreateIoCompletionPort.
void	number_of_threads (size_t threads)
	Set number of thread used as a parameter to CreateIoCompletionPort.
virtual ACE_HANDLE	get_handle () const
	Get the event handle.
virtual ACE_Asynch_Read_Stream_Impl *	create_asynch_read_stream ()
	Create the correct implementation class for doing Asynch_Read_Stream.
virtual ACE_Asynch_Write_Stream_Impl *	create_asynch_write_stream ()
	Create the correct implementation class for doing Asynch_Write_Stream.
virtual ACE_Asynch_Read_File_Impl *	create_asynch_read_file ()
	Create the correct implementation class for doing Asynch_Read_File.
virtual ACE_Asynch_Write_File_Impl *	create_asynch_write_file ()
	Create the correct implementation class for doing Asynch_Write_File.
virtual ACE_Asynch_Read_Dgram_Impl *	create_asynch_read_dgram ()
virtual ACE_Asynch_Write_Dgram_Impl *	create_asynch_write_dgram ()
virtual ACE_Asynch_Accept_Impl *	create_asynch_accept ()
	Create the correct implementation class for doing Asynch_Accept.
virtual ACE_Asynch_Connect_Impl *	create_asynch_connect ()
	Create the correct implementation class for doing Asynch_Connect.
virtual ACE_Asynch_Transmit_File_Impl *	create_asynch_transmit_file ()
	Create the correct implementation class for doing Asynch_Transmit_File.
virtual ACE_Asynch_Read_Stream_Result_Impl *	create_asynch_read_stream_result (const ACE_Handler::Proxy_Ptr &handler_proxy, ACE_HANDLE handle, ACE_Message_Block &message_block, size_t bytes_to_read, const void *act, ACE_HANDLE event, int priority, int signal_number=0)
	Create the correct implementation class for ACE_Asynch_Read_Stream::Result class.
virtual ACE_Asynch_Write_Stream_Result_Impl *	create_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=0)
	Create the correct implementation class for ACE_Asynch_Write_Stream::Result.
virtual ACE_Asynch_Read_File_Result_Impl *	create_asynch_read_file_result (const ACE_Handler::Proxy_Ptr &handler_proxy, ACE_HANDLE handle, ACE_Message_Block &message_block, size_t bytes_to_read, const void *act, u_long offset, u_long offset_high, ACE_HANDLE event, int priority, int signal_number=0)
	Create the correct implementation class for ACE_Asynch_Read_File::Result.
virtual ACE_Asynch_Write_File_Result_Impl *	create_asynch_write_file_result (const ACE_Handler::Proxy_Ptr &handler_proxy, ACE_HANDLE handle, ACE_Message_Block &message_block, size_t bytes_to_write, const void *act, u_long offset, u_long offset_high, ACE_HANDLE event, int priority, int signal_number=0)
	Create the correct implementation class for ACE_Asynch_Write_File::Result.
virtual ACE_Asynch_Read_Dgram_Result_Impl *	create_asynch_read_dgram_result (const ACE_Handler::Proxy_Ptr &handler_proxy, ACE_HANDLE handle, ACE_Message_Block *message_block, size_t bytes_to_read, int flags, int protocol_family, const void *act, ACE_HANDLE event, int priority, int signal_number=0)
	Create the correct implementation class for ACE_Asynch_Read_Dgram::Result.
virtual ACE_Asynch_Write_Dgram_Result_Impl *	create_asynch_write_dgram_result (const ACE_Handler::Proxy_Ptr &handler_proxy, ACE_HANDLE handle, ACE_Message_Block *message_block, size_t bytes_to_write, int flags, const void *act, ACE_HANDLE event, int priority, int signal_number=0)
	Create the correct implementation class for ACE_Asynch_Write_Dgram::Result.
virtual ACE_Asynch_Accept_Result_Impl *	create_asynch_accept_result (const ACE_Handler::Proxy_Ptr &handler_proxy, ACE_HANDLE listen_handle, ACE_HANDLE accept_handle, ACE_Message_Block &message_block, size_t bytes_to_read, const void *act, ACE_HANDLE event, int priority, int signal_number=0)
	Create the correct implementation class for ACE_Asynch_Accept::Result.
virtual ACE_Asynch_Connect_Result_Impl *	create_asynch_connect_result (const ACE_Handler::Proxy_Ptr &handler_proxy, ACE_HANDLE connect_handle, const void *act, ACE_HANDLE event, int priority, int signal_number=0)
	Create the correct implementation class for ACE_Asynch_Connect::Result.
virtual ACE_Asynch_Transmit_File_Result_Impl *	create_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=0)
	Create the correct implementation class for ACE_Asynch_Transmit_File::Result.
virtual ACE_Asynch_Result_Impl *	create_asynch_timer (const ACE_Handler::Proxy_Ptr &handler_proxy, const void *act, const ACE_Time_Value &tv, ACE_HANDLE event, int priority, int signal_number=0)
Public Member Functions inherited from ACE_Proactor_Impl
virtual	~ACE_Proactor_Impl ()
	Virtual destruction.
Public Member Functions inherited from ACE_Event_Handler
virtual	~ACE_Event_Handler ()=default
	Destructor is virtual to enable proper cleanup.
virtual void	set_handle (ACE_HANDLE)
	Set the I/O handle.
virtual int	priority () const
virtual void	priority (int priority)
	Set the priority of the Event_Handler.
virtual int	handle_input (ACE_HANDLE fd=ACE_INVALID_HANDLE)
	Called when input events occur (e.g., connection or data).
virtual int	handle_output (ACE_HANDLE fd=ACE_INVALID_HANDLE)
virtual int	handle_exception (ACE_HANDLE fd=ACE_INVALID_HANDLE)
	Called when an exceptional events occur (e.g., SIGURG).
virtual int	handle_timeout (const ACE_Time_Value &current_time, const void *act=0)
virtual int	handle_exit (ACE_Process *)
	Called when a process exits.
virtual int	resume_handler ()
virtual int	handle_qos (ACE_HANDLE=ACE_INVALID_HANDLE)
virtual int	handle_group_qos (ACE_HANDLE=ACE_INVALID_HANDLE)
virtual void	reactor (ACE_Reactor *reactor)
	Set the event demultiplexors.
virtual ACE_Reactor *	reactor () const
	Get the event demultiplexors.
virtual ACE_Reactor_Timer_Interface *	reactor_timer_interface () const
	Get only the reactor's timer related interface.
virtual Reference_Count	add_reference ()
	Increment reference count on the handler.
virtual Reference_Count	remove_reference ()
	Decrement reference count on the handler.
Reference_Counting_Policy &	reference_counting_policy ()
	Current Reference_Counting_Policy.

Protected Member Functions
ACE_Asynch_Pseudo_Task &	get_asynch_pseudo_task ()
	Task to process pseudo-asynchronous operations.
virtual int	handle_signal (int signum, siginfo_t *=0, ucontext_t *=0)
virtual int	handle_close (ACE_HANDLE handle, ACE_Reactor_Mask close_mask)
	Called when object is removed from the ACE_Reactor.
virtual int	handle_events (unsigned long milli_seconds)
void	application_specific_code (ACE_WIN32_Asynch_Result *asynch_result, size_t bytes_transferred, const void *completion_key, u_long error)
virtual int	post_wakeup_completions (int how_many)
Protected Member Functions inherited from ACE_Event_Handler
	ACE_Event_Handler (ACE_Reactor *=nullptr, int priority=ACE_Event_Handler::LO_PRIORITY)
	Force ACE_Event_Handler to be an abstract base class.

Protected Attributes
ACE_HANDLE	completion_port_
DWORD	number_of_threads_
ACE_Auto_Event	event_
	integrate the event loops of Reactor and the Proactor.
bool const	used_with_reactor_event_loop_
ACE_Handler	wakeup_handler_
ACE_Asynch_Pseudo_Task	pseudo_task_
Protected Attributes inherited from ACE_Event_Handler
Atomic_Reference_Count	reference_count_
	Reference count.

Friends
class	ACE_WIN32_Asynch_Connect

Additional Inherited Members
Public Types inherited from ACE_Event_Handler
enum	{   LO_PRIORITY = 0 , HI_PRIORITY = 10 , NULL_MASK = 0 , READ_MASK = (1 << 0) ,   WRITE_MASK = (1 << 1) , EXCEPT_MASK = (1 << 2) , ACCEPT_MASK = (1 << 3) , CONNECT_MASK = (1 << 4) ,   TIMER_MASK = (1 << 5) , QOS_MASK = (1 << 6) , GROUP_QOS_MASK = (1 << 7) , SIGNAL_MASK = (1 << 8) ,   ALL_EVENTS_MASK , RWE_MASK , DONT_CALL = (1 << 9) }
enum	{ ACE_EVENT_HANDLER_NOT_RESUMED = -1 , ACE_REACTOR_RESUMES_HANDLER = 0 , ACE_APPLICATION_RESUMES_HANDLER }
typedef long	Reference_Count
	Reference count type.
Static Public Member Functions inherited from ACE_Event_Handler
static ACE_THR_FUNC_RETURN	read_adapter (void *event_handler)
static int	register_stdin_handler (ACE_Event_Handler *eh, ACE_Reactor *reactor, ACE_Thread_Manager *thr_mgr, int flags=THR_DETACHED)
static int	remove_stdin_handler (ACE_Reactor *reactor, ACE_Thread_Manager *thr_mgr)
	Performs the inverse of the register_stdin_handler() method.
Protected Types inherited from ACE_Event_Handler
typedef std::atomic< Reference_Count >	Atomic_Reference_Count
	Typedef for implementation of reference counting.

Detailed Description

A manager for asynchronous event demultiplexing on Win32.

See the Proactor pattern description at http://www.dre.vanderbilt.edu/~schmidt/PDF/proactor.pdf for more details.

Constructor & Destructor Documentation

ACE_WIN32_Proactor()

ACE_WIN32_Proactor::ACE_WIN32_Proactor	(	size_t	number_of_threads = 0,
		bool	used_with_reactor_event_loop = false )

A do nothing constructor.

~ACE_WIN32_Proactor()

ACE_WIN32_Proactor::~ACE_WIN32_Proactor ( )

virtual

Virtual destruction.

Member Function Documentation

application_specific_code()

void ACE_WIN32_Proactor::application_specific_code ( ACE_WIN32_Asynch_Result * asynch_result, size_t bytes_transferred, const void * completion_key, u_long error )

protected

Protect against structured exceptions caused by user code when dispatching handles.

close()

int ACE_WIN32_Proactor::close ( )

virtual

Close the IO completion port.

Implements ACE_Proactor_Impl.

close_dispatch_threads()

int ACE_WIN32_Proactor::close_dispatch_threads ( int wait )

virtual

Close all dispatch threads.

Implements ACE_Proactor_Impl.

create_asynch_accept()

ACE_Asynch_Accept_Impl * ACE_WIN32_Proactor::create_asynch_accept ( )

virtual

Create the correct implementation class for doing Asynch_Accept.

Implements ACE_Proactor_Impl.

create_asynch_accept_result()

ACE_Asynch_Accept_Result_Impl * ACE_WIN32_Proactor::create_asynch_accept_result ( const ACE_Handler::Proxy_Ptr & handler_proxy, ACE_HANDLE listen_handle, ACE_HANDLE accept_handle, ACE_Message_Block & message_block, size_t bytes_to_read, const void * act, ACE_HANDLE event, int priority, int signal_number = 0 )

virtual

Create the correct implementation class for ACE_Asynch_Accept::Result.

Implements ACE_Proactor_Impl.

create_asynch_connect()

ACE_Asynch_Connect_Impl * ACE_WIN32_Proactor::create_asynch_connect ( )

virtual

Create the correct implementation class for doing Asynch_Connect.

Implements ACE_Proactor_Impl.

create_asynch_connect_result()

ACE_Asynch_Connect_Result_Impl * ACE_WIN32_Proactor::create_asynch_connect_result ( const ACE_Handler::Proxy_Ptr & handler_proxy, ACE_HANDLE connect_handle, const void * act, ACE_HANDLE event, int priority, int signal_number = 0 )

virtual

Create the correct implementation class for ACE_Asynch_Connect::Result.

Implements ACE_Proactor_Impl.

create_asynch_read_dgram()

ACE_Asynch_Read_Dgram_Impl * ACE_WIN32_Proactor::create_asynch_read_dgram ( )

virtual

Create the correct implementation class for doing Asynch_Read_Dgram.

Implements ACE_Proactor_Impl.

create_asynch_read_dgram_result()

ACE_Asynch_Read_Dgram_Result_Impl * ACE_WIN32_Proactor::create_asynch_read_dgram_result ( const ACE_Handler::Proxy_Ptr & handler_proxy, ACE_HANDLE handle, ACE_Message_Block * message_block, size_t bytes_to_read, int flags, int protocol_family, const void * act, ACE_HANDLE event, int priority, int signal_number = 0 )

virtual

Create the correct implementation class for ACE_Asynch_Read_Dgram::Result.

Implements ACE_Proactor_Impl.

create_asynch_read_file()

ACE_Asynch_Read_File_Impl * ACE_WIN32_Proactor::create_asynch_read_file ( )

virtual

Create the correct implementation class for doing Asynch_Read_File.

Implements ACE_Proactor_Impl.

create_asynch_read_file_result()

ACE_Asynch_Read_File_Result_Impl * ACE_WIN32_Proactor::create_asynch_read_file_result ( const ACE_Handler::Proxy_Ptr & handler_proxy, ACE_HANDLE handle, ACE_Message_Block & message_block, size_t bytes_to_read, const void * act, u_long offset, u_long offset_high, ACE_HANDLE event, int priority, int signal_number = 0 )

virtual

Create the correct implementation class for ACE_Asynch_Read_File::Result.

Implements ACE_Proactor_Impl.

create_asynch_read_stream()

ACE_Asynch_Read_Stream_Impl * ACE_WIN32_Proactor::create_asynch_read_stream ( )

virtual

Create the correct implementation class for doing Asynch_Read_Stream.

Implements ACE_Proactor_Impl.

create_asynch_read_stream_result()

ACE_Asynch_Read_Stream_Result_Impl * ACE_WIN32_Proactor::create_asynch_read_stream_result ( const ACE_Handler::Proxy_Ptr & handler_proxy, ACE_HANDLE handle, ACE_Message_Block & message_block, size_t bytes_to_read, const void * act, ACE_HANDLE event, int priority, int signal_number = 0 )

virtual

Create the correct implementation class for ACE_Asynch_Read_Stream::Result class.

Implements ACE_Proactor_Impl.

create_asynch_timer()

ACE_Asynch_Result_Impl * ACE_WIN32_Proactor::create_asynch_timer ( const ACE_Handler::Proxy_Ptr & handler_proxy, const void * act, const ACE_Time_Value & tv, ACE_HANDLE event, int priority, int signal_number = 0 )

virtual

Create a timer result object which can be used with the Timer mechanism of the Proactor.

Implements ACE_Proactor_Impl.

create_asynch_transmit_file()

ACE_Asynch_Transmit_File_Impl * ACE_WIN32_Proactor::create_asynch_transmit_file ( )

virtual

Create the correct implementation class for doing Asynch_Transmit_File.

Implements ACE_Proactor_Impl.

create_asynch_transmit_file_result()

ACE_Asynch_Transmit_File_Result_Impl * ACE_WIN32_Proactor::create_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 = 0 )

virtual

Create the correct implementation class for ACE_Asynch_Transmit_File::Result.

Implements ACE_Proactor_Impl.

create_asynch_write_dgram()

ACE_Asynch_Write_Dgram_Impl * ACE_WIN32_Proactor::create_asynch_write_dgram ( )

virtual

Create the correct implementation class for doing Asynch_Write_Dgram.

Implements ACE_Proactor_Impl.

create_asynch_write_dgram_result()

ACE_Asynch_Write_Dgram_Result_Impl * ACE_WIN32_Proactor::create_asynch_write_dgram_result ( const ACE_Handler::Proxy_Ptr & handler_proxy, ACE_HANDLE handle, ACE_Message_Block * message_block, size_t bytes_to_write, int flags, const void * act, ACE_HANDLE event, int priority, int signal_number = 0 )

virtual

Create the correct implementation class for ACE_Asynch_Write_Dgram::Result.

Implements ACE_Proactor_Impl.

create_asynch_write_file()

ACE_Asynch_Write_File_Impl * ACE_WIN32_Proactor::create_asynch_write_file ( )

virtual

Create the correct implementation class for doing Asynch_Write_File.

Implements ACE_Proactor_Impl.

create_asynch_write_file_result()

ACE_Asynch_Write_File_Result_Impl * ACE_WIN32_Proactor::create_asynch_write_file_result ( const ACE_Handler::Proxy_Ptr & handler, ACE_HANDLE handle, ACE_Message_Block & message_block, size_t bytes_to_write, const void * act, u_long offset, u_long offset_high, ACE_HANDLE event, int priority, int signal_number = 0 )

virtual

Create the correct implementation class for ACE_Asynch_Write_File::Result.

Implements ACE_Proactor_Impl.

create_asynch_write_stream()

ACE_Asynch_Write_Stream_Impl * ACE_WIN32_Proactor::create_asynch_write_stream ( )

virtual

Create the correct implementation class for doing Asynch_Write_Stream.

Implements ACE_Proactor_Impl.

create_asynch_write_stream_result()

ACE_Asynch_Write_Stream_Result_Impl * ACE_WIN32_Proactor::create_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 = 0 )

virtual

Create the correct implementation class for ACE_Asynch_Write_Stream::Result.

Implements ACE_Proactor_Impl.

get_asynch_pseudo_task()

ACE_Asynch_Pseudo_Task & ACE_WIN32_Proactor::get_asynch_pseudo_task ( )

protected

Task to process pseudo-asynchronous operations.

get_handle()

ACE_HANDLE ACE_WIN32_Proactor::get_handle ( ) const

virtual

Get the event handle.

Implements ACE_Proactor_Impl.

handle_close()

int ACE_WIN32_Proactor::handle_close ( ACE_HANDLE handle, ACE_Reactor_Mask close_mask )

protectedvirtual

Called when object is removed from the ACE_Reactor.

Reimplemented from ACE_Event_Handler.

handle_events() [1/3]

int ACE_WIN32_Proactor::handle_events ( )

virtual

Block indefinitely until at least one event is dispatched. Dispatch a single set of events. Return 1 on success i.e., when a completion is dispatched, non-zero (-1) on errors and errno is set accordingly.

Implements ACE_Proactor_Impl.

handle_events() [2/3]

int ACE_WIN32_Proactor::handle_events ( ACE_Time_Value & wait_time )

virtual

Dispatch a single set of events. If wait_time elapses before any events occur, return 0. Return 1 on success i.e., when a completion is dispatched, non-zero (-1) on errors and errno is set accordingly.

Implements ACE_Proactor_Impl.

handle_events() [3/3]

int ACE_WIN32_Proactor::handle_events ( unsigned long milli_seconds )

protectedvirtual

Dispatch a single set of events. If milli_seconds elapses before any events occur, return 0. Return 1 if a completion is dispatched. Return -1 on errors.

handle_signal()

int ACE_WIN32_Proactor::handle_signal ( int signum, siginfo_t * = 0, ucontext_t * = 0 )

protectedvirtual

Called when object is signaled by OS (either via UNIX signals or when a Win32 object becomes signaled).

Reimplemented from ACE_Event_Handler.

number_of_threads() [1/2]

size_t ACE_WIN32_Proactor::number_of_threads ( ) const

virtual

Get number of thread used as a parameter to CreateIoCompletionPort.

Implements ACE_Proactor_Impl.

number_of_threads() [2/2]

void ACE_WIN32_Proactor::number_of_threads ( size_t threads )

virtual

Set number of thread used as a parameter to CreateIoCompletionPort.

Implements ACE_Proactor_Impl.

post_completion()

int ACE_WIN32_Proactor::post_completion ( ACE_WIN32_Asynch_Result * result )

virtual

Post a result to the completion port of the Proactor. If errors occur, the result will be deleted by this method. If successful, the result will be deleted by the Proactor when the result is removed from the completion port. Therefore, the result should have been dynamically allocated and should be orphaned by the user once this method is called.

post_wakeup_completions()

int ACE_WIN32_Proactor::post_wakeup_completions ( int how_many )

protectedvirtual

Post how_many completions to the completion port so that all threads can wake up. This is used in conjunction with the run_event_loop().

Implements ACE_Proactor_Impl.

register_handle()

int ACE_WIN32_Proactor::register_handle ( ACE_HANDLE handle, const void * completion_key )

virtual

This method adds the handle to the I/O completion port. This function is a no-op function for Unix systems.

Implements ACE_Proactor_Impl.

wake_up_dispatch_threads()

int ACE_WIN32_Proactor::wake_up_dispatch_threads ( )

virtual

Add wakeup dispatch threads (reinit).

Implements ACE_Proactor_Impl.

Friends And Related Symbol Documentation

ACE_WIN32_Asynch_Connect

friend class ACE_WIN32_Asynch_Connect

friend

Member Data Documentation

completion_port_

ACE_HANDLE ACE_WIN32_Proactor::completion_port_

protected

Handle for the completion port. Unix doesnt have completion ports.

event_

ACE_Auto_Event ACE_WIN32_Proactor::event_

protected

integrate the event loops of Reactor and the Proactor.

This event is used in conjunction with Reactor when we try to

number_of_threads_

DWORD ACE_WIN32_Proactor::number_of_threads_

protected

This number is passed to the CreateIOCompletionPort system call.

pseudo_task_

ACE_Asynch_Pseudo_Task ACE_WIN32_Proactor::pseudo_task_

protected

Pseudo-task for asynch connect ( NT/2000) In future should removed in XP with ConnectEx support

used_with_reactor_event_loop_

bool const ACE_WIN32_Proactor::used_with_reactor_event_loop_

protected

Flag that indicates whether we are used in conjunction with Reactor.

wakeup_handler_

ACE_Handler ACE_WIN32_Proactor::wakeup_handler_

protected

Handler to handle the wakeups. This works in conjunction with the ACE_Proactor::run_event_loop().

---

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

• WIN32_Proactor.h
• WIN32_Proactor.cpp