diff options
Diffstat (limited to 'ace/TLI_Connector.h')
| -rw-r--r-- | ace/TLI_Connector.h | 110 |
1 files changed, 58 insertions, 52 deletions
diff --git a/ace/TLI_Connector.h b/ace/TLI_Connector.h index 14417454ddb..35a8e1b0253 100644 --- a/ace/TLI_Connector.h +++ b/ace/TLI_Connector.h @@ -1,18 +1,15 @@ /* -*- C++ -*- */ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// ace -// -// = FILENAME -// TLI_Connector.h -// -// = AUTHOR -// Doug Schmidt -// -// ============================================================================ + +//============================================================================= +/** + * @file TLI_Connector.h + * + * $Id$ + * + * @author Doug Schmidt + */ +//============================================================================= + #ifndef ACE_TLI_CONNECTOR_H #define ACE_TLI_CONNECTOR_H @@ -27,16 +24,34 @@ #if defined (ACE_HAS_TLI) -class ACE_Export ACE_TLI_Connector +/** + * @class ACE_TLI_Connector + * + * @brief Defines an active connection factory for the ACE_TLI C++ + * wrappers. + */ +class ACE_Export ACE_TLI_Connector { - // = TITLE - // Defines an active connection factory for the ACE_TLI C++ - // wrappers. public: // = Initialization methods. + /// Default constructor. ACE_TLI_Connector (void); - // Default constructor. + /** + * Actively connect and produce a <new_stream> if things go well. + * The <remote_sap> is the address that we are trying to connect + * with. The <timeout> is the amount of time to wait to connect. + * If it's 0 then we block indefinitely. If *timeout == {0, 0} then + * the connection is done using non-blocking mode. In this case, if + * the connection can't be made immediately the value of -1 is + * returned with <errno == EWOULDBLOCK>. If *timeout > {0, 0} then + * this is the amount of time to wait before timing out. If the + * time expires before the connection is made <errno == ETIME>. The + * <local_sap> is the value of local address to bind to. If it's + * the default value of <ACE_Addr::sap_any> then the user is letting + * the OS do the binding. If <reuse_addr> == 1 then the + * <local_addr> is reused, even if it hasn't been cleanedup yet. + */ ACE_TLI_Connector (ACE_TLI_Stream &new_stream, const ACE_Addr &remote_sap, ACE_Time_Value *timeout = 0, @@ -49,20 +64,22 @@ public: int rw_flag = 1, struct netbuf *udata = 0, struct netbuf *opt = 0); - // Actively connect and produce a <new_stream> if things go well. - // The <remote_sap> is the address that we are trying to connect - // with. The <timeout> is the amount of time to wait to connect. - // If it's 0 then we block indefinitely. If *timeout == {0, 0} then - // the connection is done using non-blocking mode. In this case, if - // the connection can't be made immediately the value of -1 is - // returned with <errno == EWOULDBLOCK>. If *timeout > {0, 0} then - // this is the amount of time to wait before timing out. If the - // time expires before the connection is made <errno == ETIME>. The - // <local_sap> is the value of local address to bind to. If it's - // the default value of <ACE_Addr::sap_any> then the user is letting - // the OS do the binding. If <reuse_addr> == 1 then the - // <local_addr> is reused, even if it hasn't been cleanedup yet. + /** + * Actively connect and produce a <new_stream> if things go well. + * The <remote_sap> is the address that we are trying to connect + * with. The <timeout> is the amount of time to wait to connect. + * If it's 0 then we block indefinitely. If *timeout == {0, 0} then + * the connection is done using non-blocking mode. In this case, if + * the connection can't be made immediately the value of -1 is + * returned with <errno == EWOULDBLOCK>. If *timeout > {0, 0} then + * this is the amount of time to wait before timing out. If the + * time expires before the connection is made <errno == ETIME>. The + * <local_sap> is the value of local address to bind to. If it's + * the default value of <ACE_Addr::sap_any> then the user is letting + * the OS do the binding. If <reuse_addr> == 1 then the + * <local_addr> is reused, even if it hasn't been cleanedup yet. + */ int connect (ACE_TLI_Stream &new_stream, const ACE_Addr &remote_sap, ACE_Time_Value *timeout = 0, @@ -75,40 +92,29 @@ public: int rw_flag = 1, struct netbuf *udata = 0, struct netbuf *opt = 0); - // Actively connect and produce a <new_stream> if things go well. - // The <remote_sap> is the address that we are trying to connect - // with. The <timeout> is the amount of time to wait to connect. - // If it's 0 then we block indefinitely. If *timeout == {0, 0} then - // the connection is done using non-blocking mode. In this case, if - // the connection can't be made immediately the value of -1 is - // returned with <errno == EWOULDBLOCK>. If *timeout > {0, 0} then - // this is the amount of time to wait before timing out. If the - // time expires before the connection is made <errno == ETIME>. The - // <local_sap> is the value of local address to bind to. If it's - // the default value of <ACE_Addr::sap_any> then the user is letting - // the OS do the binding. If <reuse_addr> == 1 then the - // <local_addr> is reused, even if it hasn't been cleanedup yet. + /** + * Try to complete a non-blocking connection. + * If connection completion is successful then <new_stream> contains + * the connected ACE_SOCK_Stream. If <remote_sap> is non-NULL then it + * will contain the address of the connected peer. + */ int complete (ACE_TLI_Stream &new_stream, ACE_Addr *remote_sap, ACE_Time_Value *tv); - // Try to complete a non-blocking connection. - // If connection completion is successful then <new_stream> contains - // the connected ACE_SOCK_Stream. If <remote_sap> is non-NULL then it - // will contain the address of the connected peer. + /// Resets any event associations on this handle int reset_new_handle (ACE_HANDLE handle); - // Resets any event associations on this handle // = Meta-type info typedef ACE_INET_Addr PEER_ADDR; typedef ACE_TLI_Stream PEER_STREAM; + /// Dump the state of an object. void dump (void) const; - // Dump the state of an object. + /// Declare the dynamic allocation hooks. ACE_ALLOC_HOOK_DECLARE; - // Declare the dynamic allocation hooks. }; #if defined (__ACE_INLINE__) |