ACE  6.4.0
Public Member Functions | List of all members
ACE_Proactor_Impl Class Referenceabstract

A manager for asynchronous event demultiplexing. This class is the base class for all the concrete implementation classes. More...

#include <Proactor_Impl.h>

Inheritance diagram for ACE_Proactor_Impl:
Inheritance graph
[legend]
Collaboration diagram for ACE_Proactor_Impl:
Collaboration graph
[legend]

Public Member Functions

virtual ~ACE_Proactor_Impl (void)
 Virtual destruction. More...
 
virtual int close (void)=0
 Close the IO completion port. More...
 
virtual int register_handle (ACE_HANDLE handle, const void *completion_key)=0
 
virtual int handle_events (ACE_Time_Value &wait_time)=0
 
virtual int handle_events (void)=0
 
virtual int wake_up_dispatch_threads (void)=0
 Add wakeup dispatch threads (reinit). More...
 
virtual int close_dispatch_threads (int wait)=0
 Close all dispatch threads. More...
 
virtual size_t number_of_threads (void) const =0
 Get number of thread used as a parameter to CreatIoCompletionPort. More...
 
virtual void number_of_threads (size_t threads)=0
 Set number of thread used as a parameter to CreatIoCompletionPort. More...
 
virtual ACE_HANDLE get_handle (void) const =0
 Get the event handle. More...
 
virtual ACE_Asynch_Read_Stream_Implcreate_asynch_read_stream (void)=0
 Create the correct implementation class for doing Asynch_Read_Stream. More...
 
virtual ACE_Asynch_Write_Stream_Implcreate_asynch_write_stream (void)=0
 Create the correct implementation class for doing Asynch_Write_Stream. More...
 
virtual ACE_Asynch_Read_File_Implcreate_asynch_read_file (void)=0
 Create the correct implementation class for doing Asynch_Read_File. More...
 
virtual ACE_Asynch_Write_File_Implcreate_asynch_write_file (void)=0
 Create the correct implementation class for doing Asynch_Write_File. More...
 
virtual ACE_Asynch_Accept_Implcreate_asynch_accept (void)=0
 Create the correct implementation class for doing Asynch_Accept. More...
 
virtual ACE_Asynch_Connect_Implcreate_asynch_connect (void)=0
 Create the correct implementation class for doing Asynch_Connect. More...
 
virtual ACE_Asynch_Transmit_File_Implcreate_asynch_transmit_file (void)=0
 Create the correct implementation class for doing Asynch_Transmit_File. More...
 
virtual ACE_Asynch_Read_Dgram_Implcreate_asynch_read_dgram (void)=0
 
virtual ACE_Asynch_Write_Dgram_Implcreate_asynch_write_dgram (void)=0
 
virtual ACE_Asynch_Read_Stream_Result_Implcreate_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=ACE_INVALID_HANDLE, int priority=0, int signal_number=ACE_SIGRTMIN)=0
 Create the correct implementation class for ACE_Asynch_Read_Stream::Result class. More...
 
virtual ACE_Asynch_Write_Stream_Result_Implcreate_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=ACE_INVALID_HANDLE, int priority=0, int signal_number=ACE_SIGRTMIN)=0
 Create the correct implementation class for ACE_Asynch_Write_Stream::Result. More...
 
virtual ACE_Asynch_Read_File_Result_Implcreate_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=ACE_INVALID_HANDLE, int priority=0, int signal_number=ACE_SIGRTMIN)=0
 Create the correct implementation class for ACE_Asynch_Read_File::Result. More...
 
virtual ACE_Asynch_Write_File_Result_Implcreate_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=ACE_INVALID_HANDLE, int priority=0, int signal_number=ACE_SIGRTMIN)=0
 Create the correct implementation class for ACE_Asynch_Write_File::Result. More...
 
virtual ACE_Asynch_Read_Dgram_Result_Implcreate_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=ACE_INVALID_HANDLE, int priority=0, int signal_number=ACE_SIGRTMIN)=0
 Create the correct implementation class for ACE_Asynch_Read_Dgram::Result. More...
 
virtual ACE_Asynch_Write_Dgram_Result_Implcreate_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=ACE_INVALID_HANDLE, int priority=0, int signal_number=ACE_SIGRTMIN)=0
 Create the correct implementation class for ACE_Asynch_Write_Dgram::Result. More...
 
