activemq-cpp-3.8.2
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 
34 #include <activemq/util/Config.h>
35 #include <decaf/lang/Pointer.h>
36 #include <string>
37 #include <vector>
38 
39 namespace activemq {
40 namespace commands {
41 
43 
44  /*
45  *
46  * Command code for OpenWire format for MessageAck
47  *
48  * NOTE!: This file is auto generated - do not modify!
49  * if you need to make a change, please see the Java Classes
50  * in the activemq-cpp-openwire-generator module
51  *
52  */
54  protected:
55 
59  unsigned char ackType;
64 
65  public:
66 
67  const static unsigned char ID_MESSAGEACK = 22;
68 
69  private:
70 
71  MessageAck(const MessageAck&);
72  MessageAck& operator= (const MessageAck&);
73 
74  public:
75 
76  MessageAck();
77 
78  MessageAck(const Pointer<Message>& message, int ackType, int messageCount);
79 
80  MessageAck(const Pointer<MessageDispatch>& dispatch, int ackType, int messageCount);
81 
82  virtual ~MessageAck();
83 
84  virtual unsigned char getDataStructureType() const;
85 
86  virtual MessageAck* cloneDataStructure() const;
87 
88  virtual void copyDataStructure(const DataStructure* src);
89 
90  virtual std::string toString() const;
91 
92  virtual bool equals(const DataStructure* value) const;
93 
94  virtual const Pointer<ActiveMQDestination>& getDestination() const;
95  virtual Pointer<ActiveMQDestination>& getDestination();
96  virtual void setDestination( const Pointer<ActiveMQDestination>& destination );
97 
98  virtual const Pointer<TransactionId>& getTransactionId() const;
99  virtual Pointer<TransactionId>& getTransactionId();
100  virtual void setTransactionId( const Pointer<TransactionId>& transactionId );
101 
102  virtual const Pointer<ConsumerId>& getConsumerId() const;
103  virtual Pointer<ConsumerId>& getConsumerId();
104  virtual void setConsumerId( const Pointer<ConsumerId>& consumerId );
105 
106  virtual unsigned char getAckType() const;
107  virtual void setAckType( unsigned char ackType );
108 
109  virtual const Pointer<MessageId>& getFirstMessageId() const;
110  virtual Pointer<MessageId>& getFirstMessageId();
111  virtual void setFirstMessageId( const Pointer<MessageId>& firstMessageId );
112 
113  virtual const Pointer<MessageId>& getLastMessageId() const;
114  virtual Pointer<MessageId>& getLastMessageId();
115  virtual void setLastMessageId( const Pointer<MessageId>& lastMessageId );
116 
117  virtual int getMessageCount() const;
118  virtual void setMessageCount( int messageCount );
119 
120  virtual const Pointer<BrokerError>& getPoisonCause() const;
121  virtual Pointer<BrokerError>& getPoisonCause();
122  virtual void setPoisonCause( const Pointer<BrokerError>& poisonCause );
123 
127  virtual bool isMessageAck() const {
128  return true;
129  }
130 
131  virtual Pointer<Command> visit(activemq::state::CommandVisitor* visitor);
132 
133  };
134 
135 }}
136 
137 #endif /*_ACTIVEMQ_COMMANDS_MESSAGEACK_H_*/
Definition: MessageAck.h:53
#define AMQCPP_API
Definition: Config.h:30
Pointer< ConsumerId > consumerId
Definition: MessageAck.h:58
Pointer< TransactionId > transactionId
Definition: MessageAck.h:57
Pointer< BrokerError > poisonCause
Definition: MessageAck.h:63
Definition: DataStructure.h:27
Interface for an Object that can visit the various Command Objects that are sent from and to this cli...
Definition: CommandVisitor.h:69
Definition: BaseCommand.h:27
int messageCount
Definition: MessageAck.h:62
Pointer< MessageId > firstMessageId
Definition: MessageAck.h:60
Pointer< MessageId > lastMessageId
Definition: MessageAck.h:61
Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements...
Definition: CachedConsumer.h:24
Decaf&#39;s implementation of a Smart Pointer that is a template on a Type and is Thread Safe if the defa...
Definition: Pointer.h:53
unsigned char ackType
Definition: MessageAck.h:59
virtual bool isMessageAck() const
Definition: MessageAck.h:127
Pointer< ActiveMQDestination > destination
Definition: MessageAck.h:56