summaryrefslogtreecommitdiff
path: root/TAO/tao/GIOP_Fragmentation_Strategy.h
diff options
context:
space:
mode:
Diffstat (limited to 'TAO/tao/GIOP_Fragmentation_Strategy.h')
-rw-r--r--TAO/tao/GIOP_Fragmentation_Strategy.h85
1 files changed, 85 insertions, 0 deletions
diff --git a/TAO/tao/GIOP_Fragmentation_Strategy.h b/TAO/tao/GIOP_Fragmentation_Strategy.h
new file mode 100644
index 00000000000..26421c72fce
--- /dev/null
+++ b/TAO/tao/GIOP_Fragmentation_Strategy.h
@@ -0,0 +1,85 @@
+// -*- C++ -*-
+
+//=============================================================================
+/**
+ * @file GIOP_Fragmentation_Strategy.h
+ *
+ * $Id$
+ *
+ * @author Ossama Othman <ossama@dre.vanderbilt.edu>
+ */
+//=============================================================================
+
+#ifndef TAO_GIOP_FRAGMENTATION_STRATEGY_H
+#define TAO_GIOP_FRAGMENTATION_STRATEGY_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/orbconf.h"
+#include "ace/CDR_Base.h"
+
+TAO_BEGIN_VERSIONED_NAMESPACE_DECL
+
+class TAO_OutputCDR;
+
+/**
+ * @class TAO_GIOP_Fragmenation_Strategy
+ *
+ * @brief Abstract base class that defines TAO fragmentation strategy
+ * interface.
+ *
+ * GIOP message fragmentation is deferred to a fragmentation strategy
+ */
+class TAO_Export TAO_GIOP_Fragmentation_Strategy
+{
+public:
+
+ /// Constructor
+ TAO_GIOP_Fragmentation_Strategy (void) {}
+
+ /// Destructor.
+ virtual ~TAO_GIOP_Fragmentation_Strategy (void);
+
+ /// Fragment the (potentially partially) encoded GIOP message.
+ /**
+ * Fragmentation the contents of the CDR output stream @a cdr into
+ * smaller chunks of data of size that fits within the configured
+ * ORB fragmentation threshold, and send each fragment "over the
+ * wire."
+ *
+ * @note Fragmentation will only occur if the CDR stream length will
+ * surpass the configured fragmentation threshold when
+ * marshaling the pending set of data.
+ *
+ * @param cdr Output CDR stream.
+ * @param pending_alignment Size of alignment boundary for next data
+ * to be marshaled (e.g. 4 for a
+ * CORBA::ULong).
+ * @param pending_length Size of next data to be marshaled (e.g. 2
+ * for a CORBA::UShort).
+ *
+ * @return Zero on success.
+ */
+ virtual int fragment (TAO_OutputCDR & cdr,
+ ACE_CDR::ULong pending_alignment,
+ ACE_CDR::ULong pending_length) = 0;
+
+private:
+
+ // Disallow copying and assignment.
+ TAO_GIOP_Fragmentation_Strategy (TAO_GIOP_Fragmentation_Strategy const &);
+ void operator= (TAO_GIOP_Fragmentation_Strategy const &);
+
+};
+
+TAO_END_VERSIONED_NAMESPACE_DECL
+
+#include /**/ "ace/post.h"
+
+#endif /* TAO_GIOP_FRAGMENTATION_STRATEGY_H */