Skip to content

Commit 7f5e208

Browse files
bzbarsky-applebzbarsky-apple
authored
Add support for pre-encoded things in AttributeAccessInterface. (project-chip#31639)
* Add support for pre-encoded things in AttributeAccessInterface. * Address review comments.
1 parent 0515225 commit 7f5e208

6 files changed

+551
-0
lines changed

‎src/app/BUILD.gn

+4
Original file line numberDiff line numberDiff line change
@@ -201,6 +201,10 @@ static_library("app") {
201201
"TimerDelegates.h",
202202
"WriteClient.cpp",
203203
"WriteHandler.cpp",
204+
"data-model/FabricScopedPreEncodedValue.cpp",
205+
"data-model/FabricScopedPreEncodedValue.h",
206+
"data-model/PreEncodedValue.cpp",
207+
"data-model/PreEncodedValue.h",
204208
"reporting/Engine.cpp",
205209
"reporting/Engine.h",
206210
"reporting/ReportScheduler.h",

‎src/app/data-model/FabricScopedPreEncodedValue.cpp

+103
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
/*
2+
* Copyright (c) 2024 Project CHIP Authors
3+
* All rights reserved.
4+
*
5+
* Licensed under the Apache License, Version 2.0 (the "License");
6+
* you may not use this file except in compliance with the License.
7+
* You may obtain a copy of the License at
8+
*
9+
* http://www.apache.org/licenses/LICENSE-2.0
10+
*
11+
* Unless required by applicable law or agreed to in writing, software
12+
* distributed under the License is distributed on an "AS IS" BASIS,
13+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
* See the License for the specific language governing permissions and
15+
* limitations under the License.
16+
*/
17+
18+
#include "FabricScopedPreEncodedValue.h"
19+
#include <lib/core/TLVReader.h>
20+
#include <lib/support/CodeUtils.h>
21+
22+
#include <optional>
23+
24+
namespace chip {
25+
namespace app {
26+
namespace DataModel {
27+
28+
FabricScopedPreEncodedValue::FabricScopedPreEncodedValue(const ByteSpan & aData) : mData(aData) {}
29+
30+
CHIP_ERROR FabricScopedPreEncodedValue::EncodeForRead(TLV::TLVWriter & aWriter, TLV::Tag aTag, FabricIndex aFabricIndex) const
31+
{
32+
TLV::TLVReader reader;
33+
reader.Init(mData);
34+
35+
ReturnErrorOnFailure(reader.Next());
36+
37+
return aWriter.CopyElement(aTag, reader);
38+
}
39+
40+
FabricIndex FabricScopedPreEncodedValue::GetFabricIndex() const
41+
{
42+
TLV::TLVReader reader;
43+
reader.Init(mData);
44+
CHIP_ERROR err = reader.Next();
45+
if (err != CHIP_NO_ERROR)
46+
{
47+
return kUndefinedFabricIndex;
48+
}
49+
50+
// We must have a struct here.
51+
if (reader.GetType() != TLV::kTLVType_Structure)
52+
{
53+
return kUndefinedFabricIndex;
54+
}
55+
56+
TLV::TLVType structType;
57+
err = reader.EnterContainer(structType);
58+
if (err != CHIP_NO_ERROR)
59+
{
60+
return kUndefinedFabricIndex;
61+
}
62+
63+
// Now look for a single field with the right tag.
64+
std::optional<FabricIndex> foundFabricIndex;
65+
constexpr TLV::Tag kFabricIndexTag = TLV::ContextTag(254);
66+
while ((err = reader.Next()) == CHIP_NO_ERROR)
67+
{
68+
if (reader.GetTag() != kFabricIndexTag)
69+
{
70+
continue;
71+
}
72+
73+
if (foundFabricIndex.has_value())
74+
{
75+
// Two fabric indices? Just give up. Note that this will lead to
76+
// errors encoding our value.
77+
return kUndefinedFabricIndex;
78+
}
79+
80+
err = reader.Get(foundFabricIndex.emplace());
81+
if (err != CHIP_NO_ERROR)
82+
{
83+
return kUndefinedFabricIndex;
84+
}
85+
}
86+
87+
if (err != CHIP_ERROR_END_OF_TLV)
88+
{
89+
return kUndefinedFabricIndex;
90+
}
91+
92+
err = reader.ExitContainer(structType);
93+
if (err != CHIP_NO_ERROR)
94+
{
95+
return kUndefinedFabricIndex;
96+
}
97+
98+
return foundFabricIndex.value_or(kUndefinedFabricIndex);
99+
}
100+
101+
} // namespace DataModel
102+
} // namespace app
103+
} // namespace chip

‎src/app/data-model/FabricScopedPreEncodedValue.h

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
/*
2+
* Copyright (c) 2024 Project CHIP Authors
3+
* All rights reserved.
4+
*
5+
* Licensed under the Apache License, Version 2.0 (the "License");
6+
* you may not use this file except in compliance with the License.
7+
* You may obtain a copy of the License at
8+
*
9+
* http://www.apache.org/licenses/LICENSE-2.0
10+
*
11+
* Unless required by applicable law or agreed to in writing, software
12+
* distributed under the License is distributed on an "AS IS" BASIS,
13+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
* See the License for the specific language governing permissions and
15+
* limitations under the License.
16+
*/
17+
18+
#include <lib/core/CHIPError.h>
19+
#include <lib/core/DataModelTypes.h>
20+
#include <lib/core/TLVTags.h>
21+
#include <lib/core/TLVWriter.h>
22+
23+
namespace chip {
24+
namespace app {
25+
namespace DataModel {
26+
27+
/**
28+
* FabridScopedPreEncodedValue represents the value of a single item in a list
29+
* of fabric-scoped structs that has already been encoded as TLV. To enable
30+
* reading these values successfully, the struct must have the fabric index it
31+
* corresponds to encoded with the right tag.
32+
*
33+
* Note: Fabric-sensitive fields are currently not supported; there is no way to
34+
* specify which fields are fabric-sensitive.
35+
*/
36+
class FabricScopedPreEncodedValue
37+
{
38+
public:
39+
/**
40+
* The data buffer backing the ByteSpan must outlive the
41+
* FabricScopedPreEncodedValue instance.
42+
*/
43+
FabricScopedPreEncodedValue(const ByteSpan & aData);
44+
45+
/**
46+
* Encodable object API implementation.
47+
*/
48+
static constexpr bool kIsFabricScoped = true;
49+
CHIP_ERROR EncodeForRead(TLV::TLVWriter & aWriter, TLV::Tag aTag, FabricIndex aFabricIndex) const;
50+
FabricIndex GetFabricIndex() const;
51+
52+
private:
53+
const ByteSpan mData;
54+
};
55+
56+
} // namespace DataModel
57+
} // namespace app
58+
} // namespace chip

‎src/app/data-model/PreEncodedValue.cpp

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
/*
2+
* Copyright (c) 2024 Project CHIP Authors
3+
* All rights reserved.
4+
*
5+
* Licensed under the Apache License, Version 2.0 (the "License");
6+
* you may not use this file except in compliance with the License.
7+
* You may obtain a copy of the License at
8+
*
9+
* http://www.apache.org/licenses/LICENSE-2.0
10+
*
11+
* Unless required by applicable law or agreed to in writing, software
12+
* distributed under the License is distributed on an "AS IS" BASIS,
13+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
* See the License for the specific language governing permissions and
15+
* limitations under the License.
16+
*/
17+
18+
#include "PreEncodedValue.h"
19+
#include <lib/core/TLVReader.h>
20+
#include <lib/support/CodeUtils.h>
21+
22+
namespace chip {
23+
namespace app {
24+
namespace DataModel {
25+
26+
PreEncodedValue::PreEncodedValue(const ByteSpan & aData) : mData(aData) {}
27+
28+
CHIP_ERROR PreEncodedValue::Encode(TLV::TLVWriter & aWriter, TLV::Tag aTag) const
29+
{
30+
TLV::TLVReader reader;
31+
reader.Init(mData);
32+
33+
ReturnErrorOnFailure(reader.Next());
34+
35+
return aWriter.CopyElement(aTag, reader);
36+
}
37+
38+
} // namespace DataModel
39+
} // namespace app
40+
} // namespace chip

‎src/app/data-model/PreEncodedValue.h

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
/*
2+
* Copyright (c) 2024 Project CHIP Authors
3+
* All rights reserved.
4+
*
5+
* Licensed under the Apache License, Version 2.0 (the "License");
6+
* you may not use this file except in compliance with the License.
7+
* You may obtain a copy of the License at
8+
*
9+
* http://www.apache.org/licenses/LICENSE-2.0
10+
*
11+
* Unless required by applicable law or agreed to in writing, software
12+
* distributed under the License is distributed on an "AS IS" BASIS,
13+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
* See the License for the specific language governing permissions and
15+
* limitations under the License.
16+
*/
17+
18+
#include <lib/core/CHIPError.h>
19+
#include <lib/core/TLVTags.h>
20+
#include <lib/core/TLVWriter.h>
21+
22+
namespace chip {
23+
namespace app {
24+
namespace DataModel {
25+
26+
/**
27+
* PreEncodedValue represents the value of an attribute or the value of a single
28+
* item in a list of non-fabric-scoped structs that has already been
29+
* encoded as TLV.
30+
*/
31+
class PreEncodedValue
32+
{
33+
public:
34+
/**
35+
* The data buffer backing the ByteSpan must outlive the PreEncodedValue
36+
* instance.
37+
*/
38+
PreEncodedValue(const ByteSpan & aData);
39+
40+
/**
41+
* Encodable object API implementation.
42+
*/
43+
static constexpr bool kIsFabricScoped = false;
44+
CHIP_ERROR Encode(TLV::TLVWriter & aWriter, TLV::Tag aTag) const;
45+
46+
private:
47+
const ByteSpan mData;
48+
};
49+
50+
} // namespace DataModel
51+
} // namespace app
52+
} // namespace chip

0 commit comments

Comments
 (0)