Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members Related Pages

# ACE_Connector Class Template Reference

Generic factory for actively connecting clients and creating service handlers (SVC_HANDLERs). More...

`#include <Connector.h>`

Inheritance diagram for ACE_Connector:

[legend]
Collaboration diagram for ACE_Connector:

[legend]
List of all members.

## Public Types
typedef ACE_TYPENAME SVC_HANDLER::addr_type | addr_type
typedef ACE_PEER_CONNECTOR | connector_type
typedef SVC_HANDLER | handler_type
typedef ACE_TYPENAME SVC_HANDLER::stream_type | stream_type
typedef ACE_TYPENAME _ACE_PEER_CONNECTOR::PEER_ADDR | ACE_TYPENAME_ACE_PEER_CONNECTOR_PEER_ADDR
## Public Methods
| ACE_Connector (ACE_Reactor *r=ACE_Reactor::instance(), int flags=0)
| Initialize a connector. More...
virtual int | open (ACE_Reactor *r=ACE_Reactor::instance(), int flags=0)
| Initialize a connector. More...
virtual | ~ACE_Connector (void)
| Shutdown a connector and release resources. More...
virtual int | connect (SVC_HANDLER *&svc_handler, const ACE_PEER_CONNECTOR_ADDR &remote_addr, const ACE_Synch_Options &synch_options=ACE_Synch_Options::defaults, const ACE_PEER_CONNECTOR_ADDR &local_addr=(ACE_TYPENAME_ACE_PEER_CONNECTOR_PEER_ADDR &) ACE_PEER_CONNECTOR_ADDR_ANY, int reuse_addr=0, int flags=O_RDWR, int perms=0)
| Initiate connection of <svc_handler> to peer at <remote_addr> using <synch_options>. More...
virtual int | connect (SVC_HANDLER *&svc_handler_hint, SVC_HANDLER *&svc_handler, const ACE_PEER_CONNECTOR_ADDR &remote_addr, const ACE_Synch_Options &synch_options=ACE_Synch_Options::defaults, const ACE_PEER_CONNECTOR_ADDR &local_addr=(ACE_TYPENAME_ACE_PEER_CONNECTOR_PEER_ADDR &) ACE_PEER_CONNECTOR_ADDR_ANY, int reuse_addr=0, int flags=O_RDWR, int perms=0)
| This is a variation on the previous <connect> method. More...
virtual int | connect_n (size_t n, SVC_HANDLER *svc_handlers[], ACE_PEER_CONNECTOR_ADDR remote_addrs[], ACE_TCHAR *failed_svc_handlers=0, const ACE_Synch_Options &synch_options=ACE_Synch_Options::defaults)
| Initiate connection of <n> <svc_handlers> to peers at <remote_addrs> using <synch_options>. More...
virtual int | cancel (SVC_HANDLER *svc_handler)
| Cancel a <svc_handler> that was started asynchronously. More...
virtual int | close (void)
| Close down the Connector. More...
virtual ACE_PEER_CONNECTOR & | connector (void) const
| Return the underlying PEER_CONNECTOR object. More...
void | dump (void) const
| Dump the state of an object. More...
## Public Attributes
| ACE_ALLOC_HOOK_DECLARE
| Declare the dynamic allocation hooks. More...
## Protected Types
typedef ACE_Svc_Tuple< SVC_HANDLER > | AST
typedef ACE_Map_Manager< ACE_HANDLE, ACE_Svc_Tuple< SVC_HANDLER > *, ACE_SYNCH_RW_MUTEX > | MAP_MANAGER
typedef ACE_Map_Iterator< ACE_HANDLE, ACE_Svc_Tuple< SVC_HANDLER > *, ACE_SYNCH_RW_MUTEX > | MAP_ITERATOR
typedef ACE_Map_Entry< ACE_HANDLE, ACE_Svc_Tuple< SVC_HANDLER > *> | MAP_ENTRY
## Protected Methods
virtual int | make_svc_handler (SVC_HANDLER *&sh)
| Bridge method for creating a SVC_HANDLER. More...
virtual int | connect_svc_handler (SVC_HANDLER *&svc_handler, const ACE_PEER_CONNECTOR_ADDR &remote_addr, ACE_Time_Value *timeout, const ACE_PEER_CONNECTOR_ADDR &local_addr, int reuse_addr, int flags, int perms)
| Bridge method for connecting the <svc_handler> to the <remote_addr>. More...
virtual int | connect_svc_handler (SVC_HANDLER *&svc_handler, SVC_HANDLER *&sh_copy, const ACE_PEER_CONNECTOR_ADDR &remote_addr, ACE_Time_Value *timeout, const ACE_PEER_CONNECTOR_ADDR &local_addr, int reuse_addr, int flags, int perms)
virtual int | activate_svc_handler (SVC_HANDLER *svc_handler)
| Bridge method for activating a <svc_handler> with the appropriate concurrency strategy. More...
virtual int | handle_input (ACE_HANDLE)
| Called by ACE_Reactor when asynchronous connections fail. More...
virtual int | handle_output (ACE_HANDLE)
| Called by ACE_Reactor when asynchronous connections succeed. More...
virtual int | handle_exception (ACE_HANDLE fd=ACE_INVALID_HANDLE)
| Called by ACE_Reactor when asynchronous connections complete (on some platforms only). More...
virtual int | init (int argc, ACE_TCHAR *argv[])
| Default version does no work and returns -1. Must be overloaded by application developer to do anything meaningful. More...
virtual int | fini (void)
| Calls <handle_close> to shutdown the Connector gracefully. More...
virtual int | info (ACE_TCHAR **, size_t) const
| Default version returns address info in <buf>. More...
virtual int | handle_close (ACE_HANDLE=ACE_INVALID_HANDLE, ACE_Reactor_Mask=ACE_Event_Handler::ALL_EVENTS_MASK)
| Terminate the Client ACE_Connector by iterating over any unconnected ACE_Svc_Handler's and removing them from the ACE_Reactor. More...
virtual int | handle_timeout (const ACE_Time_Value &tv, const void *arg)
| This method is called if a connection times out before completing. More...
virtual int | suspend (void)
| Default version does no work and returns -1. Must be overloaded by application developer to do anything meaningful. More...
virtual int | resume (void)
| Default version does no work and returns -1. Must be overloaded by application developer to do anything meaningful. More...
int | create_AST (SVC_HANDLER *, const ACE_Synch_Options &)
| Creates and inserts an ACE_Svc_Tuple into the <handler_map_>. so that we can continue accepting this connection asynchronously. More...
int | cleanup_AST (ACE_HANDLE handle, AST *&ast)
| Cleanup the <handler_map_> and returns the appropriate ACE_Svc_Tuple (which is 0 if there is no associated tuple). More...
virtual int | connect_i (SVC_HANDLER *&svc_handler, SVC_HANDLER **sh_copy, const ACE_PEER_CONNECTOR_ADDR &remote_addr, const ACE_Synch_Options &synch_options, const ACE_PEER_CONNECTOR_ADDR &local_addr, int reuse_addr, int flags, int perms)
| Implementation the <connect> methods. More...
## Protected Attributes
MAP_MANAGER | handler_map_
| Lookup table that maps an I/O handle to a SVC_HANDLER *. More...
## Private Attributes
ACE_PEER_CONNECTOR | connector_
| This is the concrete connector factory (it keeps no state so the <ACE_Connector> is reentrant). More...
char | closing_
| Keeps track of whether we are in the process of closing (required to avoid circular calls to <handle_close>). More...
int | flags_
| Flags that indicate how <SVC_HANDLER>'s should be initialized prior to being activated. More...

