Skip to content

Commit 33244a2

Browse files
serges147serges147
committed
rename "Observer" & observeFragments -> "Visitor" & forEachFragment 
1 parent 9a12b61 commit 33244a2

File tree

6 files changed

+56
-54
lines changed

6 files changed

+56
-54
lines changed

‎include/libcyphal/transport/can/delegate.hpp‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,11 +101,11 @@ class CanardMemory final : public ScatteredBuffer::IStorage
101101
return bytes_to_copy;
102102
}
103103

104-
void observeFragments(ScatteredBuffer::IFragmentsObserver& observer) const override
104+
void forEachFragment(ScatteredBuffer::IFragmentsVisitor& visitor) const override
105105
{
106106
if ((buffer_ != nullptr) && (payload_size_ > 0))
107107
{
108-
observer.onNext({buffer_, payload_size_});
108+
visitor.onNext({buffer_, payload_size_});
109109
}
110110
}
111111

‎include/libcyphal/transport/scattered_buffer.hpp‎

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -34,25 +34,27 @@ class ScatteredBuffer final
3434
///
3535
static constexpr std::size_t StorageVariantFootprint = config::Transport::ScatteredBuffer_StorageVariantFootprint();
3636

37-
/// @brief Defines interface for observing internal fragments of the scattered buffer.
37+
/// @brief Defines interface for visiting internal fragments of the scattered buffer.
3838
///
39-
class IFragmentsObserver
39+
class IFragmentsVisitor
4040
{
4141
public:
42-
IFragmentsObserver(const IFragmentsObserver&) = delete;
43-
IFragmentsObserver& operator=(const IFragmentsObserver&) = delete;
44-
IFragmentsObserver& operator=(IFragmentsObserver&&) noexcept = delete;
45-
IFragmentsObserver(IFragmentsObserver&&) noexcept = delete;
42+
IFragmentsVisitor(const IFragmentsVisitor&) = delete;
43+
IFragmentsVisitor& operator=(const IFragmentsVisitor&) = delete;
44+
IFragmentsVisitor& operator=(IFragmentsVisitor&&) noexcept = delete;
45+
IFragmentsVisitor(IFragmentsVisitor&&) noexcept = delete;
4646

47-
/// @brief Notifies the observer about the next fragment of the scattered buffer.
47+
/// @brief Notifies the visitor about the next fragment of the scattered buffer.
48+
///
49+
/// See also `forEachFragment` method of the `ScatteredBuffer`.
4850
///
4951
virtual void onNext(const PayloadFragment fragment) = 0;
5052

5153
protected:
52-
IFragmentsObserver() = default;
53-
~IFragmentsObserver() = default;
54+
IFragmentsVisitor() = default;
55+
~IFragmentsVisitor() = default;
5456

55-
}; // IFragmentsObserver
57+
}; // IFragmentsVisitor
5658

5759
/// @brief Defines storage interface for the scattered buffer.
5860
///
@@ -93,11 +95,11 @@ class ScatteredBuffer final
9395
cetl::byte* const destination,
9496
const std::size_t length_bytes) const = 0;
9597

96-
/// @brief Reports the internal fragments of the storage to the specified observer.
98+
/// @brief Reports the internal fragments of the storage to the specified visitor.
9799
///
98-
/// @param observer The observer will be called (by `onNext` method) for each fragment of the storage.
100+
/// @param visitor The visitor will be called (by `onNext` method) for each fragment of the storage.
99101
///
100-
virtual void observeFragments(IFragmentsObserver& observer) const = 0;
102+
virtual void forEachFragment(IFragmentsVisitor& visitor) const = 0;
101103

102104
// MARK: RTTI
103105

@@ -228,15 +230,15 @@ class ScatteredBuffer final
228230
return storage_->copy(offset_bytes, static_cast<cetl::byte*>(destination), length_bytes);
229231
}
230232

231-
/// @brief Reports the internal fragments of the buffer to the specified observer.
233+
/// @brief Reports the internal fragments of the storage to the specified visitor.
232234
///
233-
/// @param observer The observer will be called (by `onNext` method) for each fragment of the buffer.
235+
/// @param visitor The visitor will be called (by `onNext` method) for each fragment of the storage.
234236
///
235-
void observeFragments(IFragmentsObserver& observer) const
237+
void forEachFragment(IFragmentsVisitor& visitor) const
236238
{
237239
if (const auto* const storage = storage_)
238240
{
239-
storage->observeFragments(observer);
241+
storage->forEachFragment(visitor);
240242
}
241243
}
242244

‎include/libcyphal/transport/udp/delegate.hpp‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -190,16 +190,16 @@ class UdpardMemory final : public ScatteredBuffer::IStorage
190190
return total_bytes_copied;
191191
}
192192

