diff options
Diffstat (limited to 'ACE/ace/SPIPE_Connector.h')
-rw-r--r-- | ACE/ace/SPIPE_Connector.h | 118 |
1 files changed, 118 insertions, 0 deletions
diff --git a/ACE/ace/SPIPE_Connector.h b/ACE/ace/SPIPE_Connector.h new file mode 100644 index 00000000000..f9fc2455ecc --- /dev/null +++ b/ACE/ace/SPIPE_Connector.h @@ -0,0 +1,118 @@ +// -*- C++ -*- + +//============================================================================= +/** + * @file SPIPE_Connector.h + * + * $Id$ + * + * @author Doug Schmidt <schmidt@cs.wustl.edu> + * @author Prashant Jain <pjain@cs.wustl.edu> + */ +//============================================================================= + +#ifndef ACE_SPIPE_CONNECTOR_H +#define ACE_SPIPE_CONNECTOR_H +#include /**/ "ace/pre.h" + +#include "ace/SPIPE_Stream.h" +#include "ace/os_include/os_fcntl.h" + +#if !defined (ACE_LACKS_PRAGMA_ONCE) +# pragma once +#endif /* ACE_LACKS_PRAGMA_ONCE */ + +ACE_BEGIN_VERSIONED_NAMESPACE_DECL + +/** + * @class ACE_SPIPE_Connector + * + * @brief Defines an active connection factory for <ACE_SPIPE_Stream>. + * On Windows this is mapped to Named Pipes, whereas on UNIX it is + * mapped to STREAM pipes. + */ +class ACE_Export ACE_SPIPE_Connector +{ +public: + // = Initialization method. + /// Default constructor. + ACE_SPIPE_Connector (void); + + /** + * 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 maximum 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. The <pipe_mode> argument is only used in NT and is used to + * establish the NT pipe mode. + */ + ACE_SPIPE_Connector (ACE_SPIPE_Stream &new_io, + const ACE_SPIPE_Addr &remote_sap, + ACE_Time_Value *timeout = 0, + const ACE_Addr &local_sap = ACE_Addr::sap_any, + int reuse_addr = 0, + int flags = O_RDWR, + int perms = 0, + LPSECURITY_ATTRIBUTES sa = 0, + int pipe_mode = PIPE_READMODE_MESSAGE | PIPE_WAIT); + + /** + * 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 maximum 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. The <pipe_mode> argument is only used in NT and is used to + * establish the NT pipe mode. + */ + int connect (ACE_SPIPE_Stream &new_io, + const ACE_SPIPE_Addr &remote_sap, + ACE_Time_Value *timeout = 0, + const ACE_Addr &local_sap = ACE_Addr::sap_any, + int reuse_addr = 0, + int flags = O_RDWR, + int perms = 0, + LPSECURITY_ATTRIBUTES sa = 0, + int pipe_mode = PIPE_READMODE_MESSAGE | PIPE_WAIT); + + /// Resets any event associations on this handle + int reset_new_handle (ACE_HANDLE handle); + + // = Meta-type info + typedef ACE_SPIPE_Addr PEER_ADDR; + typedef ACE_SPIPE_Stream PEER_STREAM; + + /// Dump the state of an object. + void dump (void) const; + + /// Declare the dynamic allocation hooks. + ACE_ALLOC_HOOK_DECLARE; +}; + +ACE_END_VERSIONED_NAMESPACE_DECL + +#if defined (__ACE_INLINE__) +#include "ace/SPIPE_Connector.inl" +#endif /* __ACE_INLINE__ */ + +#include /**/ "ace/post.h" +#endif /* ACE_SPIPE_CONNECTOR_H */ |