1 /*------------------------------------------------------------------------------
2 Name: UpdateKey.h
3 Project: xmlBlaster.org
4 Copyright: xmlBlaster.org, see xmlBlaster-LICENSE file
5 ------------------------------------------------------------------------------*/
6
7 /**
8 * Parses the key of returned MsgUnit of update().
9 * <p>
10 * See MsgKeySaxFactory for a syntax description of the allowed xml structure
11 * </p>
12 * @see org.xmlBlaster.util.key.MsgKeySaxFactory
13 * @see <a href="http://www.xmlBlaster.org/xmlBlaster/doc/requirements/interface.update.html" target="others">the interface.update requirement</a>
14 *
15 * @author <a href="mailto:xmlBlaster@marcelruff.info">Marcel Ruff</a>
16 * @author <a href="mailto:laghi@swissinfo.org">Michele Laghi</a>
17 */
18 #ifndef _CLIENT_KEY_UPDATEKEY_H
19 #define _CLIENT_KEY_UPDATEKEY_H
20
21 #include <client/key/MsgKeyBase.h>
22
23 namespace org { namespace xmlBlaster { namespace client { namespace key {
24
25 class Dll_Export UpdateKey : public MsgKeyBase
26 {
27 public:
28
29 /**
30 * Minimal constructor.
31 */
32 UpdateKey(org::xmlBlaster::util::Global& global);
33
34 UpdateKey(org::xmlBlaster::util::Global& global, const org::xmlBlaster::util::key::MsgKeyData& data);
35
36 UpdateKey(const UpdateKey& key);
37
38 UpdateKey& operator =(const UpdateKey& key);
39
40 /**
41 * Test if oid is '__sys__deadMessage'.
42 * <p />
43 * Dead letters are unrecoverable lost messages, usually an administrator
44 * should subscribe to those messages.
45 * <p>
46 * This is an internal message (isInternal() returns true)
47 * </p>
48 */
49 bool isDeadMessage() const;
50
51 /**
52 * Messages starting with "_" are reserved for usage in plugins
53 */
54 bool isPluginInternal() const;
55
56 std::string getClientTags() const;
57
58 };
59
60 }}}} // namespace
61
62 #endif
syntax highlighted by Code2HTML, v. 0.9.1