TAO/tao/Asynch_Queued_Message.h

   1 // -*- C++ -*-
   2
   3 //=============================================================================
   4 /**
   5  *  @file Asynch_Queued_Message.h
   6  *
   7  *  @author Carlos O'Ryan <coryan@uci.edu>
   8  */
   9 //=============================================================================
  10
  11 #ifndef TAO_ASYNCH_QUEUED_MESSAGE_H
  12 #define TAO_ASYNCH_QUEUED_MESSAGE_H
  13
  14 #include /**/ "ace/pre.h"
  15
  16 #include "tao/Queued_Message.h"
  17
  18 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  19 # pragma once
  20 #endif /* ACE_LACKS_PRAGMA_ONCE */
  21
  22 #include "ace/Time_Value.h"
  23
  24 ACE_BEGIN_VERSIONED_NAMESPACE_DECL
  25 class ACE_Message_Block;
  26 ACE_END_VERSIONED_NAMESPACE_DECL
  27
  28 TAO_BEGIN_VERSIONED_NAMESPACE_DECL
  29
  30 /**
  31  * @class TAO_Asynch_Queued_Message
  32  *
  33  * @brief Specialize TAO_Queued_Message for asynch requests,
  34  *        i.e. oneways sent with SYNC_NONE policy.
  35  */
  36 class TAO_Export TAO_Asynch_Queued_Message : public TAO_Queued_Message
  37 {
  38 public:
  39   /// Constructor
  40   /**
  41    * @param contents The message block chain that must be sent.
  42    *
  43    * @param alloc Allocator used for creating @c this object.
  44    *
  45    * @param timeout The relative timeout after which this
  46    * message should be expired.
  47    *
  48    * @todo I'm almost sure this class will require a callback
  49    *       interface for AMIs sent with SYNC_NONE policy.  Those guys
  50    *       need to hear when the connection timeouts or closes, but
  51    *       cannot block waiting for the message to be delivered.
  52    */
  53   TAO_Asynch_Queued_Message (const ACE_Message_Block *contents,
  54                              TAO_ORB_Core *oc,
  55                              ACE_Time_Value *timeout,
  56                              ACE_Allocator *alloc,
  57                              bool is_heap_allocated);
  58
  59
  60   /// Destructor
  61   virtual ~TAO_Asynch_Queued_Message ();
  62
  63   /**
  64    * @name Implement the Template Methods from TAO_Queued_Message
  65    */
  66   //@{
  67   virtual size_t message_length () const;
  68   virtual int all_data_sent () const;
  69   virtual void fill_iov (int iovcnt_max, int &iovcnt, iovec iov[]) const;
  70   virtual void bytes_transferred (size_t &byte_count);
  71   /// @note No reason to believe why this would be called. But have
  72   /// it here for the sake of uniformity.
  73   virtual TAO_Queued_Message *clone (ACE_Allocator *alloc);
  74   virtual void destroy ();
  75   virtual bool is_expired (const ACE_Time_Value &now) const;
  76   virtual void copy_if_necessary (const ACE_Message_Block* chain);
  77   //@}
  78
  79 protected:
  80   /// Constructor
  81   /**
  82    * @param buf The buffer that needs to be sent on the wire. The
  83    *            buffer will be owned by this class. The buffer will be
  84    *            deleted when the destructor is called and hence the
  85    *            buffer should always come off the heap!
  86    *
  87    * @param oc The ORB Core
  88    *
  89    * @param size The size of the buffer <buf> that is being handed
  90    *             over.
  91    *
  92    * @param abs_timeout The time after which this  message should be expired.
  93    *
  94    * @param alloc Allocator used for creating <this> object.
  95    */
  96   TAO_Asynch_Queued_Message (char *buf,
  97                              TAO_ORB_Core *oc,
  98                              size_t size,
  99                              const ACE_Time_Value &abs_timeout,
 100                              ACE_Allocator *alloc,
 101                              bool is_heap_allocated);
 102
 103 private:
 104   void operator= (const TAO_Asynch_Queued_Message &);
 105   TAO_Asynch_Queued_Message (const TAO_Asynch_Queued_Message &);
 106
 107 private:
 108   /// The number of bytes in the buffer
 109   size_t const size_;
 110
 111   /// The offset in the buffer
 112   /**
 113    * Data up to @c offset has been sent already, only the
 114    * [offset_,size_) range remains to be sent.
 115    */
 116   size_t offset_;
 117
 118   /// The buffer containing the complete message.
 119   char *buffer_;
 120
 121   // Expiration time
 122   ACE_Time_Value abs_timeout_;
 123 };
 124
 125 TAO_END_VERSIONED_NAMESPACE_DECL
 126
 127 #include /**/ "ace/post.h"
 128 #endif  /* TAO_ASYNCH_QUEUED_MESSAGE_H */