dep/ACE_wrappers/ace/LSOCK_Connector.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file    LSOCK_Connector.h
   6  *
   7  *  $Id: LSOCK_Connector.h 80826 2008-03-04 14:51:23Z wotte $
   8  *
   9  *  @author Doug Schmidt <schmidt@cs.wustl.edu>
  10  */
  11 //=============================================================================
  12
  13 #ifndef ACE_LOCAL_SOCK_CONNECTOR_H
  14 #define ACE_LOCAL_SOCK_CONNECTOR_H
  15 #include /**/ "ace/pre.h"
  16
  17 #include /**/ "ace/config-all.h"
  18
  19 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  20 # pragma once
  21 #endif /* ACE_LACKS_PRAGMA_ONCE */
  22
  23 #if !defined (ACE_LACKS_UNIX_DOMAIN_SOCKETS)
  24
  25 #include "ace/SOCK_Connector.h"
  26 #include "ace/LSOCK_Stream.h"
  27 #include "ace/UNIX_Addr.h"
  28
  29 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  30
  31 /**
  32  * @class ACE_LSOCK_Connector
  33  *
  34  * @brief Defines the format and interface for the connector side of
  35  * the ACE_LSOCK_Stream.
  36  */
  37 class ACE_Export ACE_LSOCK_Connector : public ACE_SOCK_Connector
  38 {
  39 public:
  40   // = Initialization methods.
  41   /// Default constructor.
  42   ACE_LSOCK_Connector (void);
  43
  44   /**
  45    * Actively connect and produce a @a new_stream if things go well.
  46    * All arguments are relayed to the ACE_SOCK_Connector constructor
  47    * for handling.
  48    * @see ACE_SOCK_Connector().
  49    */
  50   ACE_LSOCK_Connector (ACE_LSOCK_Stream &new_stream,
  51                        const ACE_UNIX_Addr &remote_sap,
  52                        ACE_Time_Value *timeout = 0,
  53                        const ACE_Addr &local_sap = ACE_Addr::sap_any,
  54                        int reuse_addr = 0,
  55                        int flags = 0,
  56                        int perms = 0);
  57
  58   /**
  59    * Actively connect and produce a @a new_stream if things go well.
  60    * The @c ACE_SOCK_Connector::connect() method is called to perform
  61    * the actual connection attempt.
  62    * @see ACE_SOCK_Connector::connect().
  63    */
  64   int connect (ACE_LSOCK_Stream &new_stream,
  65                const ACE_UNIX_Addr &remote_sap,
  66                ACE_Time_Value *timeout = 0,
  67                const ACE_Addr &local_sap = ACE_Addr::sap_any,
  68                int reuse_addr = 0,
  69                int flags = 0,
  70                int perms = 0);
  71
  72   // = Meta-type info
  73   typedef ACE_UNIX_Addr PEER_ADDR;
  74   typedef ACE_LSOCK_Stream PEER_STREAM;
  75
  76   /// Dump the state of an object.
  77   void dump (void) const;
  78
  79   /// Declare the dynamic allocation hooks.
  80   ACE_ALLOC_HOOK_DECLARE;
  81 };
  82
  83 ACE_END_VERSIONED_NAMESPACE_DECL
  84
  85 #if defined (__ACE_INLINE__)
  86 #include "ace/LSOCK_Connector.inl"
  87 #endif /* __ACE_INLINE__ */
  88
  89 #endif /* ACE_LACKS_UNIX_DOMAIN_SOCKETS */
  90 #include /**/ "ace/post.h"
  91 #endif /* ACE_LOCAL_SOCK_CONNECTOR_H */