-
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
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
c459970
Add documentation for shared pointer class
5eec8c2
Update SharedPtr.md
jen3andruska 151aab0
Update SharedPtr.md
jen3andruska 6cf985e
Update SharedPtr.md
jen3andruska 1192470
Fix spacing.
37aa27a
Remove 'looping' reference
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,34 @@ | ||
## 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 |
||
|
||
|
||
### 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 | ||
} | ||
``` |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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?