## Detailed Description

### template<class SVC_HANDLER, ACE_PEER_CONNECTOR_1>
class ACE_Connector< SVC_HANDLER, >

Generic factory for actively connecting clients and creating service handlers (SVC_HANDLERs).

Implements the strategy for actively establishing connections with clients. An ACE_Connector is parameterized by concrete types that conform to the interfaces of PEER_CONNECTOR and SVC_HANDLER. The PEER_CONNECTOR is instantiated with a transport mechanism that passively establishes connections. The SVC_HANDLER is instantiated with a concrete type that performs the application-specific service. An ACE_Connector inherits from ACE_Service_Object, which in turn inherits from ACE_Event_Handler. This enables the ACE_Reactor to dispatch the ACE_Connector's handle_output method when connections complete asynchronously. The handle_output method performs the connector's active connection establishment and service activation strategy.

## Member Typedef Documentation

template<class SVC_HANDLER, ACE_PEER_CONNECTOR_1 >
typedef ACE_TYPENAME _ACE_PEER_CONNECTOR::PEER_ADDR ACE_Connector::ACE_TYPENAME_ACE_PEER_CONNECTOR_PEER_ADDR

template<class SVC_HANDLER, ACE_PEER_CONNECTOR_1 >
typedef ACE_TYPENAME SVC_HANDLER::addr_type ACE_Connector::addr_type

