// Connector.cpp // $Id$ #ifndef ACE_CONNECTOR_C #define ACE_CONNECTOR_C #include "ace/Connector.h" #if !defined (ACE_LACKS_PRAGMA_ONCE) # pragma once #endif /* ACE_LACKS_PRAGMA_ONCE */ ACE_RCSID(ace, Connector, "$Id$") // Shorthand names. #define SH SVC_HANDLER #define PR_CO_1 ACE_PEER_CONNECTOR_1 #define PR_CO_2 ACE_PEER_CONNECTOR_2 #define PR_AD ACE_PEER_CONNECTOR_ADDR ACE_ALLOC_HOOK_DEFINE(ACE_Connector) template void ACE_Connector::dump (void) const { ACE_TRACE ("ACE_Connector::dump"); ACE_DEBUG ((LM_DEBUG, ACE_BEGIN_DUMP, this)); ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("\nclosing_ = %d"), this->closing_)); ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("\nflags_ = %d"), this->flags_)); this->handler_map_.dump (); ACE_DEBUG ((LM_DEBUG, ACE_END_DUMP)); } // Bridge method for creating a SVC_HANDLER. The strategy for // creating a SVC_HANDLER are configured into the Acceptor via it's // . The default is to create a new SVC_HANDLER. // However, subclasses can override this strategy 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.). template int ACE_Connector::make_svc_handler (SVC_HANDLER *&sh) { ACE_TRACE ("ACE_Connector::make_svc_handler"); if (sh == 0) ACE_NEW_RETURN (sh, SH, -1); // Set the reactor of the newly created to the same // reactor that this is using. if (this->reactor ()) sh->reactor (this->reactor ()); return 0; } template int ACE_Connector::activate_svc_handler (SVC_HANDLER *svc_handler) { ACE_TRACE ("ACE_Connector::activate_svc_handler"); // No errors initially int error = 0; // See if we should enable non-blocking I/O on the 's // peer. if (ACE_BIT_ENABLED (this->flags_, ACE_NONBLOCK) != 0) { if (svc_handler->peer ().enable (ACE_NONBLOCK) == -1) error = 1; } // Otherwise, make sure it's disabled by default. else if (svc_handler->peer ().disable (ACE_NONBLOCK) == -1) error = 1; // We are connected now, so try to open things up. if (error || svc_handler->open ((void *) this) == -1) { // Make sure to close down the to avoid descriptor // leaks. svc_handler->close (0); return -1; } else return 0; } template int ACE_Connector::connect_svc_handler (SVC_HANDLER *&svc_handler, const PR_AD &remote_addr, ACE_Time_Value *timeout, const PR_AD &local_addr, int reuse_addr, int flags, int perms) { ACE_TRACE ("ACE_Connector::connect_svc_handler"); return this->connector_.connect (svc_handler->peer (), remote_addr, timeout, local_addr, reuse_addr, flags, perms); } template int ACE_Connector::connect_svc_handler (SVC_HANDLER *&svc_handler, SVC_HANDLER *&sh_copy, const PR_AD &remote_addr, ACE_Time_Value *timeout, const PR_AD &local_addr, int reuse_addr, int flags, int perms) { ACE_TRACE ("ACE_Connector::connect_svc_handler"); sh_copy = svc_handler; return this->connector_.connect (svc_handler->peer (), remote_addr, timeout, local_addr, reuse_addr, flags, perms); } template int ACE_Connector::open (ACE_Reactor *r, int flags) { ACE_TRACE ("ACE_Connector::open"); this->reactor (r); this->flags_ = flags; this->closing_ = 0; return 0; } template ACE_Connector::ACE_Connector (ACE_Reactor *r, int flags) { ACE_TRACE ("ACE_Connector::ACE_Connector"); (void) this->open (r, flags); } template ACE_Svc_Tuple::ACE_Svc_Tuple (SVC_HANDLER *sh, ACE_HANDLE handle, const void *arg, long id) : svc_handler_ (sh), handle_ (handle), arg_ (arg), cancellation_id_ (id) { ACE_TRACE ("ACE_Svc_Tuple::ACE_Svc_Tuple"); } template SVC_HANDLER * ACE_Svc_Tuple::svc_handler (void) { ACE_TRACE ("ACE_Svc_Tuple::svc_handler"); return this->svc_handler_; } template const void * ACE_Svc_Tuple::arg (void) { ACE_TRACE ("ACE_Svc_Tuple::arg"); return this->arg_; } template void ACE_Svc_Tuple::arg (const void *v) { ACE_TRACE ("ACE_Svc_Tuple::arg"); this->arg_ = v; } template ACE_HANDLE ACE_Svc_Tuple::handle (void) { ACE_TRACE ("ACE_Svc_Tuple::handle"); return this->handle_; } template void ACE_Svc_Tuple::handle (ACE_HANDLE h) { ACE_TRACE ("ACE_Svc_Tuple::handle"); this->handle_ = h; } template long ACE_Svc_Tuple::cancellation_id (void) { ACE_TRACE ("ACE_Svc_Tuple::cancellation_id"); return this->cancellation_id_; } template void ACE_Svc_Tuple::cancellation_id (long id) { ACE_TRACE ("ACE_Svc_Tuple::cancellation_id"); this->cancellation_id_ = id; } template void ACE_Svc_Tuple::dump (void) const { ACE_TRACE ("ACE_Svc_Tuple::dump"); ACE_DEBUG ((LM_DEBUG, ACE_BEGIN_DUMP, this)); ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("svc_handler_ = %x"), this->svc_handler_)); ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("\narg_ = %x"), this->arg_)); ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("\ncancellation_id_ = %d"), this->cancellation_id_)); ACE_DEBUG ((LM_DEBUG, ACE_END_DUMP)); } // This method is called if a connection times out before completing. // In this case, we call our cleanup_AST() method to cleanup the // descriptor from the ACE_Connector's table. template int ACE_Connector::handle_timeout (const ACE_Time_Value &tv, const void *arg) { ACE_TRACE ("ACE_Connector::handle_timeout"); AST *ast = 0; if (this->cleanup_AST (((AST *) arg)->handle (), ast) == -1) return -1; else { ACE_ASSERT (((AST *) arg) == ast); // We may need this seemingly unnecessary assignment to work // around a bug with MSVC++? SH *sh = ast->svc_handler (); // Forward to the SVC_HANDLER the that was passed in as a // magic cookie during ACE_Connector::connect(). This gives the // SVC_HANDLER an opportunity to take corrective action (e.g., // wait a few milliseconds and try to reconnect again. if (sh->handle_timeout (tv, ast->arg ()) == -1) sh->handle_close (sh->get_handle (), ACE_Event_Handler::TIMER_MASK); delete ast; return 0; } } template int ACE_Connector::cleanup_AST (ACE_HANDLE handle, ACE_Svc_Tuple *&ast) { ACE_TRACE ("ACE_Connector::cleanup_AST"); // Locate the ACE_Svc_Handler corresponding to the socket // descriptor. if (this->handler_map_.find (handle, ast) == -1) { // Error, entry not found in map. errno = ENOENT; ACE_ERROR_RETURN ((LM_ERROR, ACE_TEXT ("%p %d not found in map\n"), ACE_TEXT ("find"), handle), -1); } // Try to remove from ACE_Timer_Queue but if it's not there we // ignore the error. this->reactor ()->cancel_timer (ast->cancellation_id ()); // Remove ACE_HANDLE from ACE_Reactor. this->reactor ()->remove_handler (handle, ACE_Event_Handler::ALL_EVENTS_MASK | ACE_Event_Handler::DONT_CALL); // Remove ACE_HANDLE from the map. this->handler_map_.unbind (handle); return 0; } // Called when a failure occurs during asynchronous connection // establishment. Simply delegate all work to this->handle_output(). template int ACE_Connector::handle_input (ACE_HANDLE h) { ACE_TRACE ("ACE_Connector::handle_input"); AST *ast = 0; if (this->cleanup_AST (h, ast) != -1) { ast->svc_handler ()->close (0); delete ast; } return 0; // Already removed from the ACE_Reactor. } // Finalize a connection established in non-blocking mode. When a // non-blocking connect *succeeds* the descriptor becomes enabled for // writing... Likewise, it is generally the case that when a // non-blocking connect *fails* the descriptor becomes enabled for // reading. template int ACE_Connector::handle_output (ACE_HANDLE handle) { ACE_TRACE ("ACE_Connector::handle_output"); AST *ast = 0; if (this->cleanup_AST (handle, ast) == -1) return 0; ACE_ASSERT (ast != 0); // This shouldn't happen! // Try to find out if the reactor uses event associations for the // handles it waits on. If so we need to reset it. int reset_new_handle = this->reactor ()->uses_event_associations (); if (reset_new_handle) this->connector_.reset_new_handle (handle); // Transfer ownership of the ACE_HANDLE to the SVC_HANDLER. ast->svc_handler ()->set_handle (handle); PR_AD raddr; #if defined (ACE_HAS_BROKEN_NON_BLOCKING_CONNECTS) // Win32 has a timing problem - if you check to see if the // connection has completed too fast, it will fail - so wait 35 // millisecond to let it catch up. ACE_Time_Value tv (0, ACE_NON_BLOCKING_BUG_DELAY); ACE_OS::sleep (tv); #endif /* ACE_HAS_BROKEN_NON_BLOCKING_CONNECTS */ // Check to see if we're connected. if (ast->svc_handler ()->peer ().get_remote_addr (raddr) != -1) this->activate_svc_handler (ast->svc_handler ()); else // Somethings gone wrong, so close down... ast->svc_handler ()->close (0); delete ast; return 0; } template int ACE_Connector::handle_exception (ACE_HANDLE h) { ACE_TRACE ("ACE_Connector::handle_exception"); return this->handle_output (h); } // Initiate connection to peer. template int ACE_Connector::connect (SH *&sh, const PR_AD &remote_addr, const ACE_Synch_Options &synch_options, const PR_AD &local_addr, int reuse_addr, int flags, int perms) { return this->connect_i (sh, 0, remote_addr, synch_options, local_addr, reuse_addr, flags, perms); } template int ACE_Connector::connect (SH *&sh, SH *&sh_copy, const PR_AD &remote_addr, const ACE_Synch_Options &synch_options, const PR_AD &local_addr, int reuse_addr, int flags, int perms) { return this->connect_i (sh, &sh_copy, remote_addr, synch_options, local_addr, reuse_addr, flags, perms); } template int ACE_Connector::connect_i (SH *&sh, SH **sh_copy, const PR_AD &remote_addr, const ACE_Synch_Options &synch_options, const PR_AD &local_addr, int reuse_addr, int flags, int perms) { ACE_TRACE ("ACE_Connector::connect"); // If the user hasn't supplied us with a we'll use the // factory method to create one. Otherwise, things will remain as // they are... if (this->make_svc_handler (sh) == -1) return -1; ACE_Time_Value *timeout; int use_reactor = synch_options[ACE_Synch_Options::USE_REACTOR]; if (use_reactor) timeout = (ACE_Time_Value *) &ACE_Time_Value::zero; else timeout = (ACE_Time_Value *) synch_options.time_value (); int result; if (sh_copy == 0) result = this->connect_svc_handler (sh, remote_addr, timeout, local_addr, reuse_addr, flags, perms); else result = this->connect_svc_handler (sh, *sh_copy, remote_addr, timeout, local_addr, reuse_addr, flags, perms); // Delegate to connection strategy. if (result == -1) { if (use_reactor && errno == EWOULDBLOCK) { // If the connection hasn't completed and we are using // non-blocking semantics then register ourselves with the // ACE_Reactor so that it will call us back when the // connection is complete or we timeout, whichever comes // first... Note that we needn't check the return value // here because if something goes wrong that will reset // errno this will be detected by the caller (since -1 is // being returned...). if (sh_copy == 0) this->create_AST (sh, synch_options); else this->create_AST (*sh_copy, synch_options); } else { // Save/restore errno. ACE_Errno_Guard error (errno); // Make sure to close down the Channel to avoid descriptor // leaks. if (sh_copy == 0) { if (sh) sh->close (0); } else { if (*sh_copy) (*sh_copy)->close (0); } } return -1; } else { // Activate immediately if we are connected. return this->activate_svc_handler (sh); } } // Initiate connection to peer. template int ACE_Connector::connect_n (size_t n, SH *sh[], PR_AD remote_addrs[], ACE_TCHAR *failed_svc_handlers, const ACE_Synch_Options &synch_options) { int result = 0; for (size_t i = 0; i < n; i++) { if (this->connect (sh[i], remote_addrs[i], synch_options) == -1 && !(synch_options[ACE_Synch_Options::USE_REACTOR] && errno == EWOULDBLOCK)) { result = -1; if (failed_svc_handlers != 0) // Mark this entry as having failed. failed_svc_handlers[i] = 1; } else if (failed_svc_handlers != 0) // Mark this entry as having succeeded. failed_svc_handlers[i] = 0; } return result; } // Cancel a that was started asynchronously. template int ACE_Connector::cancel (SH *sh) { ACE_TRACE ("ACE_Connector::cancel"); MAP_ITERATOR mi (this->handler_map_); for (MAP_ENTRY *me = 0; mi.next (me) != 0; mi.advance ()) if (me->int_id_->svc_handler () == sh) { AST *ast = 0; this->cleanup_AST (me->ext_id_, ast); delete ast; return 0; } return -1; } // Register the pending SVC_HANDLER with the map so that it can be // activated later on when the connection complets. template int ACE_Connector::create_AST (SH *sh, const ACE_Synch_Options &synch_options) { // Save/restore errno. ACE_Errno_Guard error (errno); ACE_TRACE ("ACE_Connector::create_AST"); AST *ast; ACE_NEW_RETURN (ast, AST (sh, sh->get_handle (), synch_options.arg (), -1), -1); // Register this with the reactor for connection events. ACE_Reactor_Mask mask = ACE_Event_Handler::CONNECT_MASK; // Bind ACE_Svc_Tuple with the ACE_HANDLE we're trying to connect. if (this->handler_map_.bind (sh->get_handle (), ast) == -1) goto fail1; else if (this->reactor ()->register_handler (sh->get_handle (), this, mask) == -1) goto fail2; // If we're starting connection under timer control then we need to // schedule a timeout with the ACE_Reactor. else { ACE_Time_Value *tv = ACE_const_cast (ACE_Time_Value *, synch_options.time_value ()); if (tv != 0) { int cancellation_id = this->reactor ()->schedule_timer (this, (const void *) ast, *tv); if (cancellation_id == -1) goto fail3; ast->cancellation_id (cancellation_id); return 0; } else return 0; // Ok, everything worked just fine... } // Undo previous actions using the ol' "goto label and fallthru" // trick... fail3: this->reactor ()->remove_handler (this, mask | ACE_Event_Handler::DONT_CALL); /* FALLTHRU */ fail2: this->handler_map_.unbind (sh->get_handle ()); /* FALLTHRU */ fail1: // Close the svc_handler sh->close (0); delete ast; return -1; } // Terminate the Client ACE_Connector by iterating over any // unconnected ACE_Svc_Handler's and removing them from the // ACE_Reactor. Note that we can't call handle_close() back at this // point since we own these things and we'll just get called // recursively! template int ACE_Connector::close (void) { ACE_TRACE ("ACE_Connector::close"); return this->handle_close (); } template int ACE_Connector::handle_close (ACE_HANDLE, ACE_Reactor_Mask) { ACE_TRACE ("ACE_Connector::handle_close"); if (this->reactor () != 0 && this->closing_ == 0) { // We're closing down now, so make sure not to call ourselves // recursively via other calls to handle_close() (e.g., from the // Timer_Queue). this->closing_ = 1; for (;;) { // Create an iterator. MAP_ITERATOR iterator = this->handler_map_.begin (); // If we reach the end of the map, break the loop. if (iterator == this->handler_map_.end ()) break; // Get the first handle. ACE_HANDLE handle = (*iterator).ext_id_; // Clean it up. AST *ast = 0; this->cleanup_AST (handle, ast); // Close the svc_handler. ast->svc_handler ()->close (0); // Zap the ast. delete ast; } } return 0; } template int ACE_Connector::fini (void) { ACE_TRACE ("ACE_Connector::fini"); // Make sure to call close here since our destructor might not be // called if we're being dynamically linked via the svc.conf. this->handler_map_.close (); // Make sure we call our handle_close(), not a subclass's! return ACE_Connector::handle_close (); } // Hook called by the explicit dynamic linking facility. template int ACE_Connector::init (int, ACE_TCHAR *[]) { ACE_TRACE ("ACE_Connector::init"); return -1; } template int ACE_Connector::suspend (void) { ACE_TRACE ("ACE_Connector::suspend"); return -1; } template int ACE_Connector::resume (void) { ACE_TRACE ("ACE_Connector::resume"); return -1; } template int ACE_Connector::info (ACE_TCHAR **strp, size_t length) const { ACE_TRACE ("ACE_Connector::info"); ACE_TCHAR buf[BUFSIZ]; ACE_OS::sprintf (buf, ACE_TEXT ("%s\t %s"), ACE_TEXT ("ACE_Connector"), ACE_TEXT ("# connector factory\n")); if (*strp == 0 && (*strp = ACE_OS::strdup (buf)) == 0) return -1; else ACE_OS::strncpy (*strp, buf, length); return ACE_OS::strlen (buf); } template ACE_Connector::~ACE_Connector (void) { ACE_TRACE ("ACE_Connector::~ACE_Connector"); // We will call our handle_close(), not a subclass's, due to the way // that C++ destructors work. this->handle_close (); } template int ACE_Strategy_Connector::open (ACE_Reactor *r, int flags) { ACE_TRACE ("ACE_Connector::open"); return this->open (r, 0, 0, 0, flags); } template int ACE_Strategy_Connector::open (ACE_Reactor *r, ACE_Creation_Strategy *cre_s, ACE_Connect_Strategy *conn_s, ACE_Concurrency_Strategy *con_s, int flags) { ACE_TRACE ("ACE_Connector::open"); this->reactor (r); // @@ Not implemented yet. // this->flags_ = flags; ACE_UNUSED_ARG (flags); // Initialize the creation strategy. // First we decide if we need to clean up. if (this->creation_strategy_ != 0 && this->delete_creation_strategy_ != 0 && cre_s != 0) { delete this->creation_strategy_; this->creation_strategy_ = 0; this->delete_creation_strategy_ = 0; } if (cre_s != 0) this->creation_strategy_ = cre_s; else if (this->creation_strategy_ == 0) { ACE_NEW_RETURN (this->creation_strategy_, CREATION_STRATEGY, -1); this->delete_creation_strategy_ = 1; } // Initialize the accept strategy. if (this->connect_strategy_ != 0 && this->delete_connect_strategy_ != 0 && conn_s != 0) { delete this->connect_strategy_; this->connect_strategy_ = 0; this->delete_connect_strategy_ = 0; } if (conn_s != 0) this->connect_strategy_ = conn_s; else if (this->connect_strategy_ == 0) { ACE_NEW_RETURN (this->connect_strategy_, CONNECT_STRATEGY, -1); this->delete_connect_strategy_ = 1; } // Initialize the concurrency strategy. if (this->concurrency_strategy_ != 0 && this->delete_concurrency_strategy_ != 0 && con_s != 0) { delete this->concurrency_strategy_; this->concurrency_strategy_ = 0; this->delete_concurrency_strategy_ = 0; } if (con_s != 0) this->concurrency_strategy_ = con_s; else if (this->concurrency_strategy_ == 0) { ACE_NEW_RETURN (this->concurrency_strategy_, CONCURRENCY_STRATEGY, -1); this->delete_concurrency_strategy_ = 1; } return 0; } template ACE_Strategy_Connector::ACE_Strategy_Connector (ACE_Reactor *reactor, ACE_Creation_Strategy *cre_s, ACE_Connect_Strategy *conn_s, ACE_Concurrency_Strategy *con_s, int flags) : creation_strategy_ (0), delete_creation_strategy_ (0), connect_strategy_ (0), delete_connect_strategy_ (0), concurrency_strategy_ (0), delete_concurrency_strategy_ (0) { ACE_TRACE ("ACE_Connector::ACE_Connector"); if (this->open (reactor, cre_s, conn_s, con_s, flags) == -1) ACE_ERROR ((LM_ERROR, ACE_TEXT ("%p\n"), ACE_TEXT ("ACE_Strategy_Connector::ACE_Strategy_Connector"))); } template ACE_Strategy_Connector::~ACE_Strategy_Connector (void) { ACE_TRACE ("ACE_Strategy_Connector::~ACE_Strategy_Connector"); // Close down this->close (); } template int ACE_Strategy_Connector::close (void) { if (this->delete_creation_strategy_) delete this->creation_strategy_; this->delete_creation_strategy_ = 0; this->creation_strategy_ = 0; if (this->delete_connect_strategy_) delete this->connect_strategy_; this->delete_connect_strategy_ = 0; this->connect_strategy_ = 0; if (this->delete_concurrency_strategy_) delete this->concurrency_strategy_; this->delete_concurrency_strategy_ = 0; this->concurrency_strategy_ = 0; return SUPER::close (); } template int ACE_Strategy_Connector::make_svc_handler (SVC_HANDLER *&sh) { return this->creation_strategy_->make_svc_handler (sh); } template int ACE_Strategy_Connector::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) { return this->connect_strategy_->connect_svc_handler (sh, remote_addr, timeout, local_addr, reuse_addr, flags, perms); } template int ACE_Strategy_Connector::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) { return this->connect_strategy_->connect_svc_handler (sh, sh_copy, remote_addr, timeout, local_addr, reuse_addr, flags, perms); } template int ACE_Strategy_Connector::activate_svc_handler (SVC_HANDLER *svc_handler) { return this->concurrency_strategy_->activate_svc_handler (svc_handler, this); } template ACE_Creation_Strategy * ACE_Strategy_Connector::creation_strategy (void) const { return this->creation_strategy_; } template ACE_Connect_Strategy * ACE_Strategy_Connector::connect_strategy (void) const { return this->connect_strategy_; } template ACE_Concurrency_Strategy * ACE_Strategy_Connector::concurrency_strategy (void) const { return this->concurrency_strategy_; } #undef SH #undef PR_CO_1 #undef PR_CO_2 #endif /* ACE_CONNECTOR_C */