subscribekey.h

java开源的企业总线.xmlBlaster

/**
 * Wrap the XML key for a subscribe() invocation. 
 * <p>
 * See QueryKeySaxFactory for a syntax description of the allowed xml structure
 * </p>
 * @see org.xmlBlaster.util.key.QueryKeySaxFactory
 * @see <a href="http://www.xmlBlaster.org/xmlBlaster/doc/requirements/interface.subscribe.html" target="others">the interface.subscribe requirement</a>
 *
 * @author <a href="mailto:[e-mail]">Marcel Ruff</a>
 * @author <a href="mailto:[e-mail]">Michele Laghi</a>
 */

#ifndef _CLIENT_KEY_SUBSCRIBEKEY_H
#define _CLIENT_KEY_SUBSCRIBEKEY_H

#include <client/key/UnSubscribeKey.h>
#include <util/Constants.h>

namespace org { namespace xmlBlaster { namespace client { namespace key {

class Dll_Export SubscribeKey : public org::xmlBlaster::client::key::UnSubscribeKey
{
public:

   /**
    * Minimal constructor.
    */
   SubscribeKey(org::xmlBlaster::util::Global& global);

   SubscribeKey(org::xmlBlaster::util::Global& global, const std::string& query,
                const std::string& queryType=org::xmlBlaster::util::Constants::EXACT);
   
   SubscribeKey(org::xmlBlaster::util::Global& global, const org::xmlBlaster::util::key::QueryKeyData& data);

   SubscribeKey(const SubscribeKey& key);

   SubscribeKey& operator =(const SubscribeKey& key);

   /**
    * Set the domain for this message, can be used for a simple grouping of
    * messages to their master node with xmlBlaster clusters. 
    * @param The domain, any chosen std::string in your problem domain, e.g. "RUGBY" or "RADAR_TRACK"
    *         defaults to "" where the local xmlBlaster instance is the master of the message.
    * @see <a href="http://www.xmlblaster.org/xmlBlaster/doc/requirements/cluster.html">The cluster requirement</a>
    */
   void setDomain(const std::string& domain);

   /**
    * Access the domain setting
    * @return A domain std::string or null
    */
   std::string getDomain() const;

};

}}}} // namespace

#endif