zhaijack commented on a change in pull request #1996: Cpp client: add multiTopicsConsumer URL: https://github.com/apache/incubator-pulsar/pull/1996#discussion_r203314440
########## File path: pulsar-client-cpp/lib/MultiTopicsConsumerImpl.cc ########## @@ -0,0 +1,621 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +#include "MultiTopicsConsumerImpl.h" + +DECLARE_LOG_OBJECT() + +using namespace pulsar; + +MultiTopicsConsumerImpl::MultiTopicsConsumerImpl(ClientImplPtr client, const std::vector<std::string>& topics, + const std::string& subscriptionName, TopicNamePtr topicName, + const ConsumerConfiguration& conf, + const LookupServicePtr lookupServicePtr) + : client_(client), + subscriptionName_(subscriptionName), + topic_(topicName ? topicName->toString() : "EmptyTopics"), + conf_(conf), + state_(Pending), + messages_(1000), + listenerExecutor_(client->getListenerExecutorProvider()->get()), + messageListener_(conf.getMessageListener()), + namespaceName_(topicName ? topicName->getNamespaceName() : boost::shared_ptr<NamespaceName>()), + lookupServicePtr_(lookupServicePtr), + allTopicPartitionsNumber_(boost::make_shared<std::atomic<int>>(0)), + topics_(topics) { + std::stringstream consumerStrStream; + consumerStrStream << "[Muti Topics Consumer: " + << "TopicName - " << topic_ << " - Subscription - " << subscriptionName << "]"; + consumerStr_ = consumerStrStream.str(); + + if (conf.getUnAckedMessagesTimeoutMs() != 0) { + unAckedMessageTrackerPtr_.reset( + new UnAckedMessageTrackerEnabled(conf.getUnAckedMessagesTimeoutMs(), client, *this)); + } else { + unAckedMessageTrackerPtr_.reset(new UnAckedMessageTrackerDisabled()); + } +} + +void MultiTopicsConsumerImpl::start() { + if (topics_.empty()) { + setState(Ready); + LOG_DEBUG("No topics passed in when create MultiTopicsConsumer."); + multiTopicsConsumerCreatedPromise_.setValue(shared_from_this()); + return; + } + + // start call subscribeOneTopicAsync for each single topic + int topicsNumber = topics_.size(); + boost::shared_ptr<std::atomic<int>> topicsNeedCreate = boost::make_shared<std::atomic<int>>(topicsNumber); + // subscribe for each passed in topic + for (std::vector<std::string>::const_iterator itr = topics_.begin(); itr != topics_.end(); itr++) { + subscribeOneTopicAsync(*itr).addListener( + boost::bind(&MultiTopicsConsumerImpl::handleOneTopicSubscribed, shared_from_this(), _1, _2, *itr, + topicsNeedCreate)); + } +} + +void MultiTopicsConsumerImpl::handleOneTopicSubscribed(Result result, Consumer consumer, + const std::string& topic, + boost::shared_ptr<std::atomic<int>> topicsNeedCreate) { + int previous = topicsNeedCreate->fetch_sub(1); + assert(previous > 0); + + if (result != ResultOk) { + state_ = Failed; + multiTopicsConsumerCreatedPromise_.setFailed(result); + // unsubscribed all of the successfully subscribed partitioned consumers + ResultCallback nullCallbackForCleanup = NULL; + closeAsync(nullCallbackForCleanup); + LOG_ERROR("Unable to create Consumer - " + << " Error - " << result); + return; + } + + LOG_DEBUG("Successfully Subscribed to topic " << topic << " in TopicsConsumer "); + + if (topicsNeedCreate->load() == 0) { + LOG_INFO("Successfully Subscribed to Topics"); + setState(Ready); + if (!namespaceName_) { + namespaceName_ = TopicName::get(topic)->getNamespaceName(); + } + multiTopicsConsumerCreatedPromise_.setValue(shared_from_this()); + return; + } +} + +// subscribe for passed in topic +Future<Result, Consumer> MultiTopicsConsumerImpl::subscribeOneTopicAsync(const std::string& topic) { + TopicNamePtr topicName; + ConsumerSubResultPromisePtr topicPromise = boost::make_shared<Promise<Result, Consumer>>(); + if (!(topicName = TopicName::get(topic))) { + LOG_ERROR("TopicName invalid: " << topic); + topicPromise->setFailed(ResultInvalidTopicName); + return topicPromise->getFuture(); + } + + if (state_ == Closed || state_ == Closing) { + LOG_ERROR("MultiTopicsConsumer already closed when subscribe."); + topicPromise->setFailed(ResultAlreadyClosed); + return topicPromise->getFuture(); + } + + // subscribe for each partition, when all partitions completed, complete promise + lookupServicePtr_->getPartitionMetadataAsync(topicName).addListener( + boost::bind(&MultiTopicsConsumerImpl::subscribeTopicPartitions, shared_from_this(), _1, _2, topicName, + subscriptionName_, conf_, topicPromise)); + return topicPromise->getFuture(); +} + +void MultiTopicsConsumerImpl::subscribeTopicPartitions(const Result result, + const LookupDataResultPtr partitionMetadata, + TopicNamePtr topicName, + const std::string& consumerName, + ConsumerConfiguration conf, + ConsumerSubResultPromisePtr topicSubResultPromise) { + if (result != ResultOk) { + LOG_ERROR("Error Checking/Getting Partition Metadata while MultiTopics Subscribing- " << result) + topicSubResultPromise->setFailed(result); + return; + } + + boost::shared_ptr<ConsumerImpl> consumer; + ConsumerConfiguration config; + ExecutorServicePtr internalListenerExecutor = client_->getPartitionListenerExecutorProvider()->get(); + + // all the consumers should have same name. + config.setConsumerName(conf_.getConsumerName()); + config.setConsumerType(conf_.getConsumerType()); + config.setBrokerConsumerStatsCacheTimeInMs(conf_.getBrokerConsumerStatsCacheTimeInMs()); + config.setMessageListener( + boost::bind(&MultiTopicsConsumerImpl::messageReceived, shared_from_this(), _1, _2)); + config.setReceiverQueueSize(conf_.getReceiverQueueSize()); + + int partitionsNumber = partitionMetadata->getPartitions() >= 1 ? partitionMetadata->getPartitions() : 1; + + Lock lock(mutex_); + topicsPartitions_.insert(std::make_pair(topicName->toString(), partitionsNumber)); + lock.unlock(); + allTopicPartitionsNumber_->fetch_add(partitionsNumber); + + boost::shared_ptr<std::atomic<int>> partitionsNeedCreate = + boost::make_shared<std::atomic<int>>(partitionsNumber); + + for (int i = 0; i < partitionsNumber; i++) { + std::string topicPartitionName = topicName->getTopicPartitionName(i); + consumer = boost::make_shared<ConsumerImpl>(client_, topicPartitionName, subscriptionName_, config, + internalListenerExecutor, Partitioned); + consumer->getConsumerCreatedFuture().addListener( + boost::bind(&MultiTopicsConsumerImpl::handleSingleConsumerCreated, shared_from_this(), _1, _2, + partitionsNeedCreate, topicSubResultPromise)); + consumer->setPartitionIndex(i); + consumers_.insert(std::make_pair(topicPartitionName, consumer)); + LOG_DEBUG("Create Consumer for - " << topicPartitionName << " - " << consumerStr_); + consumer->start(); + } +} + +void MultiTopicsConsumerImpl::handleSingleConsumerCreated( + Result result, ConsumerImplBaseWeakPtr consumerImplBaseWeakPtr, + boost::shared_ptr<std::atomic<int>> partitionsNeedCreate, + ConsumerSubResultPromisePtr topicSubResultPromise) { + if (state_ == Failed) { + // one of the consumer creation failed, and we are cleaning up + topicSubResultPromise->setFailed(ResultAlreadyClosed); + LOG_ERROR("Unable to create Consumer - state == Failed, result: " << result); + return; + } + + int previous = partitionsNeedCreate->fetch_sub(1); + assert(previous > 0); + + if (result != ResultOk) { + state_ = Failed; + topicSubResultPromise->setFailed(result); + LOG_ERROR("Unable to create Consumer - " + << " Error - " << result); + return; + } + + LOG_DEBUG("Successfully Subscribed to a single partition of topic in TopicsConsumer. " + << "Partitions need to create - " << previous - 1); + + if (partitionsNeedCreate->load() == 0) { + topicSubResultPromise->setValue(Consumer(shared_from_this())); + return; + } +} + +void MultiTopicsConsumerImpl::unsubscribeAsync(ResultCallback callback) { + LOG_INFO("[ Topics Consumer " << topic_ << "," << subscriptionName_ << "] Unsubscribing"); + + Lock lock(mutex_); + if (state_ == Closing || state_ == Closed) { + LOG_INFO(consumerStr_ << " already closed"); + lock.unlock(); + callback(ResultAlreadyClosed); + return; + } + state_ = Closing; + lock.unlock(); + + boost::shared_ptr<std::atomic<int>> consumerUnsubed = boost::make_shared<std::atomic<int>>(0); + + for (ConsumerMap::const_iterator consumer = consumers_.begin(); consumer != consumers_.end(); + consumer++) { + LOG_DEBUG("Unsubcribing Consumer - " << consumer->first); + (consumer->second) + ->unsubscribeAsync(boost::bind(&MultiTopicsConsumerImpl::handleUnsubscribedAsync, + shared_from_this(), _1, consumerUnsubed, callback)); + } +} + +void MultiTopicsConsumerImpl::handleUnsubscribedAsync(Result result, + boost::shared_ptr<std::atomic<int>> consumerUnsubed, + ResultCallback callback) { + int previous = consumerUnsubed->fetch_add(1); + assert(previous < allTopicPartitionsNumber_->load()); + + if (result != ResultOk) { + setState(Failed); + LOG_ERROR("Error Closing one of the consumers in TopicsConsumer, result: " + << result << " subscription - " << subscriptionName_); + } + + if (consumerUnsubed->load() == allTopicPartitionsNumber_->load()) { + LOG_DEBUG("Unsubscribed all of the partition consumer for TopicsConsumer. - " << consumerStr_); + setState(Closed); + if (state_ != Failed) { + callback(ResultOk); + } else { + callback(ResultUnknownError); + } + unAckedMessageTrackerPtr_->clear(); + return; + } +} + +void MultiTopicsConsumerImpl::unsubscribeOneTopicAsync(const std::string& topic, ResultCallback callback) { + std::map<std::string, int>::iterator it = topicsPartitions_.find(topic); + if (it == topicsPartitions_.end()) { + LOG_ERROR("TopicsConsumer does not subscribe topic : " << topic << " subscription - " + << subscriptionName_); + callback(ResultTopicNotFound); + return; + } + + if (state_ == Closing || state_ == Closed) { + LOG_ERROR("TopicsConsumer already closed when unsubscribe topic: " << topic << " subscription - " + << subscriptionName_); + callback(ResultAlreadyClosed); + return; + } + + TopicNamePtr topicName; + if (!(topicName = TopicName::get(topic))) { + LOG_ERROR("TopicName invalid: " << topic); + callback(ResultUnknownError); + } + int numberPartitions = it->second; + boost::shared_ptr<std::atomic<int>> consumerUnsubed = boost::make_shared<std::atomic<int>>(0); + + for (int i = 0; i < numberPartitions; i++) { + std::string topicPartitionName = topicName->getTopicPartitionName(i); + std::map<std::string, ConsumerImplPtr>::iterator iterator = consumers_.find(topicPartitionName); + + if (consumers_.end() == iterator) { + LOG_ERROR("TopicsConsumer not subscribed on topicPartitionName: " << topicPartitionName); + callback(ResultUnknownError); + } + + (iterator->second) + ->unsubscribeAsync(boost::bind(&MultiTopicsConsumerImpl::handleOneTopicUnsubscribedAsync, + shared_from_this(), _1, consumerUnsubed, numberPartitions, + topicName, topicPartitionName, callback)); + } +} + +void MultiTopicsConsumerImpl::handleOneTopicUnsubscribedAsync( + Result result, boost::shared_ptr<std::atomic<int>> consumerUnsubed, int numberPartitions, + TopicNamePtr topicNamePtr, std::string& topicPartitionName, ResultCallback callback) { + int previous = consumerUnsubed->fetch_add(1); + assert(previous < numberPartitions); + + if (result != ResultOk) { + setState(Failed); + LOG_ERROR("Error Closing one of the consumers in TopicsConsumer, result: " + << result << " topicPartitionName - " << topicPartitionName); + } + + LOG_DEBUG("Successfully Unsubscribed one Consumer. topicPartitionName - " << topicPartitionName); + + std::map<std::string, ConsumerImplPtr>::iterator iterator = consumers_.find(topicPartitionName); + if (consumers_.end() != iterator) { + iterator->second->pauseMessageListener(); + consumers_.erase(iterator); + } + + if (consumerUnsubed->load() == numberPartitions) { + LOG_DEBUG("Unsubscribed all of the partition consumer for TopicsConsumer. - " << consumerStr_); + std::map<std::string, int>::iterator it = topicsPartitions_.find(topicNamePtr->toString()); + if (it != topicsPartitions_.end()) { + allTopicPartitionsNumber_->fetch_sub(numberPartitions); + Lock lock(mutex_); + topicsPartitions_.erase(it); + lock.unlock(); + } + if (state_ != Failed) { + callback(ResultOk); + } else { + callback(ResultUnknownError); + } + unAckedMessageTrackerPtr_->removeTopicMessage(topicNamePtr->toString()); + return; + } +} + +void MultiTopicsConsumerImpl::closeAsync(ResultCallback callback) { + if (state_ == Closing || state_ == Closed) { + LOG_ERROR("TopicsConsumer already closed " + << " topic" << topic_ << " consumer - " << consumerStr_); + callback(ResultAlreadyClosed); + return; + } + + setState(Closing); + + if (consumers_.empty()) { + LOG_ERROR("TopicsConsumer have no consumers to close " + << " topic" << topic_ << " subscription - " << subscriptionName_); + setState(Closed); + callback(ResultAlreadyClosed); + return; + } + + // close successfully subscribed consumers + for (ConsumerMap::const_iterator consumer = consumers_.begin(); consumer != consumers_.end(); + consumer++) { + std::string topicPartitionName = consumer->first; + ConsumerImplPtr consumerPtr = consumer->second; + + consumerPtr->closeAsync(boost::bind(&MultiTopicsConsumerImpl::handleSingleConsumerClose, + shared_from_this(), _1, topicPartitionName, callback)); + } +} + +void MultiTopicsConsumerImpl::handleSingleConsumerClose(Result result, std::string& topicPartitionName, + CloseCallback callback) { + std::map<std::string, ConsumerImplPtr>::iterator iterator = consumers_.find(topicPartitionName); + if (consumers_.end() != iterator) { + consumers_.erase(iterator); + } + + LOG_DEBUG("Closing the consumer for partition - " << topicPartitionName << " allTopicPartitionsNumber_ - " + << allTopicPartitionsNumber_->load()); + + assert(allTopicPartitionsNumber_->load() > 0); + allTopicPartitionsNumber_->fetch_sub(1); + + if (result != ResultOk) { + setState(Failed); + LOG_ERROR("Closing the consumer failed for partition - " << topicPartitionName << " with error - " + << result); + } + + // closed all consumers + if (allTopicPartitionsNumber_->load() == 0) { + consumers_.clear(); + topicsPartitions_.clear(); + unAckedMessageTrackerPtr_->clear(); + + if (state_ != Failed) { + state_ = Closed; + } + + multiTopicsConsumerCreatedPromise_.setFailed(ResultUnknownError); + if (!callback.empty()) { + callback(result); + } + return; + } +} + +void MultiTopicsConsumerImpl::messageReceived(Consumer consumer, const Message& msg) { + LOG_DEBUG("Received Message from one of the topic - " << consumer.getTopic() + << " message:" << msg.getDataAsString()); + std::string topicPartitionName = consumer.getTopic(); + msg.impl_->setTopicName(topicPartitionName); + messages_.push(msg); + + if (messageListener_) { + listenerExecutor_->postWork( + boost::bind(&MultiTopicsConsumerImpl::internalListener, shared_from_this(), consumer)); + } +} + +void MultiTopicsConsumerImpl::internalListener(Consumer consumer) { + Message m; + messages_.pop(m); + + try { + messageListener_(Consumer(shared_from_this()), m); + } catch (const std::exception& e) { + LOG_ERROR("Exception thrown from listener of Partitioned Consumer" << e.what()); + } +} + +Result MultiTopicsConsumerImpl::receive(Message& msg) { + Lock lock(mutex_); + if (state_ != Ready) { + lock.unlock(); + return ResultAlreadyClosed; + } + + if (messageListener_) { + lock.unlock(); + LOG_ERROR("Can not receive when a listener has been set"); + return ResultInvalidConfiguration; + } + messages_.pop(msg); + lock.unlock(); + + unAckedMessageTrackerPtr_->add(msg.getMessageId()); + return ResultOk; +} + +Result MultiTopicsConsumerImpl::receive(Message& msg, int timeout) { + Lock lock(mutex_); + if (state_ != Ready) { + lock.unlock(); + return ResultAlreadyClosed; + } + + if (messageListener_) { + lock.unlock(); + LOG_ERROR("Can not receive when a listener has been set"); + return ResultInvalidConfiguration; + } + + if (messages_.pop(msg, milliseconds(timeout))) { + lock.unlock(); + unAckedMessageTrackerPtr_->add(msg.getMessageId()); + return ResultOk; + } else { + return ResultTimeout; + } +} + +void MultiTopicsConsumerImpl::acknowledgeAsync(const MessageId& msgId, ResultCallback callback) { + if (state_ != Ready) { + callback(ResultAlreadyClosed); + return; + } + std::string& topicPartitionName = msgId.impl_->topicName_; + std::map<std::string, ConsumerImplPtr>::iterator iterator = consumers_.find(topicPartitionName); + + if (consumers_.end() != iterator) { + unAckedMessageTrackerPtr_->remove(msgId); + iterator->second->acknowledgeAsync(msgId, callback); + } else { + LOG_ERROR("Message of topic: " << topicPartitionName << " not in unAckedMessageTracker"); + callback(ResultUnknownError); + return; + } +} + +void MultiTopicsConsumerImpl::acknowledgeCumulativeAsync(const MessageId& msgId, ResultCallback callback) { + callback(ResultOperationNotSupported); +} + +MultiTopicsConsumerImpl::~MultiTopicsConsumerImpl() {} + +Future<Result, ConsumerImplBaseWeakPtr> MultiTopicsConsumerImpl::getConsumerCreatedFuture() { + return multiTopicsConsumerCreatedPromise_.getFuture(); +} +const std::string& MultiTopicsConsumerImpl::getSubscriptionName() const { return subscriptionName_; } + +const std::string& MultiTopicsConsumerImpl::getTopic() const { return topic_; } + +const std::string& MultiTopicsConsumerImpl::getName() const { return consumerStr_; } + +void MultiTopicsConsumerImpl::setState(const MultiTopicsConsumerState state) { Review comment: thanks, will add compareAndSet. some of the state could have "check and set", while like in close(), we could have multiple state choice before set. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services