org::xmlBlaster::util::qos::TopicProperty

org::xmlBlaster::util::qos::TopicProperty Class Reference

Collaboration diagram for org::xmlBlaster::util::qos::TopicProperty:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 TopicProperty (org::xmlBlaster::util::Global &global)
 Constructs the specialized quality of service object for a publish() or update() call.
 TopicProperty (TopicProperty &prop)
TopicProperty & operator= (TopicProperty &prop)
 ~TopicProperty ()
void setReadonly (bool readonly)
 
Returns:
readonly Once published the message can't be changed.

bool isReadonly ()
 
Returns:
true/false

long getDestroyDelay ()
 The life time of the message topic in state UNREFERENCED.
void setDestroyDelay (long destroyDelay)
 The life time of the message topic in state UNREFERENCED.
bool createDomEntry ()
 Is the topic available in the internal DOM tree?
void setCreateDomEntry (bool createDomEntry)
 Set if the topic is available in the internal DOM tree.
bool hasMsgUnitStoreProperty ()
org::xmlBlaster::util::qos::storage::MsgUnitStoreProperty getMsgUnitStoreProperty ()
 
Returns:
the configuration of the message store, is never null

void setMsgUnitStoreProperty (org::xmlBlaster::util::qos::storage::MsgUnitStoreProperty &msgUnitStoreProperty)
bool hasHistoryQueueProperty ()
org::xmlBlaster::util::qos::storage::HistoryQueueProperty getHistoryQueueProperty ()
 
Returns:
the configuration of the history queue, is never null

void setHistoryQueueProperty (org::xmlBlaster::util::qos::storage::HistoryQueueProperty &historyQueueProperty)
std::string toXml (std::string &extraOffset="")
 Dump state of this object into a XML ASCII std::string.

Detailed Description

Definition at line 47 of file TopicProperty.h.

Constructor & Destructor Documentation

org::xmlBlaster::util::qos::TopicProperty::TopicProperty ( org::xmlBlaster::util::Global &  global  ) 

Constructs the specialized quality of service object for a publish() or update() call.

Definition at line 68 of file TopicProperty.cpp.

References org::xmlBlaster::util::qos::DEFAULT_readonly, org::xmlBlaster::util::qos::destroyDelay_DEFAULT_DEFAULT, org::xmlBlaster::util::Property::getLongProperty(), org::xmlBlaster::util::Global::getProperty(), and setDestroyDelay().

org::xmlBlaster::util::qos::TopicProperty::TopicProperty ( TopicProperty &  prop  ) 

Definition at line 81 of file TopicProperty.cpp.

org::xmlBlaster::util::qos::TopicProperty::~TopicProperty (  ) 

Definition at line 95 of file TopicProperty.cpp.

Member Function Documentation

TopicProperty & org::xmlBlaster::util::qos::TopicProperty::operator= ( TopicProperty &  prop  ) 

Definition at line 88 of file TopicProperty.cpp.

References createDomEntry_.

void org::xmlBlaster::util::qos::TopicProperty::setReadonly ( bool  readonly  ) 

Returns:
readonly Once published the message can't be changed.

Definition at line 104 of file TopicProperty.cpp.

Referenced by PublishDemo::publish(), and org::xmlBlaster::util::qos::MsgQosData::setReadonly().

bool org::xmlBlaster::util::qos::TopicProperty::isReadonly (  ) 

Returns:
true/false

Definition at line 112 of file TopicProperty.cpp.

Referenced by org::xmlBlaster::util::qos::MsgQosData::isReadonly().

long org::xmlBlaster::util::qos::TopicProperty::getDestroyDelay (  ) 

The life time of the message topic in state UNREFERENCED.

Definition at line 120 of file TopicProperty.cpp.

void org::xmlBlaster::util::qos::TopicProperty::setDestroyDelay ( long  destroyDelay  ) 

The life time of the message topic in state UNREFERENCED.

Definition at line 128 of file TopicProperty.cpp.

Referenced by PublishDemo::publish(), and TopicProperty().

bool org::xmlBlaster::util::qos::TopicProperty::createDomEntry (  ) 

Is the topic available in the internal DOM tree?

Returns:
true This is default and the topic is queryable with XPATH
false: No DOM tree is created for the topic and the topic is onvisible to XPATH queries

Definition at line 138 of file TopicProperty.cpp.

References org::xmlBlaster::util::Prop< T >::getValue().

void org::xmlBlaster::util::qos::TopicProperty::setCreateDomEntry ( bool  createDomEntry  ) 

Set if the topic is available in the internal DOM tree.

Parameters:
true This is default and the topic is queryable with XPATH
false: No DOM tree is created for the topic and the topic is onvisible to XPATH queries

Definition at line 148 of file TopicProperty.cpp.

References org::xmlBlaster::util::Prop< T >::setValue().

Referenced by PublishDemo::publish().

bool org::xmlBlaster::util::qos::TopicProperty::hasMsgUnitStoreProperty (  ) 

Definition at line 152 of file TopicProperty.cpp.

MsgUnitStoreProperty org::xmlBlaster::util::qos::TopicProperty::getMsgUnitStoreProperty (  ) 

Returns:
the configuration of the message store, is never null

Definition at line 160 of file TopicProperty.cpp.

void org::xmlBlaster::util::qos::TopicProperty::setMsgUnitStoreProperty ( org::xmlBlaster::util::qos::storage::MsgUnitStoreProperty &  msgUnitStoreProperty  ) 

Definition at line 168 of file TopicProperty.cpp.

bool org::xmlBlaster::util::qos::TopicProperty::hasHistoryQueueProperty (  ) 

Definition at line 177 of file TopicProperty.cpp.

HistoryQueueProperty org::xmlBlaster::util::qos::TopicProperty::getHistoryQueueProperty (  ) 

Returns:
the configuration of the history queue, is never null

Definition at line 185 of file TopicProperty.cpp.

void org::xmlBlaster::util::qos::TopicProperty::setHistoryQueueProperty ( org::xmlBlaster::util::qos::storage::HistoryQueueProperty &  historyQueueProperty  ) 

Definition at line 193 of file TopicProperty.cpp.

Referenced by PublishDemo::publish().

std::string org::xmlBlaster::util::qos::TopicProperty::toXml ( std::string &  extraOffset = ""  ) 

Dump state of this object into a XML ASCII std::string.


Parameters:
extraOffset indenting of tags for nice output
Returns:
internal state of the message QoS as a XML ASCII std::string, never null but "" if all values are default

Referenced by PublishDemo::publish().

The documentation for this class was generated from the following files: