ACE/ace/XTI_ATM_Mcast.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file    XTI_ATM_Mcast.h
   6  *
   7  *  @author Joe Hoffert
   8  */
   9 //=============================================================================
  10
  11
  12 #ifndef ACE_XTI_ATM_MCAST_H
  13 #define ACE_XTI_ATM_MCAST_H
  14 #include /**/ "ace/pre.h"
  15
  16 #include /**/ "ace/config-all.h"
  17
  18 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  19 #pragma once
  20 #endif /* ACE_LACKS_PRAGMA_ONCE */
  21
  22 #if defined (ACE_HAS_XTI_ATM)
  23
  24 #include "ace/TLI_Connector.h"
  25 #include "ace/ATM_Addr.h"
  26
  27 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  28
  29 /**
  30  * @class ACE_XTI_ATM_Mcast
  31  *
  32  * @brief Defines an active connection factory for the ACE_TLI C++
  33  * wrappers to support XTI/ATM multicast.
  34  */
  35 class ACE_Export ACE_XTI_ATM_Mcast : public ACE_TLI_Connector
  36 {
  37 public:
  38   /// Default constructor.
  39   ACE_XTI_ATM_Mcast ();
  40
  41   /**
  42    * Actively connect and produce a @a new_stream if things go well.
  43    * The @a remote_sap is the address that we are trying to connect
  44    * with.  The @a timeout is the amount of time to wait to connect.
  45    * If it's 0 then we block indefinitely.  If *timeout == {0, 0} then
  46    * the connection is done using non-blocking mode.  In this case, if
  47    * the connection can't be made immediately the value of -1 is
  48    * returned with @c errno == EWOULDBLOCK.  If *timeout > {0, 0} then
  49    * this is the amount of time to wait before timing out.  If the
  50    * time expires before the connection is made @c errno == ETIME.  The
  51    * @a local_sap is the value of local address to bind to.  If it's
  52    * the default value of ACE_Addr::sap_any then the user is letting
  53    * the OS do the binding.  If @a reuse_addr == 1 then the
  54    * <local_addr> is reused, even if it hasn't been cleanedup yet.
  55    */
  56   ACE_XTI_ATM_Mcast (ACE_TLI_Stream &new_stream,
  57                      const ACE_Addr &remote_sap,
  58                      ACE_Time_Value *timeout = 0,
  59                      const ACE_Addr &local_sap = ACE_Addr::sap_any,
  60                      int reuse_addr = 0,
  61                      int flags = O_RDWR,
  62                      int perms = 0,
  63                      const char device[] = ACE_XTI_ATM_DEVICE,
  64                      struct t_info *info = 0,
  65                      int rw_flag = 1,
  66                      struct netbuf *udata = 0,
  67                      struct netbuf *opt = 0);
  68
  69   /**
  70    * Actively connect and produce a @a new_stream if things go well.
  71    * The @a remote_sap is the address that we are trying to connect
  72    * with.  The @a timeout is the amount of time to wait to connect.
  73    * If it's 0 then we block indefinitely.  If *timeout == {0, 0} then
  74    * the connection is done using non-blocking mode.  In this case, if
  75    * the connection can't be made immediately the value of -1 is
  76    * returned with @c errno == EWOULDBLOCK.  If *timeout > {0, 0} then
  77    * this is the amount of time to wait before timing out.  If the
  78    * time expires before the connection is made @c errno == ETIME.  The
  79    * @a local_sap is the value of local address to bind to.  If it's
  80    * the default value of ACE_Addr::sap_any then the user is letting
  81    * the OS do the binding.  If @a reuse_addr == 1 then the
  82    * <local_addr> is reused, even if it hasn't been cleanedup yet.
  83    */
  84   int connect (ACE_TLI_Stream &new_stream,
  85                const ACE_Addr &remote_sap,
  86                ACE_Time_Value *timeout = 0,
  87                const ACE_Addr &local_sap = ACE_Addr::sap_any,
  88                int reuse_addr = 0,
  89                int flags = O_RDWR,
  90                int perms = 0,
  91                const char device[] = ACE_XTI_ATM_DEVICE,
  92                struct t_info *info = 0,
  93                int rw_flag = 1,
  94                struct netbuf *udata = 0,
  95                struct netbuf *opt = 0);
  96
  97   /**
  98    * Actively add a leaf to the currently connected stream (i.e.,
  99    * multicast). The @a remote_sap is the address of the leaf that we
 100    * are trying to add. The @a timeout is the amount of time to wait to
 101    * connect. If it's 0 then we block indefinitely.  If *timeout ==
 102    * {0, 0} then the connection is done using non-blocking mode.  In
 103    * this case, if the connection can't be made immediately the value
 104    * of -1 is returned with @c errno == EWOULDBLOCK.  If *timeout >
 105    * {0, 0} then this is the amount of time to wait before timing out.
 106    * If the time expires before the connection is made @c errno == ETIME.
 107    */
 108   int add_leaf (ACE_TLI_Stream &current_stream,
 109                 const ACE_Addr &remote_sap,
 110                 ACE_INT32 leaf_id,
 111                 ACE_Time_Value *timeout = 0);
 112
 113   // = Meta-type info
 114   typedef ACE_ATM_Addr PEER_ADDR;
 115   typedef ACE_TLI_Stream PEER_STREAM;
 116
 117   /// Dump the state of an object.
 118   void dump () const;
 119
 120   /// Declare the dynamic allocation hooks.
 121   ACE_ALLOC_HOOK_DECLARE;
 122 };
 123
 124 ACE_END_VERSIONED_NAMESPACE_DECL
 125
 126 #if defined (__ACE_INLINE__)
 127 #include "ace/XTI_ATM_Mcast.inl"
 128 #endif /* __ACE_INLINE__ */
 129
 130 #endif /* ACE_HAS_XTI_ATM */
 131
 132 #include /**/ "ace/post.h"
 133
 134 #endif /* ACE_XTI_ATM_MCAST_H */