summaryrefslogtreecommitdiff
path: root/trunk/TAO/tao/Asynch_Queued_Message.h
diff options
context:
space:
mode:
Diffstat (limited to 'trunk/TAO/tao/Asynch_Queued_Message.h')
-rw-r--r--trunk/TAO/tao/Asynch_Queued_Message.h123
1 files changed, 123 insertions, 0 deletions
diff --git a/trunk/TAO/tao/Asynch_Queued_Message.h b/trunk/TAO/tao/Asynch_Queued_Message.h
new file mode 100644
index 00000000000..a00875866d7
--- /dev/null
+++ b/trunk/TAO/tao/Asynch_Queued_Message.h
@@ -0,0 +1,123 @@
+// -*- C++ -*-
+
+//=============================================================================
+/**
+ * @file Asynch_Queued_Message.h
+ *
+ * $Id$
+ *
+ * @author Carlos O'Ryan <coryan@uci.edu>
+ */
+//=============================================================================
+
+#ifndef TAO_ASYNCH_QUEUED_MESSAGE_H
+#define TAO_ASYNCH_QUEUED_MESSAGE_H
+
+#include /**/ "ace/pre.h"
+
+#include "tao/Queued_Message.h"
+
+#include "ace/Time_Value.h"
+
+#if !defined (ACE_LACKS_PRAGMA_ONCE)
+# pragma once
+#endif /* ACE_LACKS_PRAGMA_ONCE */
+
+ACE_BEGIN_VERSIONED_NAMESPACE_DECL
+class ACE_Message_Block;
+ACE_END_VERSIONED_NAMESPACE_DECL
+
+TAO_BEGIN_VERSIONED_NAMESPACE_DECL
+
+/**
+ * @class TAO_Asynch_Queued_Message
+ *
+ * @brief Specialize TAO_Queued_Message for asynch requests,
+ * i.e. oneways sent with SYNC_NONE policy.
+ *
+ */
+class TAO_Export TAO_Asynch_Queued_Message : public TAO_Queued_Message
+{
+public:
+ /// Constructor
+ /**
+ * @param contents The message block chain that must be sent.
+ *
+ * @param alloc Allocator used for creating @c this object.
+ *
+ * @param timeout The relative timeout after which this
+ * message should be expired.
+ *
+ * @todo I'm almost sure this class will require a callback
+ * interface for AMIs sent with SYNC_NONE policy. Those guys
+ * need to hear when the connection timeouts or closes, but
+ * cannot block waiting for the message to be delivered.
+ */
+ TAO_Asynch_Queued_Message (const ACE_Message_Block *contents,
+ TAO_ORB_Core *oc,
+ ACE_Time_Value *timeout,
+ ACE_Allocator *alloc = 0,
+ bool is_heap_allocated = false);
+
+
+ /// Destructor
+ virtual ~TAO_Asynch_Queued_Message (void);
+
+ /**
+ * @name Implement the Template Methods from TAO_Queued_Message
+ */
+ //@{
+ virtual size_t message_length (void) const;
+ virtual int all_data_sent (void) const;
+ virtual void fill_iov (int iovcnt_max, int &iovcnt, iovec iov[]) const;
+ virtual void bytes_transferred (size_t &byte_count);
+ /// @note No reason to believe why this would be called. But have
+ /// it here for the sake of uniformity.
+ virtual TAO_Queued_Message *clone (ACE_Allocator *alloc);
+ virtual void destroy (void);
+ virtual bool is_expired (const ACE_Time_Value &now) const;
+ //@}
+
+protected:
+ /// Constructor
+ /**
+ * @param buf The buffer that needs to be sent on the wire. The
+ * buffer will be owned by this class. The buffer will be
+ * deleted when the destructor is called and hence the
+ * buffer should always come off the heap!
+ *
+ * @param size The size of the buffer <buf> that is being handed
+ * over.
+ *
+ * @param abs_timeout The time after which this message should be expired.
+ *
+ * @param alloc Allocator used for creating <this> object.
+ */
+ TAO_Asynch_Queued_Message (char *buf,
+ TAO_ORB_Core *oc,
+ size_t size,
+ const ACE_Time_Value &abs_timeout,
+ ACE_Allocator *alloc = 0);
+private:
+ /// The number of bytes in the buffer
+ const size_t size_;
+
+ /// The offset in the buffer
+ /**
+ * Data up to @c offset has been sent already, only the
+ * [offset_,size_) range remains to be sent.
+ */
+ size_t offset_;
+
+ /// The buffer containing the complete message.
+ char *buffer_;
+
+ // Expiration time
+ ACE_Time_Value abs_timeout_;
+
+};
+
+TAO_END_VERSIONED_NAMESPACE_DECL
+
+#include /**/ "ace/post.h"
+#endif /* TAO_ASYNCH_QUEUED_MESSAGE_H */