ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #6309 from deepikabhavnani/peek_api 

Peek API to view data of buffer without popping
pull/6427/head
Cruz Monrreal 2018-03-22 11:28:15 -05:00 committed by GitHub
parent 7c272fa3e8 0b9f301268
commit 9932b4c983
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 52 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
TESTS/mbedmicro-rtos-mbed/CircularBuffer/main.cpp
View File

@ -253,13 +253,14 @@ void test_input_exceeds_capacity_push_2_pop_1_complex_type()
}
}
/* Test circular buffer - test pop(), empty(), full(), size() after CircularBuffer creation.
/* Test circular buffer - test pop(), peek(), empty(), full(), size() after CircularBuffer creation.
*
* Given is a circular buffer.
* When circular buffer is created.
* Then circular buffer is empty:
* - empty() returns true,
* - pop() function returns false,
* - peek() function returns false,
* - full() function returns false,
* - size() function returns 0,
*
@ -271,6 +272,7 @@ void test_pop_empty_full_size_after_creation()
TEST_ASSERT_TRUE(cb.empty());
TEST_ASSERT_FALSE(cb.pop(data));
TEST_ASSERT_FALSE(cb.peek(data));
TEST_ASSERT_FALSE(cb.full());
TEST_ASSERT_EQUAL(0, cb.size());
}
@ -411,6 +413,35 @@ void test_counter_type_buffer_size()
TEST_ASSERT_EQUAL(100, data);
}
/* Test circular buffer - peek should not update buffer data.
*
* When circular buffer peek operation is performed along with
* push and pop, it should not update the buffer data elements.
* Elements read using pop/peek operation should match.
*
*/
void test_peek_no_pop()
{
CircularBuffer<int, 3, unsigned char> cb;
int data = 0;
int peek_data = 0;
for (uint32_t i = 0; i < 3; i++) {
data = (0xAA + i);
cb.push(data);
cb.peek(peek_data);
TEST_ASSERT_EQUAL(i + 1, cb.size());
}
for (uint32_t i = 0; i < 3; i++) {
TEST_ASSERT_TRUE(cb.peek(peek_data));
TEST_ASSERT_EQUAL(0xAA + i, peek_data);
TEST_ASSERT_TRUE(cb.pop(data));
TEST_ASSERT_EQUAL(0xAA + i, data);
TEST_ASSERT_EQUAL(3 - i - 1, cb.size());
}
}
utest::v1::status_t greentea_failure_handler(const Case *const source, const failure_t reason)
{
greentea_case_failure_abort_handler(source, reason);
@ -446,13 +477,15 @@ Case cases[] = {
Case("reset() clears the buffer.", test_reset<uint32_t, 5>, greentea_failure_handler),
Case("Test pop(), empty(), full(), size() after CircularBuffer creation.",
Case("Test pop(), peek(), empty(), full(), size() after CircularBuffer creation.",
test_pop_empty_full_size_after_creation, greentea_failure_handler),
Case("Test CounterType/BufferSize boarder case.", test_counter_type_buffer_size, greentea_failure_handler),
Case("Input exceeds capacity(5) push 2, pop 1 - complex type.",
test_input_exceeds_capacity_push_2_pop_1_complex_type<5, unsigned short>, greentea_failure_handler),
Case("peek() return data without popping the element.", test_peek_no_pop, greentea_failure_handler),
};
utest::v1::status_t greentea_test_setup(const size_t number_of_cases)

18
platform/CircularBuffer.h
View File

@ -89,7 +89,7 @@ public:
/** Pop the transaction from the buffer
*
* @param data Data to be pushed to the buffer
* @param data Data to be popped from the buffer
* @return True if the buffer is not empty and data contains a transaction, false otherwise
*/
bool pop(T& data) {
@ -154,6 +154,22 @@ public:
core_util_critical_section_exit();
return elements;
}
/** Peek into circular buffer without popping
*
* @param data Data to be peeked from the buffer
* @return True if the buffer is not empty and data contains a transaction, false otherwise
*/
bool peek(T& data) const {
bool data_updated = false;
core_util_critical_section_enter();
if (!empty()) {
data = _pool[_tail];
data_updated = true;
}
core_util_critical_section_exit();
return data_updated;
}
private:
T _pool[BufferSize];