szaszm commented on code in PR #2065: URL: https://github.com/apache/nifi-minifi-cpp/pull/2065#discussion_r2891489930
########## core-framework/include/core/controller/ControllerServiceBase.h: ########## @@ -0,0 +1,113 @@ +/** + * + * 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/ControllerServiceInterface.h" +#include "minifi-cpp/core/ControllerServiceApiDefinition.h" +#include "minifi-cpp/core/controller/ControllerServiceMetadata.h" + +namespace org::apache::nifi::minifi::core::controller { + +// A base class that helps with controller service development, contains common functionalities. +class ControllerServiceBase : public ControllerServiceApi { Review Comment: I think I'd generally call these kinds of classes AbstractThing rather than ThingBase, and the ThingApi could be just Thing, but we can have more discussions and brainstorming around the naming patterns. ########## minifi-api/include/minifi-cpp/core/controller/ControllerServiceInterface.h: ########## @@ -28,27 +28,15 @@ namespace org::apache::nifi::minifi::core::controller { -enum ControllerServiceState { - DISABLED, - DISABLING, - ENABLING, - ENABLED -}; - /** * Controller Service base class that contains some pure virtual methods. * * Design: OnEnable is executed when the controller service is being enabled. * Note that keeping state here must be protected in this function. */ Review Comment: I agree here. It's confusing to have ControllerServiceApi, ControllerServiceInterface, and ControllerServiceBase. At least the first two mean the same thing in my understanding, so some clarification would be nice, ideally by brainstorming together about a better name that inherently communicates the purpose and the differences, but alternatively by writing them in a comment or developer documentation. -- 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]
