summaryrefslogtreecommitdiff
path: root/cpp/lib/common/framing/MethodContext.h
diff options
context:
space:
mode:
authorAlan Conway <aconway@apache.org>2007-03-21 02:08:18 +0000
committerAlan Conway <aconway@apache.org>2007-03-21 02:08:18 +0000
commit595235e61a48c1ee24bdaee8af72ab7caf18bab6 (patch)
tree3e6193a2ffe5789291ec8577924f1cabe6933618 /cpp/lib/common/framing/MethodContext.h
parent371d76b7e0f8358d5296722f2f2c0e28181a3935 (diff)
downloadqpid-python-595235e61a48c1ee24bdaee8af72ab7caf18bab6.tar.gz
Renamed cpp-0-9 to cpp
git-svn-id: https://svn.apache.org/repos/asf/incubator/qpid/trunk/qpid@520706 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'cpp/lib/common/framing/MethodContext.h')
-rw-r--r--cpp/lib/common/framing/MethodContext.h80
1 files changed, 80 insertions, 0 deletions
diff --git a/cpp/lib/common/framing/MethodContext.h b/cpp/lib/common/framing/MethodContext.h
new file mode 100644
index 0000000000..3493924bf6
--- /dev/null
+++ b/cpp/lib/common/framing/MethodContext.h
@@ -0,0 +1,80 @@
+#ifndef _framing_MethodContext_h
+#define _framing_MethodContext_h
+
+/*
+ *
+ * Copyright (c) 2006 The Apache Software Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+#include <boost/shared_ptr.hpp>
+
+#include "OutputHandler.h"
+#include "ProtocolVersion.h"
+
+namespace qpid {
+namespace framing {
+
+class BodyHandler;
+class AMQMethodBody;
+class ChannelAdapter;
+
+/**
+ * Invocation context for an AMQP method.
+ *
+ * It provides the method being processed and the channel on which
+ * it arrived.
+ *
+ * All Handler functions take a MethodContext as the last parameter.
+ */
+struct MethodContext
+{
+ typedef boost::shared_ptr<AMQMethodBody> BodyPtr;
+
+ MethodContext(ChannelAdapter* ch=0, BodyPtr method=BodyPtr())
+ : channel(ch), methodBody(method) {}
+
+ /**
+ * Channel on which the method being processed arrived.
+ * 0 if the method was constructed by the caller
+ * rather than received from a channel.
+ */
+ ChannelAdapter* channel;
+
+ /**
+ * Body of the method being processed.
+ * It's useful for passing around instead of unpacking all its parameters.
+ * It's also provides the request ID when constructing a response.
+ */
+ BodyPtr methodBody;
+
+ /**
+ * Return methodBody's request ID.
+ * It is an error to call this if methodBody is not a request.
+ */
+ RequestId getRequestId() const;
+};
+
+// FIXME aconway 2007-02-01: Method context only required on Handler
+// functions, not on Proxy functions. If we add set/getChannel(ChannelAdapter*)
+// on AMQBody and set it during decodeing then we could get rid of the context.
+
+
+
+}} // namespace qpid::framing
+
+
+
+#endif /*!_framing_MethodContext_h*/