virtual ACE_Asynch_Accept_Result_Implcreate_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=ACE_INVALID_HANDLE, int priority=0, int signal_number=ACE_SIGRTMIN)=0
 Create the correct implementation class for ACE_Asynch_Accept::Result. More...
 
virtual ACE_Asynch_Connect_Result_Implcreate_asynch_connect_result (const ACE_Handler::Proxy_Ptr &handler_proxy, ACE_HANDLE connect_handle, const void *act, ACE_HANDLE event=ACE_INVALID_HANDLE, int priority=0, int signal_number=ACE_SIGRTMIN)=0
 Create the correct implementation class for ACE_Asynch_Connect::Result. More...
 
virtual ACE_Asynch_Transmit_File_Result_Implcreate_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=ACE_INVALID_HANDLE, int priority=0, int signal_number=ACE_SIGRTMIN)=0
 Create the correct implementation class for ACE_Asynch_Transmit_File::Result. More...
 
virtual ACE_Asynch_Result_Implcreate_asynch_timer (const ACE_Handler::Proxy_Ptr &handler_proxy, const void *act, const ACE_Time_Value &tv, ACE_HANDLE event=ACE_INVALID_HANDLE, int priority=0, int signal_number=0)=0
 
virtual int post_wakeup_completions (int how_many)=0
 
- Public Member Functions inherited from ACE_Event_Handler
virtual ~ACE_Event_Handler (void)
 Destructor is virtual to enable proper cleanup. More...
 
virtual void set_handle (ACE_HANDLE)
 Set the I/O handle. More...
 
virtual int priority (void) const
 
virtual void priority (int priority)
 Set the priority of the Event_Handler. More...
 
virtual int handle_input (ACE_HANDLE fd=ACE_INVALID_HANDLE)
 Called when input events occur (e.g., connection or data). More...
 
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). More...
 
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. More...
 
virtual int handle_close (ACE_HANDLE handle, ACE_Reactor_Mask close_mask)
 
virtual int handle_signal (int signum, siginfo_t *=0, ucontext_t *=0)
 
virtual int resume_handler (void)
 
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. More...
 
virtual ACE_Reactorreactor (void) const
 Get the event demultiplexors. More...
 
virtual ACE_Reactor_Timer_Interfacereactor_timer_interface (void) const
 Get only the reactor's timer related interface. More...
 
virtual Reference_Count add_reference (void)
 Increment reference count on the handler. More...
 
virtual Reference_Count remove_reference (void)
 Decrement reference count on the handler. More...
 
Reference_Counting_Policyreference_counting_policy (void)
 Current Reference_Counting_Policy. More...
 

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. More...
 
- 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. More...
 
- Protected Types inherited from ACE_Event_Handler
typedef ACE_Atomic_Op< ACE_SYNCH_MUTEX, Reference_CountAtomic_Reference_Count
 Typedef for implementation of reference counting. More...
 
- Protected Member Functions inherited from ACE_Event_Handler
 ACE_Event_Handler (ACE_Reactor *=0, int priority=ACE_Event_Handler::LO_PRIORITY)
 Force ACE_Event_Handler to be an abstract base class. More...
 
- Protected Attributes inherited from ACE_Event_Handler
Atomic_Reference_Count reference_count_
 Reference count. More...
 

Detailed Description

A manager for asynchronous event demultiplexing. This class is the base class for all the concrete implementation classes.

See the Proactor pattern description at http://www.cs.wustl.edu/~schmidt/proactor.ps.gz for more details.

Constructor & Destructor Documentation

ACE_Proactor_Impl::~ACE_Proactor_Impl ( void  )
virtual

Virtual destruction.

Member Function Documentation

virtual int ACE_Proactor_Impl::close ( void  )
pure virtual

Close the IO completion port.

Implemented in ACE_POSIX_AIOCB_Proactor, ACE_POSIX_Proactor, and ACE_WIN32_Proactor.

virtual int ACE_Proactor_Impl::close_dispatch_threads ( int  wait)
pure virtual

Close all dispatch threads.

Implemented in ACE_POSIX_Proactor, and ACE_WIN32_Proactor.

virtual ACE_Asynch_Accept_Impl* ACE_Proactor_Impl::create_asynch_accept ( void  )
pure virtual

Create the correct implementation class for doing Asynch_Accept.

