NAME
ACE_WIN32_Proactor - A manager for asynchronous event demultiplexing.
SYNOPSIS
#include <ace/WIN_Proactor.h>
class ACE_WIN32_Proactor : public ACE_Proactor_Impl
{
public:
ACE_WIN32_Proactor (
size_t number_of_threads = 0,
int used_with_reactor_event_loop = 0
);
virtual ~ACE_WIN32_Proactor (void);
virtual int close (void);
virtual int register_handle (
ACE_HANDLE handle,
const void *completion_key
);
virtual int handle_events (ACE_Time_Value &wait_time);
virtual int handle_events (void);
virtual int post_completion (ACE_WIN32_Asynch_Result *result);
int wake_up_dispatch_threads (void);
int close_dispatch_threads (int wait);
size_t number_of_threads (void) const;
void number_of_threads (size_t threads);
virtual ACE_HANDLE get_handle (void) const;
virtual ACE_Asynch_Read_Stream_Impl *create_asynch_read_stream (
void
);
virtual ACE_Asynch_Write_Stream_Impl *create_asynch_write_stream (
void
);
virtual ACE_Asynch_Read_File_Impl *create_asynch_read_file (void);
virtual ACE_Asynch_Write_File_Impl *create_asynch_write_file (
void
);
virtual ACE_Asynch_Accept_Impl *create_asynch_accept (void);
virtual ACE_Asynch_Transmit_File_Impl *create_asynch_transmit_file (
void
);
virtual ACE_Asynch_Read_Stream_Result_Impl *create_asynch_read_stream_result (
ACE_Handler &handler,
ACE_HANDLE handle,
ACE_Message_Block &message_block,
u_long bytes_to_read,
const void* act,
ACE_HANDLE event,
int priority,
int signal_number = 0
);
virtual ACE_Asynch_Write_Stream_Result_Impl *create_asynch_write_stream_result (
ACE_Handler &handler,
ACE_HANDLE handle,
ACE_Message_Block &message_block,
u_long bytes_to_write,
const void* act,
ACE_HANDLE event,
int priority,
int signal_number = 0
);
virtual ACE_Asynch_Read_File_Result_Impl *create_asynch_read_file_result (
ACE_Handler &handler,
ACE_HANDLE handle,
ACE_Message_Block &message_block,
u_long bytes_to_read,
const void* act,
u_long offset,
u_long offset_high,
ACE_HANDLE event,
int priority,
int signal_number = 0
);
virtual ACE_Asynch_Write_File_Result_Impl *create_asynch_write_file_result (
ACE_Handler &handler,
ACE_HANDLE handle,
ACE_Message_Block &message_block,
u_long bytes_to_write,
const void* act,
u_long offset,
u_long offset_high,
ACE_HANDLE event,
int priority,
int signal_number = 0
);
virtual ACE_Asynch_Accept_Result_Impl *create_asynch_accept_result (
ACE_Handler &handler,
ACE_HANDLE listen_handle,
ACE_HANDLE accept_handle,
ACE_Message_Block &message_block,
u_long bytes_to_read,
const void* act,
ACE_HANDLE event,
int priority,
int signal_number = 0
);
virtual ACE_Asynch_Transmit_File_Result_Impl *create_asynch_transmit_file_result (
ACE_Handler &handler,
ACE_HANDLE socket,
ACE_HANDLE file,
ACE_Asynch_Transmit_File::Header_And_Trailer *header_and_trailer,
u_long bytes_to_write,
u_long offset,
u_long offset_high,
u_long bytes_per_send,
u_long flags,
const void *act,
ACE_HANDLE event,
int priority,
int signal_number = 0
);
virtual ACE_Asynch_Result_Impl *create_asynch_timer (
ACE_Handler &handler,
const void *act,
const ACE_Time_Value &tv,
ACE_HANDLE event,
int priority,
int signal_number = 0
);
protected:
virtual int handle_signal (
int signum,
siginfo_t * = 0,
ucontext_t * = 0
);
virtual int handle_close (
ACE_HANDLE handle,
ACE_Reactor_Mask close_mask
);
virtual int handle_events (unsigned long milli_seconds);
void application_specific_code (
ACE_WIN32_Asynch_Result *asynch_result,
u_long bytes_transferred,
int success,
const void *completion_key,
u_long error
);
virtual int post_wakeup_completions (int how_many);
ACE_HANDLE completion_port_;
size_t number_of_threads_;
ACE_Auto_Event event_;
int used_with_reactor_event_loop_;
ACE_Handler wakeup_handler_;
};
DESCRIPTION
See the Proactor pattern description at http://www.cs.wustl.edu/~schmidt/proactor.ps.gz for more details.
PUBLIC MEMBERS
ACE_WIN32_Proactor (
size_t number_of_threads = 0,
int used_with_reactor_event_loop = 0
);
A do nothing constructor.
virtual ~ACE_WIN32_Proactor (void);
Virtual destruction.
virtual int close (void);
Close the IO completion port.
virtual int register_handle (
ACE_HANDLE handle,
const void *completion_key
);
This method adds the handle to the I/O completion port. This function is a no-op function for Unix systems.
virtual int handle_events (ACE_Time_Value &wait_time);
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.
virtual int handle_events (void);
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.
virtual int post_completion (ACE_WIN32_Asynch_Result *result);
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.
int wake_up_dispatch_threads (void);
Add wakeup dispatch threads (reinit).
int close_dispatch_threads (int wait);
Close all dispatch threads.
size_t number_of_threads (void) const;
void number_of_threads (size_t threads);
Number of thread used as a parameter to CreatIoCompletionPort.
virtual ACE_HANDLE get_handle (void) const;
Get the event handle.
virtual ACE_Asynch_Read_Stream_Impl *create_asynch_read_stream (void);
virtual ACE_Asynch_Write_Stream_Impl *create_asynch_write_stream (
void
);
virtual ACE_Asynch_Read_File_Impl *create_asynch_read_file (void);
virtual ACE_Asynch_Write_File_Impl *create_asynch_write_file (void);
virtual ACE_Asynch_Accept_Impl *create_asynch_accept (void);
virtual ACE_Asynch_Transmit_File_Impl *create_asynch_transmit_file (
void
);
virtual ACE_Asynch_Read_Stream_Result_Impl *create_asynch_read_stream_result (
ACE_Handler &handler,
ACE_HANDLE handle,
ACE_Message_Block &message_block,
u_long bytes_to_read,
const void* act,
ACE_HANDLE event,
int priority,
int signal_number = 0
);
virtual ACE_Asynch_Write_Stream_Result_Impl *create_asynch_write_stream_result (
ACE_Handler &handler,
ACE_HANDLE handle,
ACE_Message_Block &message_block,
u_long bytes_to_write,
const void* act,
ACE_HANDLE event,
int priority,
int signal_number = 0
);
virtual ACE_Asynch_Read_File_Result_Impl *create_asynch_read_file_result (
ACE_Handler &handler,
ACE_HANDLE handle,
ACE_Message_Block &message_block,
u_long bytes_to_read,
const void* act,
u_long offset,
u_long offset_high,
ACE_HANDLE event,
int priority,
int signal_number = 0
);
virtual ACE_Asynch_Write_File_Result_Impl *create_asynch_write_file_result (
ACE_Handler &handler,
ACE_HANDLE handle,
ACE_Message_Block &message_block,
u_long bytes_to_write,
const void* act,
u_long offset,
u_long offset_high,
ACE_HANDLE event,
int priority,
int signal_number = 0
);
virtual ACE_Asynch_Accept_Result_Impl *create_asynch_accept_result (
ACE_Handler &handler,
ACE_HANDLE listen_handle,
ACE_HANDLE accept_handle,
ACE_Message_Block &message_block,
u_long bytes_to_read,
const void* act,
ACE_HANDLE event,
int priority,
int signal_number = 0
);
virtual ACE_Asynch_Transmit_File_Result_Impl *create_asynch_transmit_file_result (
ACE_Handler &handler,
ACE_HANDLE socket,
ACE_HANDLE file,
ACE_Asynch_Transmit_File::Header_And_Trailer *header_and_trailer,
u_long bytes_to_write,
u_long offset,
u_long offset_high,
u_long bytes_per_send,
u_long flags,
const void *act,
ACE_HANDLE event,
int priority,
int signal_number = 0
);
virtual ACE_Asynch_Result_Impl *create_asynch_timer (
ACE_Handler &handler,
const void *act,
const ACE_Time_Value &tv,
ACE_HANDLE event,
int priority,
int signal_number = 0
);
Create a timer result object which can be used with the Timer mechanism of the Proactor.
PROTECTED MEMBERS
virtual int handle_signal (
int signum,
siginfo_t * = 0,
ucontext_t * = 0
);
Called when object is signaled by OS (either via UNIX signals or when a Win32 object becomes signaled).
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);
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.
void application_specific_code (
ACE_WIN32_Asynch_Result *asynch_result,
u_long bytes_transferred,
int success,
const void *completion_key,
u_long error
);
Protect against structured exceptions caused by user code when dispatching handles.
virtual int post_wakeup_completions (int how_many);
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.
ACE_HANDLE completion_port_;
Handle for the completion port. Unix doesnt have completion ports.
size_t number_of_threads_;
This number is passed to the CreatIOCompletionPort system call.
ACE_Auto_Event event_;
This event is used in conjunction with Reactor when we try to integrate the event loops of Reactor and the Proactor.
int used_with_reactor_event_loop_;
Flag that indicates whether we are used in conjunction with Reactor.
ACE_Handler wakeup_handler_;
Handler to handle the wakeups. This works in conjunction with the ACE_Proactor::run_event_loop.
AUTHOR
Irfan Pyarali ([email protected]), Tim Harrison ([email protected]) and Alexander Babu Arulanthu [email protected]
LIBRARY
ace