193-
void observeFragments(ScatteredBuffer::IFragmentsObserver& observer) const override
193+
void forEachFragment(ScatteredBuffer::IFragmentsVisitor& visitor) const override
194194
{
195195
const UdpardFragment* fragment = &payload_;
196196
while (nullptr != fragment)
197197
{
198198
const auto& frag_view = fragment->view;
199199
if ((nullptr != frag_view.data) && (frag_view.size > 0))
200200
{
201-
observer.onNext({static_cast<const cetl::byte*>(frag_view.data), // NOSONAR cpp:S5356 cpp:S5357
202-
frag_view.size});
201+
visitor.onNext({static_cast<const cetl::byte*>(frag_view.data), // NOSONAR cpp:S5356 cpp:S5357
202+
frag_view.size});
203203
}
204204

205205
fragment = fragment->next;

‎test/unittest/transport/can/test_can_delegate.cpp‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -195,11 +195,11 @@ TEST_F(TestCanDelegate, CanardMemory_copy_on_moved)
195195
}
196196
}
197197

198-
TEST_F(TestCanDelegate, CanardMemory_observeFragments)
198+
TEST_F(TestCanDelegate, CanardMemory_forEachFragment)
199199
{
200200
// Valid payload
201201
{
202-
StrictMock<ScatteredBufferObserverMock> observer_mock;
202+
StrictMock<ScatteredBufferVisitorMock> visitor_mock;
203203

204204
constexpr std::size_t payload_size = 4;
205205
auto* const payload = static_cast<byte*>(mr_.allocate(payload_size));
@@ -208,30 +208,30 @@ TEST_F(TestCanDelegate, CanardMemory_observeFragments)
208208
CanardMutablePayload canard_payload{payload_size, payload, payload_size};
209209
const CanardMemory canard_memory{mr_, canard_payload};
210210

211-
EXPECT_CALL(observer_mock, onNext(ElementsAre(b('0'), b('1'), b('2'), b('3'))));
212-
canard_memory.observeFragments(observer_mock);
211+
EXPECT_CALL(visitor_mock, onNext(ElementsAre(b('0'), b('1'), b('2'), b('3'))));
212+
canard_memory.forEachFragment(visitor_mock);
213213
}
214214

215215
// Zero size
216216
{
217-
StrictMock<ScatteredBufferObserverMock> observer_mock;
217+
StrictMock<ScatteredBufferVisitorMock> visitor_mock;
218218

219219
constexpr std::size_t payload_size = 0;
220220
auto* const payload = static_cast<byte*>(mr_.allocate(payload_size));
221221
fillIotaBytes({payload, payload_size}, b('0'));
222222

223223
CanardMutablePayload canard_payload{payload_size, payload, payload_size};
224224
const CanardMemory canard_memory{mr_, canard_payload};
225-
canard_memory.observeFragments(observer_mock);
225+
canard_memory.forEachFragment(visitor_mock);
226226
}
227227

228228
// Null
229229
{
230-
StrictMock<ScatteredBufferObserverMock> observer_mock;
230+
StrictMock<ScatteredBufferVisitorMock> visitor_mock;
231231

232232
CanardMutablePayload canard_payload{0, nullptr, 0};
233233
const CanardMemory canard_memory{mr_, canard_payload};
234-
canard_memory.observeFragments(observer_mock);
234+
canard_memory.forEachFragment(visitor_mock);
235235
}
236236
}
237237

‎test/unittest/transport/scattered_buffer_storage_mock.hpp‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -72,11 +72,11 @@ class ScatteredBufferStorageMock : public ScatteredBuffer::IStorage
7272
return (mock_ != nullptr) ? mock_->copy(offset_bytes, destination, length_bytes) : 0;
7373
}
7474

75-
void observeFragments(ScatteredBuffer::IFragmentsObserver& observer) const override
75+
void forEachFragment(ScatteredBuffer::IFragmentsVisitor& visitor) const override
7676
{
7777
if (nullptr != mock_)
7878
{
79-
mock_->observeFragments(observer);
79+
mock_->forEachFragment(visitor);
8080
}
8181
}
8282

@@ -109,24 +109,24 @@ class ScatteredBufferStorageMock : public ScatteredBuffer::IStorage
109109

110110
MOCK_METHOD(std::size_t, size, (), (const, noexcept, override)); // NOLINT(bugprone-exception-escape)
111111
MOCK_METHOD(std::size_t, copy, (const std::size_t, cetl::byte* const, const std::size_t), (const, override));
112-
MOCK_METHOD(void, observeFragments, (ScatteredBuffer::IFragmentsObserver & observer), (const, override));
112+
MOCK_METHOD(void, forEachFragment, (ScatteredBuffer::IFragmentsVisitor&), (const, override));
113113

114114
}; // ScatteredBufferStorageMock
115115

