|
ACE
6.3.3
|
Generic factory for actively connecting clients and creating service handlers (SVC_HANDLERs). More...
#include <Connector.h>
Public Types | |
| typedef SVC_HANDLER::addr_type | addr_type |
| typedef PEER_CONNECTOR | connector_type |
| typedef SVC_HANDLER | handler_type |
| typedef SVC_HANDLER::stream_type | stream_type |
| typedef PEER_CONNECTOR::PEER_ADDR | peer_addr_type |
| typedef PEER_CONNECTOR::PEER_ADDR | PEER_ADDR_TYPEDEF |
 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... | |
Public Member Functions | |
| ACE_Connector (ACE_Reactor *r=ACE_Reactor::instance(), int flags=0) | |
| virtual int | open (ACE_Reactor *r=ACE_Reactor::instance(), int flags=0) |
| virtual | ~ACE_Connector (void) |
| Shutdown a connector and release resources. More... | |
| virtual int | connect (SVC_HANDLER *&svc_handler, const typename PEER_CONNECTOR::PEER_ADDR &remote_addr, const ACE_Synch_Options &synch_options=ACE_Synch_Options::defaults, const typename PEER_CONNECTOR::PEER_ADDR &local_addr=reinterpret_cast< const peer_addr_type & >(peer_addr_type::sap_any), int reuse_addr=0, int flags=O_RDWR, int perms=0) |
| virtual int | connect (SVC_HANDLER *&svc_handler_hint, SVC_HANDLER *&svc_handler, const typename PEER_CONNECTOR::PEER_ADDR &remote_addr, const ACE_Synch_Options &synch_options=ACE_Synch_Options::defaults, const typename PEER_CONNECTOR::PEER_ADDR &local_addr=reinterpret_cast< const peer_addr_type & >(peer_addr_type::sap_any), int reuse_addr=0, int flags=O_RDWR, int perms=0) |
| virtual int | connect_n (size_t n, SVC_HANDLER *svc_handlers[], typename PEER_CONNECTOR::PEER_ADDR remote_addrs[], ACE_TCHAR *failed_svc_handlers=0, const ACE_Synch_Options &synch_options=ACE_Synch_Options::defaults) |
| virtual int | cancel (SVC_HANDLER *svc_handler) |
| virtual int | close (void) |
| virtual PEER_CONNECTOR & | connector (void) const |
| Return the underlying PEER_CONNECTOR object. More... | |
| virtual void | initialize_svc_handler (ACE_HANDLE handle, SVC_HANDLER *svc_handler) |
| Initialize Svc_Handler. More... | |
| virtual void | reactor (ACE_Reactor *reactor) |
| Set Reactor. More... | |
| virtual ACE_Reactor * | reactor (void) const |
| Get Reactor. More... | |
| void | dump (void) const |
| Dump the state of an object. More... | |
| Public Member Functions inherited from ACE_Connector_Base< SVC_HANDLER > | |
| virtual | ~ACE_Connector_Base (void) |
| Public Member Functions inherited from ACE_Service_Object | |
| ACE_Service_Object (ACE_Reactor *=0) | |
| Constructor. More... | |
| virtual | ~ACE_Service_Object (void) |
| Destructor. More... | |
| Public Member Functions inherited from ACE_Event_Handler | |
| virtual | ~ACE_Event_Handler (void) |
| Destructor is virtual to enable proper cleanup. More... | |
| virtual ACE_HANDLE | get_handle (void) const |
| Get the I/O handle. 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 ¤t_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 ACE_Reactor_Timer_Interface * | reactor_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_Policy & | reference_counting_policy (void) |
| Current Reference_Counting_Policy. More... | |
| Public Member Functions inherited from ACE_Shared_Object | |
| ACE_Shared_Object (void) | |
| Constructor. More... | |
| virtual | ~ACE_Shared_Object (void) |
| Destructor. More... | |
Public Attributes | |
| ACE_ALLOC_HOOK_DECLARE | |
| Declare the dynamic allocation hooks. More... | |
Protected Types | |
| typedef ACE_NonBlocking_Connect_Handler< SVC_HANDLER > | NBCH |
| Protected Types inherited from ACE_Event_Handler | |
| typedef ACE_Atomic_Op< ACE_SYNCH_MUTEX, Reference_Count > | Atomic_Reference_Count |
| Typedef for implementation of reference counting. More... | |
Protected Member Functions | |
| virtual int | make_svc_handler (SVC_HANDLER *&sh) |
| virtual int | connect_svc_handler (SVC_HANDLER *&svc_handler, const typename PEER_CONNECTOR::PEER_ADDR &remote_addr, ACE_Time_Value *timeout, const typename PEER_CONNECTOR::PEER_ADDR &local_addr, int reuse_addr, int flags, int perms) |
| virtual int | connect_svc_handler (SVC_HANDLER *&svc_handler, SVC_HANDLER *&sh_copy, const typename PEER_CONNECTOR::PEER_ADDR &remote_addr, ACE_Time_Value *timeout, const typename PEER_CONNECTOR::PEER_ADDR &local_addr, int reuse_addr, int flags, int perms) |
| virtual int | activate_svc_handler (SVC_HANDLER *svc_handler) |
| int | nonblocking_connect (SVC_HANDLER *, const ACE_Synch_Options &) |
| Creates and registers ACE_NonBlocking_Connect_Handler. More... | |
| virtual int | connect_i (SVC_HANDLER *&svc_handler, SVC_HANDLER **sh_copy, const typename PEER_CONNECTOR::PEER_ADDR &remote_addr, const ACE_Synch_Options &synch_options, const typename PEER_CONNECTOR::PEER_ADDR &local_addr, int reuse_addr, int flags, int perms) |
| Implementation of the connect methods. More... | |
| ACE_Unbounded_Set< ACE_HANDLE > & | non_blocking_handles (void) |
| virtual int | init (int argc, ACE_TCHAR *argv[]) |
| virtual int | fini (void) |
| Calls handle_close() to shutdown the Connector gracefully. More... | |
| virtual int | info (ACE_TCHAR **strp, size_t length) const |
| Default version returns address info in buf. More... | |
| virtual int | suspend (void) |
| virtual int | resume (void) |
| 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... | |
Private Attributes | |
| PEER_CONNECTOR | connector_ |
| This is the peer connector factory. More... | |
| int | flags_ |
| ACE_Reactor * | reactor_ |
| Pointer to the Reactor. More... | |
| ACE_Unbounded_Set< ACE_HANDLE > | non_blocking_handles_ |
| Handle set representing the non-blocking connects in progress. More... | |
Additional Inherited Members | |
| 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 Attributes inherited from ACE_Event_Handler | |
| Atomic_Reference_Count | reference_count_ |
| Reference count. More... | |
Generic factory for actively connecting clients and creating service handlers (SVC_HANDLERs).
Implements the strategy for actively establishing connections with clients. Both blocking and non-blocking connects are supported. Moreover, non-blocking connects support timeouts.
An ACE_Connector is parameterized by concrete types that conform to the interfaces of SVC_HANDLER and PEER_CONNECTOR described below.
| SVC_HANDLER | The name of the concrete type that performs the application-specific service. The SVC_HANDLER typically inherits from ACE_Svc_Handler. |
| PEER_CONNECTOR | The name of the class that implements the PEER_CONNECTOR endpoint (e.g., ACE_SOCK_Connector) to passively establish connections. A PEER_CONNECTOR implementation must provide a PEER_STREAM and PEER_ADDR trait to identify the type of stream (e.g., ACE_SOCK_Stream) and type of address (e.g., ACE_INET_Addr) used by the endpoint. |
| typedef SVC_HANDLER::addr_type ACE_Connector< SVC_HANDLER, PEER_CONNECTOR >::addr_type |
| typedef PEER_CONNECTOR ACE_Connector< SVC_HANDLER, PEER_CONNECTOR >::connector_type |
| typedef SVC_HANDLER ACE_Connector< SVC_HANDLER, PEER_CONNECTOR >::handler_type |
|
protected |
| typedef PEER_CONNECTOR::PEER_ADDR ACE_Connector< SVC_HANDLER, PEER_CONNECTOR >::peer_addr_type |
| typedef PEER_CONNECTOR::PEER_ADDR ACE_Connector< SVC_HANDLER, PEER_CONNECTOR >::PEER_ADDR_TYPEDEF |
| typedef SVC_HANDLER::stream_type ACE_Connector< SVC_HANDLER, PEER_CONNECTOR >::stream_type |
| ACE_Connector< SVC_HANDLER, PEER_CONNECTOR >::ACE_Connector | ( | ACE_Reactor * | r = ACE_Reactor::instance (), |
| int | flags = 0 |
||
| ) |
Initialize a connector. flags indicates how SVC_HANDLER's should be initialized prior to being activated. Right now, the only flag that is processed is ACE_NONBLOCK, which enabled non-blocking I/O on the SVC_HANDLER when it is opened.
|
virtual |
Shutdown a connector and release resources.
|
protectedvirtual |
Bridge method for activating a svc_handler with the appropriate concurrency strategy. The default behavior of this method is to activate the SVC_HANDLER by calling its <open> method (which allows the SVC_HANDLER to define its own concurrency strategy). However, subclasses can override this strategy to do more sophisticated concurrency activations (such as creating the SVC_HANDLER as an "active object" via multi-threading or multi-processing).
Reimplemented in ACE_Strategy_Connector< SVC_HANDLER, PEER_CONNECTOR >.
|
virtual |
Cancel the svc_handler that was started asynchronously. Note that this is the only case when the Connector does not actively close the svc_handler. It is left up to the caller of <cancel> to decide the fate of the svc_handler.
|
virtual |
Close down the Connector. All pending non-blocking connects are canceled and the corresponding svc_handler is closed.
Reimplemented in ACE_Strategy_Connector< SVC_HANDLER, PEER_CONNECTOR >.
|
virtual |
Initiate connection of svc_handler to peer at remote_addr using synch_options. If the caller wants to designate the selected local_addr they can (and can also insist that the local_addr be reused by passing a value reuse_addr == 1). flags and perms can be used to pass any flags that are needed to perform specific operations such as opening a file within connect with certain permissions. If the connection fails the <close> hook on the svc_handler will be called automatically to prevent resource leaks.
|
virtual |
This is a variation on the previous <connect> method. On cached connectors the svc_handler_hint variable can be used as a hint for future lookups. Since this variable is modified in the context of the internal cache its use is thread-safe. But the actual svc_handler for the current connection is returned in the second parameter svc_handler. If the connection fails the <close> hook on the svc_handler will be called automatically to prevent resource leaks.
|
protectedvirtual |
Implementation of the connect methods.
|
virtual |
Initiate connection of n svc_handlers to peers at remote_addrs using synch_options. Returns -1 if failure occurs and 0 otherwise. If failed_svc_handlers is non-NULL, a 1 is placed in the corresponding index of failed_svc_handlers for each <svc_handlers[i]> that failed to connect, else a 0 is placed in that index.
|
protectedvirtual |
Bridge method for connecting the svc_handler to the remote_addr. The default behavior delegates to the <PEER_CONNECTOR::connect>.
Reimplemented in ACE_Strategy_Connector< SVC_HANDLER, PEER_CONNECTOR >.
|
protectedvirtual |
Reimplemented in ACE_Strategy_Connector< SVC_HANDLER, PEER_CONNECTOR >.
|
virtual |
Return the underlying PEER_CONNECTOR object.
| void ACE_Connector< SVC_HANDLER, PEER_CONNECTOR >::dump | ( | void | ) | const |
Dump the state of an object.
|
protectedvirtual |
Calls handle_close() to shutdown the Connector gracefully.
Reimplemented from ACE_Shared_Object.
|
protectedvirtual |
Default version returns address info in buf.
Reimplemented from ACE_Shared_Object.
|
protectedvirtual |
Default version does no work and returns -1. Must be overloaded by application developer to do anything meaningful.
Reimplemented from ACE_Shared_Object.
|
virtual |
Initialize Svc_Handler.
Implements ACE_Connector_Base< SVC_HANDLER >.
|
protectedvirtual |
Bridge method for creating a SVC_HANDLER. The default is to create a new SVC_HANDLER only if sh == 0, else sh is unchanged. However, subclasses can override this policy to perform SVC_HANDLER creation in any way that they like (such as creating subclass instances of SVC_HANDLER, using a singleton, dynamically linking the handler, etc.). Returns -1 if failure, else 0.
Reimplemented in ACE_Strategy_Connector< SVC_HANDLER, PEER_CONNECTOR >.
|
protectedvirtual |
Return the handle set representing the non-blocking connects in progress.
Implements ACE_Connector_Base< SVC_HANDLER >.
|
protected |
Creates and registers ACE_NonBlocking_Connect_Handler.
|
virtual |
Initialize a connector. flags indicates how SVC_HANDLER's should be initialized prior to being activated. Right now, the only flag that is processed is ACE_NONBLOCK, which enabled non-blocking I/O on the SVC_HANDLER when it is opened.
Reimplemented in ACE_Strategy_Connector< SVC_HANDLER, PEER_CONNECTOR >.
|
virtual |
Set Reactor.
Reimplemented from ACE_Event_Handler.
|
virtual |
Get Reactor.
Reimplemented from ACE_Event_Handler.
|
protectedvirtual |
Default version does no work and returns -1. Must be overloaded by application developer to do anything meaningful.
Reimplemented from ACE_Service_Object.
|
protectedvirtual |
Default version does no work and returns -1. Must be overloaded by application developer to do anything meaningful.
Reimplemented from ACE_Service_Object.
| ACE_Connector< SVC_HANDLER, PEER_CONNECTOR >::ACE_ALLOC_HOOK_DECLARE |
Declare the dynamic allocation hooks.
|
private |
This is the peer connector factory.
|
private |
Flags that indicate how SVC_HANDLER's should be initialized prior to being activated. Right now, the only flag that is processed is ACE_NONBLOCK, which enabled non-blocking I/O on the SVC_HANDLER when it is opened.
|
private |
Handle set representing the non-blocking connects in progress.
|
private |
Pointer to the Reactor.
1.8.9.1