template<class SVC_HANDLER, ACE_PEER_CONNECTOR_1 >
typedef ACE_Svc_Tuple<SVC_HANDLER> ACE_Connector::AST`[protected]`

template<class SVC_HANDLER, ACE_PEER_CONNECTOR_1 >
typedef ACE_PEER_CONNECTOR ACE_Connector::connector_type

template<class SVC_HANDLER, ACE_PEER_CONNECTOR_1 >
typedef SVC_HANDLER ACE_Connector::handler_type

template<class SVC_HANDLER, ACE_PEER_CONNECTOR_1 >
typedef ACE_Map_Entry<ACE_HANDLE, ACE_Svc_Tuple<SVC_HANDLER> *> ACE_Connector::MAP_ENTRY`[protected]`

template<class SVC_HANDLER, ACE_PEER_CONNECTOR_1 >
typedef ACE_Map_Iterator<ACE_HANDLE, ACE_Svc_Tuple<SVC_HANDLER> *, ACE_SYNCH_RW_MUTEX> ACE_Connector::MAP_ITERATOR`[protected]`

template<class SVC_HANDLER, ACE_PEER_CONNECTOR_1 >
typedef ACE_Map_Manager<ACE_HANDLE, ACE_Svc_Tuple<SVC_HANDLER> *, ACE_SYNCH_RW_MUTEX> ACE_Connector::MAP_MANAGER`[protected]`

template<class SVC_HANDLER, ACE_PEER_CONNECTOR_1 >
typedef ACE_TYPENAME SVC_HANDLER::stream_type ACE_Connector::stream_type

## Constructor & Destructor Documentation

template<class SVC_HANDLER, ACE_PEER_CONNECTOR_1 >
ACE_Connector< SVC_HANDLER, >::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.

template<class SVC_HANDLER, ACE_PEER_CONNECTOR_1 >
virtual ACE_Connector< SVC_HANDLER, >::~ACE_Connector | ( | void |  | ) | `[virtual]`

| Shutdown a connector and release resources.

## Member Function Documentation

template<class SVC_HANDLER, ACE_PEER_CONNECTOR_1 >
virtual int ACE_Connector< SVC_HANDLER, >::activate_svc_handler | ( | SVC_HANDLER * | svc_handler | ) | `[protected, virtual]`

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

template<class SVC_HANDLER, ACE_PEER_CONNECTOR_1 >
virtual int ACE_Connector< SVC_HANDLER, >::cancel | ( | SVC_HANDLER * | svc_handler | ) | `[virtual]`

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

template<class SVC_HANDLER, ACE_PEER_CONNECTOR_1 >
int ACE_Connector< SVC_HANDLER, >::cleanup_AST | ( | ACE_HANDLE | handle,
|  | AST *& | ast
| ) | `[protected]`

| Cleanup the <handler_map_> and returns the appropriate ACE_Svc_Tuple (which is 0 if there is no associated tuple).

template<class SVC_HANDLER, ACE_PEER_CONNECTOR_1 >
virtual int ACE_Connector< SVC_HANDLER, >::close | ( | void |  | ) | `[virtual]`

| Close down the Connector. Reimplemented in ACE_Strategy_Connector.

