summaryrefslogtreecommitdiff
path: root/cpp/include/Ice/Incoming.h
diff options
context:
space:
mode:
Diffstat (limited to 'cpp/include/Ice/Incoming.h')
-rw-r--r--cpp/include/Ice/Incoming.h15
1 files changed, 14 insertions, 1 deletions
diff --git a/cpp/include/Ice/Incoming.h b/cpp/include/Ice/Incoming.h
index 2da92c8bc5a..83bfdc9842f 100644
--- a/cpp/include/Ice/Incoming.h
+++ b/cpp/include/Ice/Incoming.h
@@ -29,12 +29,24 @@
namespace Ice
{
+/**
+ * Base class for marshaled result structures, which are generated for operations having the
+ * marshaled-result metadata tag.
+ * \headerfile Ice/Ice.h
+ */
class ICE_API MarshaledResult
{
public:
- MarshaledResult(const Current&);
+ /**
+ * The constructor requires the Current object that was passed to the servant.
+ */
+ MarshaledResult(const Current& current);
+ /**
+ * Obtains the output stream that is used to marshal the results.
+ * @return The output stream.
+ */
std::shared_ptr<OutputStream> getOutputStream() const
{
return ostr;
@@ -42,6 +54,7 @@ public:
protected:
+ /** The output stream used to marshal the results. */
std::shared_ptr<OutputStream> ostr;
};