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

ACE_Asynch_Connector Class Template Reference

This class is an example of the Connector pattern. This class will establish new connections and create new HANDLER objects to handle the new connections. More...

#include <Asynch_Connector.h>

Inheritance diagram for ACE_Asynch_Connector:

Inheritance graph
[legend]
Collaboration diagram for ACE_Asynch_Connector:

Collaboration graph
[legend]
List of all members.

Public Methods

 ACE_Asynch_Connector (void)
 A do nothing constructor. More...

virtual ~ACE_Asynch_Connector (void)
 Virtual destruction. More...

virtual int open (int pass_addresses=0, ACE_Proactor *proactor=0, int validate_new_connection=1)
virtual int connect (const ACE_INET_Addr &remote_sap, const ACE_INET_Addr &local_sap=ACE_INET_Addr((u_short) 0), int reuse_addr=1, const void *act=0)
 This initiates a new asynchronous connect. More...

virtual int cancel (void)
virtual int validate_connection (const ACE_Asynch_Connect::Result &result, const ACE_INET_Addr &remote, const ACE_INET_Addr &local)
virtual int pass_addresses (void) const
 Set and get flag that indicates if parsing and passing of addresses to the service_handler is necessary. More...

virtual void pass_addresses (int new_value)
virtual int validate_new_connection (void) const
 Set and get flag that indicates if address validation is required. More...

virtual void validate_new_connection (int new_value)

Protected Methods

virtual void handle_connect (const ACE_Asynch_Connect::Result &result)
 This is called when an outstanding accept completes. More...

void parse_address (const ACE_Asynch_Connect::Result &result, ACE_INET_Addr &remote_address, ACE_INET_Addr &local_address)
 This parses the address from read buffer. More...

ACE_Asynch_Connect & asynch_connect (void)
 Return the asynch Connect object. More...

virtual HANDLER * make_handler (void)

Private Attributes

ACE_Asynch_Connect asynch_connect_
 Asynch_Connect used to make life easier :-). More...

int pass_addresses_
 Flag that indicates if parsing of addresses is necessary. More...

int validate_new_connection_
 Flag that indicates if address validation is required. More...

Detailed Description

template<class HANDLER>
class ACE_Asynch_Connector< HANDLER >

This class is an example of the Connector pattern. This class will establish new connections and create new HANDLER objects to handle the new connections.

Unlike the ACE_Connector, however, this class is designed to be used asynchronously with the ACE Proactor framework.

Definition at line 44 of file Asynch_Connector.h.

Constructor & Destructor Documentation

template<class HANDLER>
ACE_Asynch_Connector< HANDLER >::ACE_Asynch_Connector (  void    ) 
 

A do nothing constructor.

Definition at line 25 of file Asynch_Connector.cpp. 

00026   : pass_addresses_ (0),
00027     validate_new_connection_ (0)
00028 {
00029 }

template<class HANDLER>
ACE_Asynch_Connector< HANDLER >::~ACE_Asynch_Connector (  void    )  [virtual]
 

Virtual destruction.

Definition at line 32 of file Asynch_Connector.cpp. 

00033 {
00034   //this->asynch_connect_.close ();
00035 }

Member Function Documentation

template<class HANDLER>
ACE_Asynch_Connect & ACE_Asynch_Connector< HANDLER >::asynch_connect (  void    )  [protected]
 

Return the asynch Connect object.

Definition at line 251 of file Asynch_Connector.cpp.

References asynch_connect_. 

00252 {
00253   return this->asynch_connect_;
00254 }

template<class HANDLER>
int ACE_Asynch_Connector< HANDLER >::cancel (  void    )  [virtual]
 

This cancels all pending accepts operations that were issued by the calling thread.

Note:
On Windows, this method does not cancel connect operations issued by other threads.
Note:
On POSIX, delegates cancelation to ACE_POSIX_Asynch_Connect.

Definition at line 178 of file Asynch_Connector.cpp.

References asynch_connect_, and ACE_Asynch_Operation::cancel. 

00179 {
00180   return this->asynch_connect_.cancel ();
00181 }

template<class HANDLER>
int ACE_Asynch_Connector< HANDLER >::connect (  const ACE_INET_Addr &    remote_sap,
const ACE_INET_Addr &    local_sap = ACE_INET_Addr((u_short) 0),
int    reuse_addr = 1,
const void *    act = 0
)  [virtual]
 

This initiates a new asynchronous connect.

