diff options
Diffstat (limited to 'ace/DEV_Connector.h')
| -rw-r--r-- | ace/DEV_Connector.h | 104 |
1 files changed, 54 insertions, 50 deletions
diff --git a/ace/DEV_Connector.h b/ace/DEV_Connector.h index bd2c7ad93ab..83aafe6fe83 100644 --- a/ace/DEV_Connector.h +++ b/ace/DEV_Connector.h @@ -1,18 +1,15 @@ /* -*- C++ -*- */ -// $Id$ -// ============================================================================ -// -// = LIBRARY -// ace -// -// = FILENAME -// DEV_Connector.h -// -// = AUTHOR -// Gerhard Lenzer and Douglas C. Schmidt -// -// ============================================================================ +//============================================================================= +/** + * @file DEV_Connector.h + * + * $Id$ + * + * @author Gerhard Lenzer and Douglas C. Schmidt + */ +//============================================================================= + #ifndef ACE_DEV_CONNECTOR_H #define ACE_DEV_CONNECTOR_H @@ -25,14 +22,34 @@ # pragma once #endif /* ACE_LACKS_PRAGMA_ONCE */ -class ACE_Export ACE_DEV_Connector +/** + * @class ACE_DEV_Connector + * + * @brief Defines an active connection factory for the ACE_DEV wrappers. + */ +class ACE_Export ACE_DEV_Connector { - // = TITLE - // Defines an active connection factory for the ACE_DEV wrappers. public: + /// Default constructor. ACE_DEV_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. + * The <flags> and <perms> arguments are passed down to the <open> + * method. + */ ACE_DEV_Connector (ACE_DEV_IO &new_io, const ACE_DEV_Addr &remote_sap, ACE_Time_Value *timeout = 0, @@ -40,22 +57,24 @@ public: int reuse_addr = 0, int flags = O_RDWR, int perms = 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. - // The <flags> and <perms> arguments are passed down to the <open> - // method. + /** + * 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. + * The <flags> and <perms> arguments are passed down to the <open> + * method. + */ int connect (ACE_DEV_IO &new_io, const ACE_DEV_Addr &remote_sap, ACE_Time_Value *timeout = 0, @@ -63,30 +82,15 @@ public: int reuse_addr = 0, int flags = O_RDWR, int perms = 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. - // The <flags> and <perms> arguments are passed down to the <open> - // method. + /// Resets any event associations on this handle int reset_new_handle (ACE_HANDLE handle); - // Resets any event associations on this handle + /// 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. // = Meta-type info typedef ACE_DEV_Addr PEER_ADDR; |