Implemented in ACE_POSIX_Proactor, and ACE_WIN32_Proactor.

virtual ACE_Asynch_Accept_Result_Impl* ACE_Proactor_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 = ACE_INVALID_HANDLE,
int  priority = 0,
int  signal_number = ACE_SIGRTMIN 
)
pure virtual

Create the correct implementation class for ACE_Asynch_Accept::Result.

Implemented in ACE_POSIX_Proactor, and ACE_WIN32_Proactor.

virtual ACE_Asynch_Connect_Impl* ACE_Proactor_Impl::create_asynch_connect ( void  )
pure virtual

Create the correct implementation class for doing Asynch_Connect.

Implemented in ACE_POSIX_Proactor, and ACE_WIN32_Proactor.

virtual ACE_Asynch_Connect_Result_Impl* ACE_Proactor_Impl::create_asynch_connect_result ( const ACE_Handler::Proxy_Ptr handler_proxy,
ACE_HANDLE  connect_handle,
const void *  act,
ACE_HANDLE  event = ACE_INVALID_HANDLE,
int  priority = 0,
int  signal_number = ACE_SIGRTMIN 
)
pure virtual

Create the correct implementation class for ACE_Asynch_Connect::Result.

Implemented in ACE_POSIX_Proactor, and ACE_WIN32_Proactor.

virtual ACE_Asynch_Read_Dgram_Impl* ACE_Proactor_Impl::create_asynch_read_dgram ( void  )
pure virtual

Create the correct implementation class for doing Asynch_Read_Dgram.

Implemented in ACE_POSIX_Proactor, and ACE_WIN32_Proactor.

virtual ACE_Asynch_Read_Dgram_Result_Impl* ACE_Proactor_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 = ACE_INVALID_HANDLE,
int  priority = 0,
int  signal_number = ACE_SIGRTMIN 
)
pure virtual

Create the correct implementation class for ACE_Asynch_Read_Dgram::Result.

Implemented in ACE_POSIX_Proactor, and ACE_WIN32_Proactor.

virtual ACE_Asynch_Read_File_Impl* ACE_Proactor_Impl::create_asynch_read_file ( void  )
pure virtual

Create the correct implementation class for doing Asynch_Read_File.

Implemented in ACE_POSIX_Proactor, and ACE_WIN32_Proactor.

virtual ACE_Asynch_Read_File_Result_Impl* ACE_Proactor_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 = ACE_INVALID_HANDLE,
int  priority = 0,
int  signal_number = ACE_SIGRTMIN 
)
pure virtual

Create the correct implementation class for ACE_Asynch_Read_File::Result.

Implemented in ACE_POSIX_Proactor, and ACE_WIN32_Proactor.

virtual ACE_Asynch_Read_Stream_Impl* ACE_Proactor_Impl::create_asynch_read_stream ( void  )
pure virtual

Create the correct implementation class for doing Asynch_Read_Stream.

Implemented in ACE_POSIX_Proactor, and ACE_WIN32_Proactor.

virtual ACE_Asynch_Read_Stream_Result_Impl* ACE_Proactor_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 = ACE_INVALID_HANDLE,
int  priority = 0,
int  signal_number = ACE_SIGRTMIN 
)
pure virtual

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

Implemented in ACE_POSIX_Proactor, and ACE_WIN32_Proactor.

virtual ACE_Asynch_Result_Impl* ACE_Proactor_Impl::create_asynch_timer ( const ACE_Handler::Proxy_Ptr handler_proxy,
const void *  act,
const ACE_Time_Value tv,
ACE_HANDLE  event = ACE_INVALID_HANDLE,
int  priority = 0,
int  signal_number = 0 
)
pure virtual

Create the correct implementation object for the Timer result. POSIX_SIG_Proactor will create a Timer object with a meaningful signal number, if you leave the signal number as 0.

Implemented in ACE_POSIX_Proactor, and ACE_WIN32_Proactor.

virtual ACE_Asynch_Transmit_File_Impl* ACE_Proactor_Impl::create_asynch_transmit_file ( void  )
pure virtual

Create the correct implementation class for doing Asynch_Transmit_File.

Implemented in ACE_POSIX_Proactor, and ACE_WIN32_Proactor.

virtual ACE_Asynch_Transmit_File_Result_Impl* ACE_Proactor_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 = ACE_INVALID_HANDLE,
int  priority = 0,
int  signal_number = ACE_SIGRTMIN 
)
pure virtual