Definition at line 59 of file Asynch_Connector.cpp.

References ACE_ERROR_RETURN, ACE_LIB_TEXT, asynch_connect_, ACE_Asynch_Connect::connect, and LM_ERROR. 

00063 {
00064   // Initiate asynchronous connect
00065   if (this->asynch_connect_.connect (ACE_INVALID_HANDLE,
00066                                      remote_sap,
00067                                      local_sap,
00068                                      reuse_addr,
00069                                      act) == -1)
00070     ACE_ERROR_RETURN ((LM_ERROR,
00071                        ACE_LIB_TEXT ("%p\n"),
00072                        ACE_LIB_TEXT ("ACE_Asynch_Connect::connect")),
00073                       -1);
00074   return 0;
00075 }

template<class HANDLER>
void ACE_Asynch_Connector< HANDLER >::handle_connect (  const ACE_Asynch_Connect::Result &    result )  [protected, virtual]
 

This is called when an outstanding accept completes.

Reimplemented from ACE_Handler.

Definition at line 78 of file Asynch_Connector.cpp.

References ACE_ERROR, ACE_LIB_TEXT, ACE_NONBLOCK, ACE_Asynch_Result::act, ACE_OS::closesocket, ACE_Flag_Manip::clr_flags, ACE_Asynch_Connect::Result::connect_handle, ACE_Asynch_Result::error, LM_ERROR, make_handler, parse_address, pass_addresses_, ACE_Asynch_Result::success, validate_connection, and validate_new_connection_. 

00079 {
00080   // Variable for error tracking
00081   int error = 0;
00082 
00083   // If the asynchronous connect fails.
00084   if (!result.success () ||
00085       result.connect_handle () == ACE_INVALID_HANDLE)
00086     {
00087       error = 1;
00088     }
00089 
00090   if (result.error () != 0)
00091     {
00092       error = 1;
00093     }
00094 
00095   // set blocking mode 
00096   if (!error &&
00097       ACE_Flag_Manip::clr_flags
00098         (result.connect_handle (), ACE_NONBLOCK) != 0)
00099     {
00100       error = 1;
00101       ACE_ERROR ((LM_ERROR,
00102                   ACE_LIB_TEXT ("%p\n"),
00103                   ACE_LIB_TEXT ("ACE_Asynch_Connector::handle_connect : Set blocking mode")));
00104     }
00105 
00106   // Parse the addresses.
00107   ACE_INET_Addr local_address;
00108   ACE_INET_Addr remote_address;
00109   if (!error &&
00110       (this->validate_new_connection_ || this->pass_addresses_))
00111     this->parse_address (result,
00112                          remote_address,
00113                          local_address);
00114 
00115   // Call validate_connection even if there was an error - it's the only
00116   // way the application can learn the connect disposition.
00117   if (this->validate_new_connection_ &&
00118       this->validate_connection (result, remote_address, local_address) == -1)
00119     {
00120       error = 1;
00121     }
00122 
00123   HANDLER *new_handler = 0;
00124   if (!error)
00125     {
00126       // The Template method
00127       new_handler = this->make_handler ();
00128       if (new_handler == 0)
00129         {
00130           error = 1;
00131           ACE_ERROR ((LM_ERROR,
00132                       ACE_LIB_TEXT ("%p\n"),
00133                       ACE_LIB_TEXT ("ACE_Asynch_Connector::handle_connect : Making of new handler failed")));
00134         }
00135     }
00136 
00137   // If no errors
00138   if (!error)
00139     {
00140       // Update the Proactor.
00141       new_handler->proactor (this->proactor ());
00142 
00143       // Pass the addresses
00144       if (this->pass_addresses_)
00145         new_handler->addresses (remote_address,
00146                                 local_address);
00147 
00148       // Pass the ACT
00149       if (result.act () != 0)
00150         new_handler->act (result.act ());
00151 
00152       // Set up the handler's new handle value
00153       new_handler->handle (result.connect_handle ());
00154 
00155       ACE_Message_Block  mb;
00156 
00157       // Initiate the handler with empty message block;
00158       new_handler->open (result.connect_handle (), mb);
00159     }
00160 
00161   // On failure, no choice but to close the socket
00162   if (error &&
00163       result.connect_handle() != ACE_INVALID_HANDLE)
00164     ACE_OS::closesocket (result.connect_handle ());
00165 }

template<class HANDLER>
HANDLER * ACE_Asynch_Connector< HANDLER >::make_handler (  void    )  [protected, virtual]
 

