szaszm commented on code in PR #2065: URL: https://github.com/apache/nifi-minifi-cpp/pull/2065#discussion_r2959831561
########## core-framework/include/core/controller/ControllerServiceBase.h: ########## @@ -0,0 +1,109 @@ +/** + * + * 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. + */ +#pragma once + +#include <memory> +#include <string> +#include <utility> +#include <vector> + +#include "minifi-cpp/properties/Configure.h" +#include "core/Core.h" +#include "core/ConfigurableComponentImpl.h" +#include "core/Connectable.h" +#include "minifi-cpp/core/controller/ControllerServiceApi.h" +#include "minifi-cpp/core/controller/ControllerServiceHandle.h" +#include "minifi-cpp/core/ControllerServiceApiDefinition.h" +#include "minifi-cpp/core/controller/ControllerServiceMetadata.h" + +#define ADD_COMMON_VIRTUAL_FUNCTIONS_FOR_CONTROLLER_SERVICES \ + bool supportsDynamicProperties() const override { return SupportsDynamicProperties; } + +namespace org::apache::nifi::minifi::core::controller { + +class ControllerServiceBase : public ControllerServiceApi { + public: + explicit ControllerServiceBase(ControllerServiceMetadata metadata) + : name_(std::move(metadata.name)), + uuid_(metadata.uuid), + logger_(std::move(metadata.logger)) {} + + virtual void initialize() {} + + void initialize(ControllerServiceDescriptor& descriptor) final { + gsl_Expects(!descriptor_); + descriptor_ = &descriptor; + auto guard = gsl::finally([&] {descriptor_ = nullptr;}); + initialize(); Review Comment: Since this is a new interface, why not pass the descriptor instead of setting a member only for the duration of this call and passing `this`? ########## core-framework/include/core/controller/ControllerServiceBase.h: ########## @@ -0,0 +1,109 @@ +/** + * + * 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. + */ +#pragma once + +#include <memory> +#include <string> +#include <utility> +#include <vector> + +#include "minifi-cpp/properties/Configure.h" +#include "core/Core.h" +#include "core/ConfigurableComponentImpl.h" +#include "core/Connectable.h" +#include "minifi-cpp/core/controller/ControllerServiceApi.h" +#include "minifi-cpp/core/controller/ControllerServiceHandle.h" +#include "minifi-cpp/core/ControllerServiceApiDefinition.h" +#include "minifi-cpp/core/controller/ControllerServiceMetadata.h" + +#define ADD_COMMON_VIRTUAL_FUNCTIONS_FOR_CONTROLLER_SERVICES \ + bool supportsDynamicProperties() const override { return SupportsDynamicProperties; } + +namespace org::apache::nifi::minifi::core::controller { + +class ControllerServiceBase : public ControllerServiceApi { + public: + explicit ControllerServiceBase(ControllerServiceMetadata metadata) + : name_(std::move(metadata.name)), + uuid_(metadata.uuid), + logger_(std::move(metadata.logger)) {} + + virtual void initialize() {} + + void initialize(ControllerServiceDescriptor& descriptor) final { + gsl_Expects(!descriptor_); + descriptor_ = &descriptor; + auto guard = gsl::finally([&] {descriptor_ = nullptr;}); + initialize(); + } + + void setSupportedProperties(std::span<const PropertyReference> properties) { + gsl_Expects(descriptor_); + descriptor_->setSupportedProperties(properties); + } + + ~ControllerServiceBase() override {} Review Comment: ```suggestion ~ControllerServiceBase() noexcept override = default; ``` We should also follow rule of 5. ########## core-framework/include/core/controller/ControllerServiceBase.h: ########## @@ -0,0 +1,109 @@ +/** + * + * 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. + */ +#pragma once + +#include <memory> +#include <string> +#include <utility> +#include <vector> + +#include "minifi-cpp/properties/Configure.h" +#include "core/Core.h" +#include "core/ConfigurableComponentImpl.h" +#include "core/Connectable.h" +#include "minifi-cpp/core/controller/ControllerServiceApi.h" +#include "minifi-cpp/core/controller/ControllerServiceHandle.h" +#include "minifi-cpp/core/ControllerServiceApiDefinition.h" +#include "minifi-cpp/core/controller/ControllerServiceMetadata.h" + +#define ADD_COMMON_VIRTUAL_FUNCTIONS_FOR_CONTROLLER_SERVICES \ + bool supportsDynamicProperties() const override { return SupportsDynamicProperties; } + +namespace org::apache::nifi::minifi::core::controller { + +class ControllerServiceBase : public ControllerServiceApi { + public: + explicit ControllerServiceBase(ControllerServiceMetadata metadata) + : name_(std::move(metadata.name)), + uuid_(metadata.uuid), + logger_(std::move(metadata.logger)) {} + + virtual void initialize() {} Review Comment: Why not make this pure virtual? ########## core-framework/include/core/controller/ControllerServiceBase.h: ########## @@ -0,0 +1,109 @@ +/** + * + * 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. + */ +#pragma once + +#include <memory> +#include <string> +#include <utility> +#include <vector> + +#include "minifi-cpp/properties/Configure.h" +#include "core/Core.h" +#include "core/ConfigurableComponentImpl.h" +#include "core/Connectable.h" +#include "minifi-cpp/core/controller/ControllerServiceApi.h" +#include "minifi-cpp/core/controller/ControllerServiceHandle.h" +#include "minifi-cpp/core/ControllerServiceApiDefinition.h" +#include "minifi-cpp/core/controller/ControllerServiceMetadata.h" + +#define ADD_COMMON_VIRTUAL_FUNCTIONS_FOR_CONTROLLER_SERVICES \ + bool supportsDynamicProperties() const override { return SupportsDynamicProperties; } + +namespace org::apache::nifi::minifi::core::controller { + +class ControllerServiceBase : public ControllerServiceApi { + public: + explicit ControllerServiceBase(ControllerServiceMetadata metadata) + : name_(std::move(metadata.name)), + uuid_(metadata.uuid), + logger_(std::move(metadata.logger)) {} + + virtual void initialize() {} + + void initialize(ControllerServiceDescriptor& descriptor) final { + gsl_Expects(!descriptor_); + descriptor_ = &descriptor; + auto guard = gsl::finally([&] {descriptor_ = nullptr;}); + initialize(); + } + + void setSupportedProperties(std::span<const PropertyReference> properties) { + gsl_Expects(descriptor_); + descriptor_->setSupportedProperties(properties); + } + + ~ControllerServiceBase() override {} + + virtual void onEnable() {} Review Comment: this could be pure virtual too. Instantiating this class should be an error. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