Create the correct implementation class for ACE_Asynch_Transmit_File::Result.

Implemented in ACE_POSIX_Proactor, and ACE_WIN32_Proactor.

virtual ACE_Asynch_Write_Dgram_Impl* ACE_Proactor_Impl::create_asynch_write_dgram ( void  )
pure virtual

Create the correct implementation class for doing Asynch_Write_Dgram.

Implemented in ACE_POSIX_Proactor, and ACE_WIN32_Proactor.

virtual ACE_Asynch_Write_Dgram_Result_Impl* ACE_Proactor_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 = ACE_INVALID_HANDLE,
int  priority = 0,
int  signal_number = ACE_SIGRTMIN 
)
pure virtual

Create the correct implementation class for ACE_Asynch_Write_Dgram::Result.

Implemented in ACE_POSIX_Proactor, and ACE_WIN32_Proactor.

virtual ACE_Asynch_Write_File_Impl* ACE_Proactor_Impl::create_asynch_write_file ( void  )
pure virtual

Create the correct implementation class for doing Asynch_Write_File.

Implemented in ACE_POSIX_Proactor, and ACE_WIN32_Proactor.

virtual ACE_Asynch_Write_File_Result_Impl* ACE_Proactor_Impl::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 = ACE_INVALID_HANDLE,
int  priority = 0,
int  signal_number = ACE_SIGRTMIN 
)
pure virtual

Create the correct implementation class for ACE_Asynch_Write_File::Result.

Implemented in ACE_POSIX_Proactor, and ACE_WIN32_Proactor.

virtual ACE_Asynch_Write_Stream_Impl* ACE_Proactor_Impl::create_asynch_write_stream ( void  )
pure virtual

Create the correct implementation class for doing Asynch_Write_Stream.

Implemented in ACE_POSIX_Proactor, and ACE_WIN32_Proactor.

virtual ACE_Asynch_Write_Stream_Result_Impl* ACE_Proactor_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 = ACE_INVALID_HANDLE,
int  priority = 0,
int  signal_number = ACE_SIGRTMIN 
)
pure virtual

Create the correct implementation class for ACE_Asynch_Write_Stream::Result.

Implemented in ACE_POSIX_Proactor, and ACE_WIN32_Proactor.

virtual ACE_HANDLE ACE_Proactor_Impl::get_handle ( void  ) const
pure virtual

Get the event handle.

Reimplemented from ACE_Event_Handler.

Implemented in ACE_POSIX_Proactor, and ACE_WIN32_Proactor.

virtual int ACE_Proactor_Impl::handle_events ( ACE_Time_Value wait_time)
pure 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.

Implemented in ACE_POSIX_AIOCB_Proactor, ACE_POSIX_Proactor, ACE_WIN32_Proactor, and ACE_POSIX_CB_Proactor.

virtual int ACE_Proactor_Impl::handle_events ( void  )
pure virtual

Block indefinitely until at least one event is dispatched. 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.

Implemented in ACE_POSIX_AIOCB_Proactor, ACE_POSIX_Proactor, ACE_WIN32_Proactor, and ACE_POSIX_CB_Proactor.

virtual size_t ACE_Proactor_Impl::number_of_threads ( void  ) const
pure virtual

Get number of thread used as a parameter to CreatIoCompletionPort.

Implemented in ACE_POSIX_Proactor, and ACE_WIN32_Proactor.

virtual void ACE_Proactor_Impl::number_of_threads ( size_t  threads)
pure virtual

Set number of thread used as a parameter to CreatIoCompletionPort.

Implemented in ACE_POSIX_Proactor, and ACE_WIN32_Proactor.

virtual int ACE_Proactor_Impl::post_wakeup_completions ( int  how_many)
pure virtual

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

Implemented in ACE_POSIX_Proactor, and ACE_WIN32_Proactor.

virtual int ACE_Proactor_Impl::register_handle ( ACE_HANDLE  handle,
const void *  completion_key 
)
pure virtual

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

Implemented in ACE_POSIX_Proactor, and ACE_WIN32_Proactor.

virtual int ACE_Proactor_Impl::wake_up_dispatch_threads ( void  )
pure virtual

Add wakeup dispatch threads (reinit).

Implemented in ACE_POSIX_Proactor, and ACE_WIN32_Proactor.


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