Skip to content

Commit edcf87a

Browse files
committed
Clarify subscription properties behavior
1 parent 0378140 commit edcf87a

1 file changed

Lines changed: 8 additions & 5 deletions

File tree

include/pulsar/ConsumerConfiguration.h

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -507,7 +507,7 @@ class PULSAR_PUBLIC ConsumerConfiguration {
507507
const std::string& getProperty(const std::string& name) const;
508508

509509
/**
510-
* Get all the properties attached to this producer.
510+
* Get all the properties attached to this consumer.
511511
*/
512512
std::map<std::string, std::string>& getProperties() const;
513513

@@ -524,14 +524,17 @@ class PULSAR_PUBLIC ConsumerConfiguration {
524524
ConsumerConfiguration& setProperties(const std::map<std::string, std::string>& properties);
525525

526526
/**
527-
* Get all the subscription properties attached to this subscription.
527+
* Get all the subscription properties configured for this consumer.
528528
*/
529529
std::map<std::string, std::string>& getSubscriptionProperties() const;
530530

531531
/**
532-
* Sets a new subscription properties for this subscription.
533-
* Notice: SubscriptionProperties are immutable, and consumers under the same subscription will fail to
534-
* create a subscription if they use different properties.
532+
* Set subscription properties to send when creating or attaching to a subscription.
533+
*
534+
* If the subscription does not exist, the broker stores these properties when
535+
* the subscription is created. If the subscription already exists, these
536+
* properties do not update the existing subscription properties and the client
537+
* does not validate them against the broker-side properties.
535538
*
536539
* @param subscriptionProperties all the subscription properties in the provided map
537540
*/

0 commit comments

Comments
 (0)