This is the template method used to create new handler. Subclasses must overwrite this method if a new handler creation strategy is required.

Definition at line 257 of file Asynch_Connector.cpp.

References ACE_NEW_RETURN.

Referenced by handle_connect. 

00258 {
00259   // Default behavior
00260   HANDLER *handler = 0;
00261   ACE_NEW_RETURN (handler, HANDLER, 0);
00262   return handler;
00263 }

template<class HANDLER>
int ACE_Asynch_Connector< HANDLER >::open (  int    pass_addresses = 0,
ACE_Proactor *    proactor = 0,
int    validate_new_connection = 1
)  [virtual]
 

This opens asynch connector

Definition at line 38 of file Asynch_Connector.cpp.

References ACE_ERROR_RETURN, ACE_LIB_TEXT, asynch_connect_, LM_ERROR, ACE_Asynch_Connect::open, pass_addresses, pass_addresses_, ACE_Handler::proactor, validate_new_connection, and validate_new_connection_. 

00041 {
00042   this->proactor (proactor);
00043   this->pass_addresses_ = pass_addresses;
00044   this->validate_new_connection_ = validate_new_connection;
00045 
00046   // Initialize the ACE_Asynch_Connect
00047   if (this->asynch_connect_.open (*this,
00048                                   ACE_INVALID_HANDLE,
00049                                   0,
00050                                   this->proactor ()) == -1)
00051     ACE_ERROR_RETURN ((LM_ERROR,
00052                        ACE_LIB_TEXT ("%p\n"),
00053                        ACE_LIB_TEXT ("ACE_Asynch_Connect::open")),
00054                       -1);
00055   return 0;
00056 }

template<class HANDLER>
void ACE_Asynch_Connector< HANDLER >::parse_address (  const ACE_Asynch_Connect::Result &    result,
ACE_INET_Addr &    remote_address,
ACE_INET_Addr &    local_address
)  [protected]
 

This parses the address from read buffer.

Definition at line 184 of file Asynch_Connector.cpp.

References ACE_DEBUG, ACE_ERROR, ACE_LIB_TEXT, ACE_INET_Addr::addr_to_string, ACE_Asynch_Connect::Result::connect_handle, ACE_OS::getpeername, ACE_OS::getsockname, LM_DEBUG, LM_ERROR, and ACE_INET_Addr::set.

Referenced by handle_connect. 

00187 {
00188   // Getting the addresses.
00189   sockaddr_in local_addr;
00190   sockaddr_in remote_addr;
00191 
00192   // Get the length.
00193   int local_size = sizeof (local_addr);
00194   int remote_size = sizeof (remote_addr);
00195 
00196   // Get the local address.
00197   if (ACE_OS::getsockname (result.connect_handle (),
00198                            ACE_reinterpret_cast (sockaddr *,
00199                                                  &local_addr),
00200                            &local_size) < 0)
00201     ACE_ERROR ((LM_ERROR,
00202                 ACE_LIB_TEXT("%p\n"),
00203                 ACE_LIB_TEXT("ACE_Asynch_Connector::<getsockname> failed")));
00204 
00205   // Get the remote address.
00206   if (ACE_OS::getpeername (result.connect_handle (),
00207                            ACE_reinterpret_cast (sockaddr *,
00208                                                  &remote_addr),
00209                            &remote_size) < 0)
00210     ACE_ERROR ((LM_ERROR,
00211                 ACE_LIB_TEXT("%p\n"),
00212                 ACE_LIB_TEXT("ACE_Asynch_Connector::<getpeername> failed")));
00213 
00214   // Set the addresses.
00215   local_address.set  (&local_addr,  local_size);
00216   remote_address.set (&remote_addr, remote_size);
00217 
00218 #if 0
00219   // @@ Just debugging.
00220   char local_address_buf  [BUFSIZ];
00221   char remote_address_buf [BUFSIZ];
00222 
00223   if (local_address.addr_to_string (local_address_buf,
00224                                     sizeof local_address_buf) == -1)
00225     ACE_ERROR ((LM_ERROR,
00226                 ACE_LIB_TEXT("Error:%p:can't obtain local_address's address string"),
00227                 ACE_LIB_TEXT("ACE_Asynch_Connector::addr_to_string")));
00228 
00229   ACE_DEBUG ((LM_DEBUG,
00230               ACE_LIB_TEXT("ACE_Asynch_Connector<HANDLER>::parse_address : ")
00231               ACE_LIB_TEXT("Local address %s\n"),
00232               local_address_buf));
00233 
00234   if (remote_address.addr_to_string (remote_address_buf,
00235                                      sizeof remote_address_buf) == -1)
00236     ACE_ERROR ((LM_ERROR,
00237                 ACE_LIB_TEXT("Error:%p:can't obtain remote_address's address string", 
00238                 ACE_LIB_TEXT("ACE_Asynch_Connector::addr_to_string(2)"))));
00239 
00240   ACE_DEBUG ((LM_DEBUG,
00241               ACE_LIB_TEXT("ACE_Asynch_Connector<HANDLER>::parse_address : ")
00242               ACE_LIB_TEXT("Remote address %s\n"),
00243               remote_address_buf));
00244 #endif /* 0 */
00245 
00246   return;
00247 }

