activemq-cpp-3.8.2
QueueBrowser.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 _CMS_QUEUEBROWSER_H_
19 #define _CMS_QUEUEBROWSER_H_
20 
21 #include <string>
22 #include <cms/Config.h>
23 #include <cms/Closeable.h>
24 #include <cms/Queue.h>
25 #include <cms/Message.h>
26 #include <cms/CMSException.h>
27 #include <cms/MessageEnumeration.h>
28 
29 namespace cms {
30 
53  class CMS_API QueueBrowser : public Closeable {
54  public:
55 
56  virtual ~QueueBrowser();
57 
63  virtual const Queue* getQueue() const = 0;
64 
71  virtual std::string getMessageSelector() const = 0;
72 
83  virtual cms::MessageEnumeration* getEnumeration() = 0;
84 
85  };
86 
87 }
88 
89 #endif /*_CMS_QUEUEBROWSER_H_*/
Interface for a class that implements the close method.
Definition: Closeable.h:35
This class implements in interface for browsing the messages in a Queue without removing them...
Definition: QueueBrowser.h:53
#define CMS_API
Definition: Config.h:31
Defines an object that enumerates a collection of Messages.
Definition: MessageEnumeration.h:35
Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements...
Definition: DestinationResolver.h:23
An interface encapsulating a provider-specific queue name.
Definition: Queue.h:37