Skip to content

Commit a396029

Browse files
committed
add explanatory comments to ControllerServiceImpl.h
1 parent 0bb815e commit a396029

2 files changed

Lines changed: 5 additions & 3 deletions

File tree

extension-framework/cpp-extension-lib/include/api/core/ControllerServiceImpl.h

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ class Connection;
3030

3131
namespace core {
3232

33+
/// Helper class that makes implementing the stable API easier
34+
/// It is used in conjunction with useControllerServiceClassDefinition
3335
class ControllerServiceImpl {
3436
public:
3537
explicit ControllerServiceImpl(minifi::core::ControllerServiceMetadata metadata);
@@ -42,15 +44,15 @@ class ControllerServiceImpl {
4244
virtual ~ControllerServiceImpl();
4345

4446
MinifiStatus enable(ControllerServiceContext&);
45-
void notifyStop();
47+
void disable();
4648

4749
[[nodiscard]] std::string getName() const;
4850
[[nodiscard]] minifi::utils::Identifier getUUID() const;
4951
[[nodiscard]] minifi::utils::SmallString<36> getUUIDStr() const;
5052

5153
protected:
5254
virtual MinifiStatus enableImpl(api::core::ControllerServiceContext&) = 0;
53-
virtual void notifyStopImpl() {}
55+
virtual void disableImpl() {}
5456

5557
minifi::core::ControllerServiceMetadata metadata_;
5658

extension-framework/cpp-extension-lib/include/api/core/Resource.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ void useControllerServiceClassDefinition(Fn&& fn) {
181181
},
182182
.disable = [](void* self) -> void {
183183
try {
184-
static_cast<Class*>(self)->notifyStop();
184+
static_cast<Class*>(self)->disable();
185185
} catch (...) {}
186186
},
187187
}};

0 commit comments

Comments
 (0)