-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Post merge review updates for CommandHandler updates (#33658)
* Several updates: comments and remove inline * Restyle * Move TryAddResponseData into the cpp instead of the header * Add override, virtual was a copy and paste * Name argument * Argument renaming and comment update * Move EncoderToTLV into DataModel as it looks like a more generic place, maybe we end up re-using it * Restyle * Update copyright year * Renames based on review comments * More renames of args * Fix compile * Slight comment update * More comment update after self-review * More comment update after self-review * Some renaming * Restyle * One more rename: EncodableType * EncodeTo should be const
- Loading branch information
Showing
4 changed files
with
111 additions
and
87 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| /* | ||
| * Copyright (c) 2024 Project CHIP Authors | ||
| * All rights reserved. | ||
| * | ||
| * Licensed 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 <app/data-model/Encode.h> | ||
| #include <lib/core/CHIPError.h> | ||
| #include <lib/core/TLV.h> | ||
|
|
||
| namespace chip { | ||
| namespace app { | ||
| namespace DataModel { | ||
|
|
||
| /// Defines an abstract class of something that can be encoded | ||
| /// into a TLV with a given data tag | ||
| class EncodableToTLV | ||
| { | ||
| public: | ||
| virtual ~EncodableToTLV() = default; | ||
|
|
||
| virtual CHIP_ERROR EncodeTo(TLV::TLVWriter & writer, TLV::Tag tag) const = 0; | ||
| }; | ||
|
|
||
| /// An `EncodableToTLV` that uses `DataModel::Encode` to encode things in one call. | ||
| /// | ||
| /// Applicable to any type for which `chip::app::DataModel::Encode` works. In | ||
| /// particular, types like <ClusterName>::Commands::<CommandName>::Type | ||
| /// can be used as a type here. | ||
| template <typename T> | ||
| class EncodableType : public EncodableToTLV | ||
| { | ||
| public: | ||
| /// Encodes the given value via `DataModel::Encode` when the underlying | ||
| /// encode is called. | ||
| /// | ||
| /// LIFETIME NOTE: uses a reference to value, so value must live longer than | ||
| /// this object. | ||
| EncodableType(const T & value) : mValue(value) {} | ||
|
|
||
| CHIP_ERROR EncodeTo(TLV::TLVWriter & writer, TLV::Tag tag) const override { return DataModel::Encode(writer, tag, mValue); } | ||
|
|
||
| private: | ||
| const T & mValue; | ||
| }; | ||
|
|
||
| } // namespace DataModel | ||
| } // namespace app | ||
| } // namespace chip |