activemq-cpp-3.6.0
MessageAck.h
Go to the documentation of this file.
1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
18 #ifndef _ACTIVEMQ_COMMANDS_MESSAGEACK_H_
19 #define _ACTIVEMQ_COMMANDS_MESSAGEACK_H_
20 
21 // Turn off warning message for ignored exception specification
22 #ifdef _MSC_VER
23 #pragma warning( disable : 4290 )
24 #endif
25 
26 #include <activemq/commands/ActiveMQDestination.h>
27 #include <activemq/commands/BaseCommand.h>
28 #include <activemq/commands/BrokerError.h>
29 #include <activemq/commands/ConsumerId.h>
30 #include <activemq/commands/MessageId.h>
31 #include <activemq/commands/TransactionId.h>
32 #include <activemq/util/Config.h>
33 #include <decaf/lang/Pointer.h>
34 #include <string>
35 #include <vector>
36 
37 namespace activemq{
38 namespace commands{
39 
40  using decaf::lang::Pointer;
41 
42  /*
43  *
44  * Command code for OpenWire format for MessageAck
45  *
46  * NOTE!: This file is auto generated - do not modify!
47  * if you need to make a change, please see the Java Classes
48  * in the activemq-cpp-openwire-generator module
49  *
50  */
51  class AMQCPP_API MessageAck : public BaseCommand {
52  protected:
53 
54  Pointer<ActiveMQDestination> destination;
55  Pointer<TransactionId> transactionId;
56  Pointer<ConsumerId> consumerId;
57  unsigned char ackType;
58  Pointer<MessageId> firstMessageId;
59  Pointer<MessageId> lastMessageId;
60  int messageCount;
61  Pointer<BrokerError> poisonCause;
62 
63  public:
64 
65  const static unsigned char ID_MESSAGEACK = 22;
66 
67  private:
68 
69  MessageAck( const MessageAck& );
70  MessageAck& operator= ( const MessageAck& );
71 
72  public:
73 
74  MessageAck();
75 
76  virtual ~MessageAck();
77 
78  virtual unsigned char getDataStructureType() const;
79 
80  virtual MessageAck* cloneDataStructure() const;
81 
82  virtual void copyDataStructure( const DataStructure* src );
83 
84  virtual std::string toString() const;
85 
86  virtual bool equals( const DataStructure* value ) const;
87 
88  virtual const Pointer<ActiveMQDestination>& getDestination() const;
89  virtual Pointer<ActiveMQDestination>& getDestination();
90  virtual void setDestination( const Pointer<ActiveMQDestination>& destination );
91 
92  virtual const Pointer<TransactionId>& getTransactionId() const;
93  virtual Pointer<TransactionId>& getTransactionId();
94  virtual void setTransactionId( const Pointer<TransactionId>& transactionId );
95 
96  virtual const Pointer<ConsumerId>& getConsumerId() const;
97  virtual Pointer<ConsumerId>& getConsumerId();
98  virtual void setConsumerId( const Pointer<ConsumerId>& consumerId );
99 
100  virtual unsigned char getAckType() const;
101  virtual void setAckType( unsigned char ackType );
102 
103  virtual const Pointer<MessageId>& getFirstMessageId() const;
104  virtual Pointer<MessageId>& getFirstMessageId();
105  virtual void setFirstMessageId( const Pointer<MessageId>& firstMessageId );
106 
107  virtual const Pointer<MessageId>& getLastMessageId() const;
108  virtual Pointer<MessageId>& getLastMessageId();
109  virtual void setLastMessageId( const Pointer<MessageId>& lastMessageId );
110 
111  virtual int getMessageCount() const;
112  virtual void setMessageCount( int messageCount );
113 
114  virtual const Pointer<BrokerError>& getPoisonCause() const;
115  virtual Pointer<BrokerError>& getPoisonCause();
116  virtual void setPoisonCause( const Pointer<BrokerError>& poisonCause );
117 
121  virtual bool isMessageAck() const {
122  return true;
123  }
124 
125  virtual Pointer<Command> visit( activemq::state::CommandVisitor* visitor );
126 
127  };
128 
129 }}
130 
131 #endif /*_ACTIVEMQ_COMMANDS_MESSAGEACK_H_*/