template<class HANDLER>
void ACE_Asynch_Connector< HANDLER >::pass_addresses (  int    new_value )  [virtual]
 

Definition at line 272 of file Asynch_Connector.cpp.

References pass_addresses_. 

00273 {
00274   this->pass_addresses_ = new_value;
00275 }

template<class HANDLER>
int ACE_Asynch_Connector< HANDLER >::pass_addresses (  void    )  const [virtual]
 

Set and get flag that indicates if parsing and passing of addresses to the service_handler is necessary.

Definition at line 266 of file Asynch_Connector.cpp.

References pass_addresses_.

Referenced by open. 

00267 {
00268   return this->pass_addresses_;
00269 }

template<class HANDLER>
int ACE_Asynch_Connector< HANDLER >::validate_connection (  const ACE_Asynch_Connect::Result &    result,
const ACE_INET_Addr &    remote,
const ACE_INET_Addr &    local
)  [virtual]
 

Template method to validate peer before service is opened. This method is called when the connection attempt completes, whether it succeeded or failed, if the validate_connection argument to open() was non-zero or the validate_new_connection() method is called to turn this feature on. The default implementation returns 0. Users can (and probably should) reimplement this method to learn about the success or failure of the connection attempt. If the connection completed successfully, this method can be used to perform validation of the peer using it's address, running an authentication procedure (such as SSL) or anything else necessary or desireable. The return value from this method determines whether or not ACE will continue opening the service or abort the connection.

Parameters:
result  Result of the connection acceptance. Use result.success() to determine success or failure of the connection attempt.
remote  Peer's address. If the connection failed, this object is undefined.
local  Local address connection was completed from. If the connection failed, this object is undefined.
Return values:
-1  ACE_Asynch_Connector will close the connection, and the service will not be opened.
0  Service opening will proceeed.
Returns:
Return value is ignored if the connection attempt failed.

Definition at line 169 of file Asynch_Connector.cpp.

Referenced by handle_connect. 

00172 {
00173   // Default implementation always validates the remote address.
00174   return 0;
00175 }

template<class HANDLER>
void ACE_Asynch_Connector< HANDLER >::validate_new_connection (  int    new_value )  [virtual]
 

Definition at line 284 of file Asynch_Connector.cpp.

References validate_new_connection_. 

00285 {
00286   this->validate_new_connection_ = new_value;
00287 }

template<class HANDLER>
int ACE_Asynch_Connector< HANDLER >::validate_new_connection (  void    )  const [virtual]
 

Set and get flag that indicates if address validation is required.

Definition at line 278 of file Asynch_Connector.cpp.

References validate_new_connection_.

Referenced by open. 

00279 {
00280   return this->validate_new_connection_;
00281 }

Member Data Documentation

template<class HANDLER>
ACE_Asynch_Connect ACE_Asynch_Connector::asynch_connect_ [private]
 

Asynch_Connect used to make life easier :-).

Definition at line 149 of file Asynch_Connector.h.

Referenced by asynch_connect, cancel, connect, and open.

template<class HANDLER>
int ACE_Asynch_Connector::pass_addresses_ [private]
 

Flag that indicates if parsing of addresses is necessary.

Definition at line 152 of file Asynch_Connector.h.

Referenced by handle_connect, open, and pass_addresses.

template<class HANDLER>
int ACE_Asynch_Connector::validate_new_connection_ [private]
 

Flag that indicates if address validation is required.

Definition at line 155 of file Asynch_Connector.h.

Referenced by handle_connect, open, and validate_new_connection.

The documentation for this class was generated from the following files:
Generated on Mon Jun 16 12:45:12 2003 for ACE by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002