-
Notifications
You must be signed in to change notification settings - Fork 178
Add documentation for shared pointer class #671
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 5 commits
c459970
5eec8c2
151aab0
6cf985e
1192470
37aa27a
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
## Shared Pointer | ||
|
||
A shared pointer is a "smart" pointer that retains ownership of an object by using reference counting accross all smart pointers referencing that object. | ||
|
||
It is similar to the `std::shared_ptr` class introduced in C++11. However, this is not a compatible implementation, as there are no weak pointers, no `make_shared`, no custom deleters, and so on. | ||
|
||
Usage: `SharedPtr<Class> ptr(new Class())` | ||
|
||
When `ptr` is passed around by a value, the copy constructor and destructor manage the reference count of the raw pointer. If the counter reaches zero, `delete` is called on the raw pointer. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. s/manage/manages |
||
|
||
To avoid loops, use "weak" references by calling the original pointer directly with `ptr.get()`. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I would remove that sentence as it is misleading and can lead to access of a dangling pointer as it is not possible to know if a pointer acquired previously with |
||
|
||
|
||
### SharedPtr class reference | ||
|
||
[](https://os-doc-builder.test.mbed.com/docs/development/mbed-os-api-doxy/class_shared_ptr.html) | ||
|
||
### Shared pointer example | ||
|
||
``` | ||
#include "platform/SharedPtr.h" | ||
|
||
void test() { | ||
struct MyStruct { int a; }; | ||
|
||
// Create shared pointer | ||
SharedPtr<MyStruct> ptr( new MyStruct ); | ||
|
||
// Increase reference count | ||
SharedPtr<MyStruct> ptr2( ptr ); | ||
|
||
ptr = NULL; // Reference to the struct instance is still held by ptr2 | ||
|
||
ptr2 = NULL; // The raw pointer is freed | ||
} | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could it be clarified what
that
is suppose to mean in this sentence?