template<class SVC_HANDLER, ACE_PEER_CONNECTOR_1 >
virtual int ACE_Connector< SVC_HANDLER, >::connect | ( | SVC_HANDLER *& | svc_handler_hint,
|  | SVC_HANDLER *& | svc_handler,
|  | const ACE_PEER_CONNECTOR_ADDR & | remote_addr,
|  | const ACE_Synch_Options & | synch_options = ACE_Synch_Options::defaults,
|  | const ACE_PEER_CONNECTOR_ADDR & | local_addr = (ACE_TYPENAME_ACE_PEER_CONNECTOR_PEER_ADDR &) ACE_PEER_CONNECTOR_ADDR_ANY,
|  | int | reuse_addr = 0,
|  | int | flags = O_RDWR,
|  | int | perms = 0
| ) | `[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.

template<class SVC_HANDLER, ACE_PEER_CONNECTOR_1 >
virtual int ACE_Connector< SVC_HANDLER, >::connect | ( | SVC_HANDLER *& | svc_handler,
|  | const ACE_PEER_CONNECTOR_ADDR & | remote_addr,
|  | const ACE_Synch_Options & | synch_options = ACE_Synch_Options::defaults,
|  | const ACE_PEER_CONNECTOR_ADDR & | local_addr = (ACE_TYPENAME_ACE_PEER_CONNECTOR_PEER_ADDR &) ACE_PEER_CONNECTOR_ADDR_ANY,
|  | int | reuse_addr = 0,
|  | int | flags = O_RDWR,
|  | int | perms = 0
| ) | `[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.

template<class SVC_HANDLER, ACE_PEER_CONNECTOR_1 >
virtual int ACE_Connector< SVC_HANDLER, >::connect_i | ( | SVC_HANDLER *& | svc_handler,
|  | SVC_HANDLER ** | sh_copy,
|  | const ACE_PEER_CONNECTOR_ADDR & | remote_addr,
|  | const ACE_Synch_Options & | synch_options,
|  | const ACE_PEER_CONNECTOR_ADDR & | local_addr,
|  | int | reuse_addr,
|  | int | flags,
|  | int | perms
| ) | `[protected, virtual]`

| Implementation the <connect> methods.

template<class SVC_HANDLER, ACE_PEER_CONNECTOR_1 >
virtual int ACE_Connector< SVC_HANDLER, >::connect_n | ( | size_t | n,
|  | SVC_HANDLER * | svc_handlers[],
|  | ACE_PEER_CONNECTOR_ADDR | remote_addrs[],
|  | ACE_TCHAR * | failed_svc_handlers = 0,
|  | const ACE_Synch_Options & | synch_options = ACE_Synch_Options::defaults
| ) | `[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_handler> for each <svc_handlers[i]> that failed to connect, else a 0 is placed in that index.

template<class SVC_HANDLER, ACE_PEER_CONNECTOR_1 >
virtual int ACE_Connector< SVC_HANDLER, >::connect_svc_handler | ( | SVC_HANDLER *& | sh,
|  | SVC_HANDLER *& | sh_copy,
|  | const ACE_PEER_CONNECTOR_ADDR & | remote_addr,
|  | ACE_Time_Value * | timeout,
|  | const ACE_PEER_CONNECTOR_ADDR & | local_addr,
|  | int | reuse_addr,
|  | int | flags,
|  | int | perms
| ) | `[protected, virtual]`

| Reimplemented in ACE_Strategy_Connector.

template<class SVC_HANDLER, ACE_PEER_CONNECTOR_1 >
virtual int ACE_Connector< SVC_HANDLER, >::connect_svc_handler | ( | SVC_HANDLER *& | sh,
|  | const ACE_PEER_CONNECTOR_ADDR & | remote_addr,
|  | ACE_Time_Value * | timeout,
|  | const ACE_PEER_CONNECTOR_ADDR & | local_addr,
|  | int | reuse_addr,
|  | int | flags,
|  | int | perms
| ) | `[protected, virtual]`

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

template<class SVC_HANDLER, ACE_PEER_CONNECTOR_1 >
virtual ACE_PEER_CONNECTOR& ACE_Connector< SVC_HANDLER, >::connector | ( | void |  | ) | const`[virtual]`

| Return the underlying PEER_CONNECTOR object.

template<class SVC_HANDLER, ACE_PEER_CONNECTOR_1 >
int ACE_Connector< SVC_HANDLER, >::create_AST | ( | SVC_HANDLER * | ,
|  | const ACE_Synch_Options & |
| ) | `[protected]`

| Creates and inserts an ACE_Svc_Tuple into the <handler_map_>. so that we can continue accepting this connection asynchronously.

template<class SVC_HANDLER, ACE_PEER_CONNECTOR_1 >
void ACE_Connector< SVC_HANDLER, >::dump | ( | void |  | ) | const

| Dump the state of an object.

template<class SVC_HANDLER, ACE_PEER_CONNECTOR_1 >
virtual int ACE_Connector< SVC_HANDLER, >::fini | ( | void |  | ) | `[protected, virtual]`

| Calls <handle_close> to shutdown the Connector gracefully. Reimplemented from ACE_Shared_Object.

template<class SVC_HANDLER, ACE_PEER_CONNECTOR_1 >
virtual int ACE_Connector< SVC_HANDLER, >::handle_close | ( | ACE_HANDLE | handle = ACE_INVALID_HANDLE,
|  | ACE_Reactor_Mask | close_mask = ACE_Event_Handler::ALL_EVENTS_MASK
| ) | `[protected, virtual]`

| Terminate the Client ACE_Connector by iterating over any unconnected ACE_Svc_Handler's and removing them from the ACE_Reactor. Reimplemented from ACE_Event_Handler.

template<class SVC_HANDLER, ACE_PEER_CONNECTOR_1 >
virtual int ACE_Connector< SVC_HANDLER, >::handle_exception | ( | ACE_HANDLE | fd = ACE_INVALID_HANDLE | ) | `[protected, virtual]`

| Called by ACE_Reactor when asynchronous connections complete (on some platforms only). Reimplemented from ACE_Event_Handler.

template<class SVC_HANDLER, ACE_PEER_CONNECTOR_1 >
virtual int ACE_Connector< SVC_HANDLER, >::handle_input | ( | ACE_HANDLE | fd | ) | `[protected, virtual]`

| Called by ACE_Reactor when asynchronous connections fail. Reimplemented from ACE_Event_Handler.

template<class SVC_HANDLER, ACE_PEER_CONNECTOR_1 >
virtual int ACE_Connector< SVC_HANDLER, >::handle_output | ( | ACE_HANDLE | fd | ) | `[protected, virtual]`

| Called by ACE_Reactor when asynchronous connections succeed. Reimplemented from ACE_Event_Handler.

template<class SVC_HANDLER, ACE_PEER_CONNECTOR_1 >
virtual int ACE_Connector< SVC_HANDLER, >::handle_timeout | ( | const ACE_Time_Value & | tv,
|  | const void * | arg
| ) | `[protected, virtual]`

| This method is called if a connection times out before completing. Reimplemented from ACE_Event_Handler.

template<class SVC_HANDLER, ACE_PEER_CONNECTOR_1 >
virtual int ACE_Connector< SVC_HANDLER, >::info | ( | ACE_TCHAR ** | strp,
|  | size_t | length
| ) | const`[protected, virtual]`

| Default version returns address info in <buf>. Reimplemented from ACE_Shared_Object.

template<class SVC_HANDLER, ACE_PEER_CONNECTOR_1 >
virtual int ACE_Connector< SVC_HANDLER, >::init | ( | int | argc,
|  | ACE_TCHAR * | argv[]
| ) | `[protected, virtual]`

| Default version does no work and returns -1. Must be overloaded by application developer to do anything meaningful. Reimplemented from ACE_Shared_Object.

template<class SVC_HANDLER, ACE_PEER_CONNECTOR_1 >
virtual int ACE_Connector< SVC_HANDLER, >::make_svc_handler | ( | SVC_HANDLER *& | sh | ) | `[protected, virtual]`

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

template<class SVC_HANDLER, ACE_PEER_CONNECTOR_1 >
virtual int ACE_Connector< SVC_HANDLER, >::open | ( | ACE_Reactor * | r = ACE_Reactor::instance (),
|  | int | flags = 0
| ) | `[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.

template<class SVC_HANDLER, ACE_PEER_CONNECTOR_1 >
virtual int ACE_Connector< SVC_HANDLER, >::resume | ( | void |  | ) | `[protected, virtual]`

| Default version does no work and returns -1. Must be overloaded by application developer to do anything meaningful. Reimplemented from ACE_Service_Object.

template<class SVC_HANDLER, ACE_PEER_CONNECTOR_1 >
virtual int ACE_Connector< SVC_HANDLER, >::suspend | ( | void |  | ) | `[protected, virtual]`

| Default version does no work and returns -1. Must be overloaded by application developer to do anything meaningful. Reimplemented from ACE_Service_Object.

## Member Data Documentation

template<class SVC_HANDLER, ACE_PEER_CONNECTOR_1 >
ACE_Connector::ACE_ALLOC_HOOK_DECLARE

| Declare the dynamic allocation hooks.

template<class SVC_HANDLER, ACE_PEER_CONNECTOR_1 >
char ACE_Connector::closing_`[private]`

| Keeps track of whether we are in the process of closing (required to avoid circular calls to <handle_close>).

template<class SVC_HANDLER, ACE_PEER_CONNECTOR_1 >
ACE_PEER_CONNECTOR ACE_Connector::connector_`[private]`

| This is the concrete connector factory (it keeps no state so the <ACE_Connector> is reentrant).

template<class SVC_HANDLER, ACE_PEER_CONNECTOR_1 >
int ACE_Connector::flags_`[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.

template<class SVC_HANDLER, ACE_PEER_CONNECTOR_1 >
MAP_MANAGER ACE_Connector::handler_map_`[protected]`

| Lookup table that maps an I/O handle to a SVC_HANDLER *.

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

- Connector.h