summaryrefslogtreecommitdiff
path: root/TAO/tao/Reply_Dispatcher.h
diff options
context:
space:
mode:
Diffstat (limited to 'TAO/tao/Reply_Dispatcher.h')
-rw-r--r--TAO/tao/Reply_Dispatcher.h100
1 files changed, 100 insertions, 0 deletions
diff --git a/TAO/tao/Reply_Dispatcher.h b/TAO/tao/Reply_Dispatcher.h
new file mode 100644
index 00000000000..a6f61f5e7a8
--- /dev/null
+++ b/TAO/tao/Reply_Dispatcher.h
@@ -0,0 +1,100 @@
+// -*- C++ -*-
+
+//=============================================================================
+/**
+ * @file Reply_Dispatcher.h
+ *
+ * $Id$
+ *
+ * Define the interface for the Reply_Dispatcher strategies.
+ *
+ *
+ * @author Alexander Babu Arulanthu <alex@cs.wustl.edu>
+ */
+//=============================================================================
+
+#ifndef TAO_REPLY_DISPATCHER_H
+#define TAO_REPLY_DISPATCHER_H
+
+#include /**/ "ace/pre.h"
+
+#include /**/ "tao/TAO_Export.h"
+
+#if !defined (ACE_LACKS_PRAGMA_ONCE)
+# pragma once
+#endif /* ACE_LACKS_PRAGMA_ONCE */
+
+#include "tao/Basic_Types.h"
+
+TAO_BEGIN_VERSIONED_NAMESPACE_DECL
+
+// Forward Declarations.
+class TAO_GIOP_Message_State;
+class TAO_GIOP_Message_Version;
+class TAO_Transport;
+class TAO_Pluggable_Reply_Params;
+
+/**
+ * @class TAO_Reply_Dispatcher
+ *
+ *
+ * Different invocation modes process the Reply messages in
+ * different ways. Traditional synchronous replies simply receive
+ * the message and wake up the waiting thread (if any).
+ * Asynchronous Method Invocation (Callbacks) must process the
+ * message in the thread that receives it.
+ * Deferred Synchronous (DII) and AMI in the Poller mode save the
+ * reply for later processing in the application.
+ * The lower level components in the ORB only deal with this
+ * abstract interface, when the invocation is made the right type
+ * of Reply Dispatcher is instantiated and registered with the
+ * Transport object.
+ */
+class TAO_Export TAO_Reply_Dispatcher
+{
+
+public:
+ /// Constructor.
+ TAO_Reply_Dispatcher (void);
+
+ /// Destructor.
+ virtual ~TAO_Reply_Dispatcher (void);
+
+ /**
+ * Dispatch the reply. Return 1 on sucess, -1 on error.
+ * @todo Pluggable Messaging: this method has too many arguments,
+ * the "Right Thing"[tm] is for the Transport Object to create a
+ * "ClientReply" that encapsulates all we need to process a
+ * reply. Naturally it is possible that different messaging
+ * protocols implement different variants of such ClientReply
+ * class.
+ */
+ virtual int dispatch_reply (TAO_Pluggable_Reply_Params &params) = 0;
+
+ /**
+ * The used for the pending reply has been closed.
+ * No reply is expected.
+ * @todo If the connection was closed due to a CloseConnection
+ * message then we could re-issue the request instead of raising
+ * the exception, it would a matter of simply adding a boolean
+ * argument to this function.
+ */
+ virtual void connection_closed (void) = 0;
+
+ /// Get the reply status.
+ CORBA::ULong reply_status (void) const;
+
+protected:
+ /// Reply or LocateReply status.
+ CORBA::ULong reply_status_;
+};
+
+TAO_END_VERSIONED_NAMESPACE_DECL
+
+#if defined (__ACE_INLINE__)
+#include "tao/Reply_Dispatcher.inl"
+#endif /* __ACE_INLINE__ */
+
+#include /**/ "ace/post.h"
+
+#endif /* TAO_REPLY_DISPATCHER_H */