getreturnkey.h

java开源的企业总线.xmlBlaster

/*------------------------------------------------------------------------------
Name:      GetReturnKey.h
Project:   xmlBlaster.org
Copyright: xmlBlaster.org, see xmlBlaster-LICENSE file
------------------------------------------------------------------------------*/

/**
 * Parses the key of returned MsgUnit of get() invocations
 * <p>
 * See MsgKeySaxFactory for a syntax description of the xml structure
 * </p>
 * @see org.xmlBlaster.util.key.MsgKeySaxFactory
 * @see <a href="http://www.xmlBlaster.org/xmlBlaster/doc/requirements/interface.get.html" target="others">the interface.get requirement</a>
 *
 * @author <a href="mailto:[e-mail]">Marcel Ruff</a>
 * @author <a href="mailto:[e-mail]">Michele Laghi</a>
 */

#ifndef _CLIENT_KEY_GETRETURNKEY_H
#define _CLIENT_KEY_GETRETURNKEY_H

#include <client/key/UpdateKey.h>

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

class Dll_Export GetReturnKey : public org::xmlBlaster::client::key::UpdateKey
{
public:

   /**
    * Minimal constructor.
    */
   GetReturnKey(org::xmlBlaster::util::Global& global);
   
   GetReturnKey(org::xmlBlaster::util::Global& global, const org::xmlBlaster::util::key::MsgKeyData& data);

   GetReturnKey(const GetReturnKey& key);

   GetReturnKey& operator =(const GetReturnKey& key);

   /**
    * Messages starting with "__" are reserved for internal usage
    */
   bool isInternal() const;

};

}}}} // namespace

#endif