116-
class ScatteredBufferObserverMock : public ScatteredBuffer::IFragmentsObserver
116+
class ScatteredBufferVisitorMock : public ScatteredBuffer::IFragmentsVisitor
117117
{
118118
public:
119-
ScatteredBufferObserverMock() = default;
120-
virtual ~ScatteredBufferObserverMock() = default;
119+
ScatteredBufferVisitorMock() = default;
120+
virtual ~ScatteredBufferVisitorMock() = default;
121121

122-
ScatteredBufferObserverMock(const ScatteredBufferObserverMock&) = delete;
123-
ScatteredBufferObserverMock(ScatteredBufferObserverMock&&) noexcept = delete;
124-
ScatteredBufferObserverMock& operator=(const ScatteredBufferObserverMock&) = delete;
125-
ScatteredBufferObserverMock& operator=(ScatteredBufferObserverMock&&) noexcept = delete;
122+
ScatteredBufferVisitorMock(const ScatteredBufferVisitorMock&) = delete;
123+
ScatteredBufferVisitorMock(ScatteredBufferVisitorMock&&) noexcept = delete;
124+
ScatteredBufferVisitorMock& operator=(const ScatteredBufferVisitorMock&) = delete;
125+
ScatteredBufferVisitorMock& operator=(ScatteredBufferVisitorMock&&) noexcept = delete;
126126

127127
MOCK_METHOD(void, onNext, (const PayloadFragment fragment), (override));
128128

129-
}; // ScatteredBufferObserverMock
129+
}; // ScatteredBufferVisitorMock
130130

131131
} // namespace transport
132132
} // namespace libcyphal

‎test/unittest/transport/udp/test_udp_delegate.cpp‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -342,7 +342,7 @@ TEST_F(TestUdpDelegate, UdpardMemory_copy_empty)
342342
EXPECT_THAT(udpard_memory.copy(1, buffer.data(), 3), 0);
343343
}
344344

345-
TEST_F(TestUdpDelegate, UdpardMemory_observeFragments)
345+
TEST_F(TestUdpDelegate, UdpardMemory_forEachFragment)
346346
{
347347
const TransportDelegateImpl delegate{general_mr_, &fragment_mr_, &payload_mr_};
348348

@@ -358,9 +358,9 @@ TEST_F(TestUdpDelegate, UdpardMemory_observeFragments)
358358

359359
const UdpardMemory udpard_memory{delegate.memoryResources(), rx_transfer};
360360

361-
StrictMock<ScatteredBufferObserverMock> observer_mock;
362-
EXPECT_CALL(observer_mock, onNext(ElementsAre(b('0'), b('1'), b('2'), b('3'))));
363-
udpard_memory.observeFragments(observer_mock);
361+
StrictMock<ScatteredBufferVisitorMock> visitor_mock;
362+
EXPECT_CALL(visitor_mock, onNext(ElementsAre(b('0'), b('1'), b('2'), b('3'))));
363+
udpard_memory.forEachFragment(visitor_mock);
364364
}
365365

366366
// Valid multi-fragment payload
@@ -387,11 +387,11 @@ TEST_F(TestUdpDelegate, UdpardMemory_observeFragments)
387387
const UdpardMemory udpard_memory{delegate.memoryResources(), rx_transfer};
388388

389389
const testing::InSequence in_sequence;
390-
StrictMock<ScatteredBufferObserverMock> observer_mock;
391-
EXPECT_CALL(observer_mock, onNext(ElementsAre(b('2'), b('3'), b('4'))));
392-
EXPECT_CALL(observer_mock, onNext(ElementsAre(b('B'), b('C'), b('D'), b('E'))));
393-
EXPECT_CALL(observer_mock, onNext(ElementsAre(b('d'), b('e'))));
394-
udpard_memory.observeFragments(observer_mock);
390+
StrictMock<ScatteredBufferVisitorMock> visitor_mock;
391+
EXPECT_CALL(visitor_mock, onNext(ElementsAre(b('2'), b('3'), b('4'))));
392+
EXPECT_CALL(visitor_mock, onNext(ElementsAre(b('B'), b('C'), b('D'), b('E'))));
393+
EXPECT_CALL(visitor_mock, onNext(ElementsAre(b('d'), b('e'))));
394+
udpard_memory.forEachFragment(visitor_mock);
395395
}
396396

397397
// Zero size
@@ -406,8 +406,8 @@ TEST_F(TestUdpDelegate, UdpardMemory_observeFragments)
406406

407407
const UdpardMemory udpard_memory{delegate.memoryResources(), rx_transfer};
408408

409-
StrictMock<ScatteredBufferObserverMock> observer_mock;
410-
udpard_memory.observeFragments(observer_mock);
409+
StrictMock<ScatteredBufferVisitorMock> visitor_mock;
410+
udpard_memory.forEachFragment(visitor_mock);
411411
}
412412

413413
// Null
@@ -418,8 +418,8 @@ TEST_F(TestUdpDelegate, UdpardMemory_observeFragments)
418418

419419
const UdpardMemory udpard_memory{delegate.memoryResources(), rx_transfer};
420420

421-
StrictMock<ScatteredBufferObserverMock> observer_mock;
422-
udpard_memory.observeFragments(observer_mock);
421+
StrictMock<ScatteredBufferVisitorMock> visitor_mock;
422+
udpard_memory.forEachFragment(visitor_mock);
423423
}
424424
}
425425

0 commit comments

Comments
 (0)