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 asynchronous Networkinterface::connect() and disconnect() API #9414

Merged
merged 1 commit into from Jan 31, 2019

Conversation

Projects
None yet
9 participants
@SeppoTakalo
Copy link
Contributor

commented Jan 17, 2019

Description

This is slight API change, as a new return code is introduced.
Intention is to properly support asyncronous drivers that might
not be able to get new operation into execution, therefore they
need to return BUSY.

Pull request type

[ ] Fix
[ ] Refactor
[ ] Target update
[X] Functionality change
[ ] Docs update
[ ] Test update
[ ] Breaking change

Reviewers

@kjbracey-arm @blind-owl

@SeppoTakalo SeppoTakalo force-pushed the SeppoTakalo:ONME-4013 branch Jan 17, 2019

@ciarmcom

This comment has been minimized.

Copy link
Member

commented Jan 17, 2019

@ciarmcom ciarmcom requested review from blind-owl, kjbracey-arm and ARMmbed/mbed-os-maintainers Jan 17, 2019

@cmonr

This comment has been minimized.

Copy link
Contributor

commented Jan 17, 2019

NOTE: This PR has now been rebased.

If this was made in error, feel free to force-push your local branch to restore the PR.

@cmonr cmonr force-pushed the SeppoTakalo:ONME-4013 branch Jan 17, 2019

@blind-owl
Copy link
Contributor

left a comment

Looks ok.

Clarify asyncronous Networkinterface::connect() and disconnect() API
This is slight API change, as a new return code is introduced.
Intention is to properly support asyncronous drivers that might
not be able to get new operation into execution, therefore they
need to return BUSY.

@SeppoTakalo SeppoTakalo force-pushed the SeppoTakalo:ONME-4013 branch to 6c5b845 Jan 18, 2019

@0xc0170 0xc0170 changed the title Clarify asyncronous Networkinterface::connect() and disconnect() API Clarify asynchronous Networkinterface::connect() and disconnect() API Jan 18, 2019

@SeppoTakalo

This comment has been minimized.

Copy link
Contributor Author

commented Jan 24, 2019

@KariHaapalehto or @VeijoPesonen Please review ASAP!

@kjbracey-arm Please review!

@SeppoTakalo

This comment has been minimized.

Copy link
Contributor Author

commented Jan 30, 2019

@0xc0170 This is now approved. Please test & merge if all OK.

@0xc0170 0xc0170 added needs: CI and removed needs: review labels Jan 30, 2019

@0xc0170

This comment has been minimized.

Copy link
Member

commented Jan 30, 2019

we will do ! Currently 5.11.3 needs retesting and few fixes, most likely later today or tomorrow e start CI. I've already applied the label

@cmonr

This comment has been minimized.

Copy link
Contributor

commented Jan 30, 2019

CI started

@mbed-ci

This comment has been minimized.

Copy link

commented Jan 31, 2019

Test run: SUCCESS

Summary: 12 of 12 test jobs passed
Build number : 1
Build artifacts

@cmonr cmonr added ready for merge and removed needs: CI labels Jan 31, 2019

@0xc0170 0xc0170 merged commit a12ab30 into ARMmbed:master Jan 31, 2019

23 checks passed

continuous-integration/jenkins/pr-head This commit looks good
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
jenkins-ci/build-ARM Success
Details
jenkins-ci/build-ARMC6 Success
Details
jenkins-ci/build-GCC_ARM Success
Details
jenkins-ci/build-IAR Success
Details
jenkins-ci/cloud-client-test Success
Details
jenkins-ci/dynamic-memory-usage RTOS ROM(-24 bytes) RAM(+0 bytes)
Details
jenkins-ci/exporter Success
Details
jenkins-ci/greentea-test Success
Details
jenkins-ci/mbed2-build-ARM Success
Details
jenkins-ci/mbed2-build-GCC_ARM Success
Details
jenkins-ci/mbed2-build-IAR Success
Details
jenkins-ci/unittests Success
Details
travis-ci/astyle Local astyle testing has passed
Details
travis-ci/docs Local docs testing has passed
Details
travis-ci/doxy-spellcheck Local doxy-spellcheck testing has passed
Details
travis-ci/events Passed, runtime is 9138 cycles
Details
travis-ci/gitattributestest Local gitattributestest testing has passed
Details
travis-ci/licence_check Local licence_check testing has passed
Details
travis-ci/littlefs Passed, code size is 8408B
Details
travis-ci/psa-autogen Local psa-autogen testing has passed
Details
travis-ci/tools-py2.7 Local tools-py2.7 testing has passed
Details
@0xc0170

This comment has been minimized.

Copy link
Member

commented Jan 31, 2019

@SeppoTakalo How this functionality change should be captured in the release notes? Looking back at the commit msg and changes - the application should handle new busy state.

We shall aim to minimize to minimize breakages by adding some guidance how to port from one version to another. It might be trivial, I am just making sure we have it documented and not overlooked

@0xc0170

This comment has been minimized.

Copy link
Member

commented Jan 31, 2019

@SeppoTakalo How this functionality change should be captured in the release notes? Looking back at the commit msg and changes - the application should handle new busy state.

We are going to add this to the process, will get back to this PR once done.

@SeppoTakalo SeppoTakalo deleted the SeppoTakalo:ONME-4013 branch Jan 31, 2019

@SeppoTakalo

This comment has been minimized.

Copy link
Contributor Author

commented Jan 31, 2019

Yes,

This PR requires a documentation update as well, and might even require slight changes on drivers. Therefore we were aiming to merge in this as early as possible for 5.12, so that we still have some time to refactor driver.

We have follow up tasks regarding documentation and drivers.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.