Skip to content
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

Clarify the documented behavior and lifetime of key handles [v2] #235

Merged
merged 6 commits into from
Aug 23, 2019

Conversation

athoelke
Copy link
Contributor

This PR targets the development branch. Supercedes previous version #233.

This accompanies changes in the overview documentation relating to the lifetime and behavior of key handles.

The information about implmementation keys is duplicated.
- Describe the implementation defined behavior for opening multiple 
keys, and provide a reference to the relevant section.

- Describe the use of INSUFFICENT_MEMORY error to indicate additional 
implementation resource constaints.

- Clarify the distinction between DOES_NOT_EXIST and INVALID_HANDLE 
error conditions.
Adjust the wording to permit multiple handles to a single key - closing
a handle does not necessarily release volatile memory associated with
the key, that only occurs when the last handle is closed.
Define the affect on handles to the key and on active multipart 
operations.
@Patater
Copy link
Contributor

Patater commented Aug 23, 2019

@adrianlshaw Could you please review?

@adrianlshaw
Copy link
Contributor

Looks good 👍

@Patater Patater merged commit b14a48b into ARMmbed:development Aug 23, 2019
@athoelke athoelke deleted the at-key-handles branch September 5, 2019 08:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants