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

Cellular: retire CellularBase class #9746

Merged
merged 3 commits into from Feb 20, 2019

Conversation

@blind-owl
Copy link
Contributor

commented Feb 18, 2019

Description

It was decided to retire CellularBase class which served as a pure
virtual interface class from which Cellular network stack
implementations would get inherited. However, the current view is that
we may be the only user of it so we could retire CellularBase.

Test coverage:

  • unit tests. All pass
  • MTB_ADV_WISE_1570 ontarget gt tests, no regression compared to master

Pull request type

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

Reviewers

Release Notes

In order to align to other connectivity technologies CellularBase is deprecated and CellularInterface usage is preferred. This change is backward compatible.

Cellular: retire CellularBase class
It was decided to retire CellularBase class which served as a pure
virtual interface class from which Cellular network stack
implementations would get inherited. However, the current view is that
we may be the only user of it so we could retire CellularBase.

@AriParkkila AriParkkila referenced this pull request Feb 18, 2019

Merged

Cellular docs updated #914

@0xc0170

This comment has been minimized.

Copy link
Member

commented Feb 18, 2019

Rather than refactor, should this be functionality change ? It's backward compatible as we just deprecating but removing one?

In any case, this should be covered by in the release notes (add Release notes section to the first comment here please)

@blind-owl

This comment has been minimized.

Copy link
Contributor Author

commented Feb 18, 2019

As requested release notes section has been added.
Pull request type adapts to #9219 which is also a refactor type.

@ciarmcom ciarmcom requested review from ARMmbed/mbed-os-maintainers Feb 18, 2019

@ciarmcom

This comment has been minimized.

Copy link
Member

commented Feb 18, 2019


/** @copydoc NetworkInterface::cellularBase
*/
MBED_DEPRECATED_SINCE("mbed-os-5.12", "Migrated to CellularInterface")

This comment has been minimized.

Copy link
@SeppoTakalo

SeppoTakalo Feb 18, 2019

Contributor

How can something new be already deprecated?

Did you copy&paste the code without removing the deprecation notices?

This comment has been minimized.

Copy link
@SeppoTakalo

SeppoTakalo Feb 18, 2019

Contributor

Ah.. just noticed that this is just to maintain backward compatibility.

*/
virtual void set_default_parameters();
};
MBED_DEPRECATED_SINCE("mbed-os-5.12", "Migrated to CellularInterface")

This comment has been minimized.

Copy link
@SeppoTakalo

SeppoTakalo Feb 18, 2019

Contributor

Is this working?
Does it actually cause deprecation notice to come up?

@0xc0170
Copy link
Member

left a comment

It was decided to retire CellularBase class which served as a pure
virtual interface class from which Cellular network stack
implementations would get inherited. However, the current view is that
we may be the only user of it so we could retire CellularBase.

Is this sufficient info for this deprecation? No migration needed?

Show resolved Hide resolved features/netsocket/CellularInterface.h
@AnttiKauppila

This comment has been minimized.

Copy link
Contributor

commented Feb 18, 2019

This is backwards compatible (CellularBase == CellularInterface), so no real impacts to existing users.

@0xc0170 0xc0170 requested review from donatieng and SenRamakri Feb 19, 2019

@0xc0170

This comment has been minimized.

Copy link
Member

commented Feb 19, 2019

@donatieng / @SenRamakri Please review

@AnotherButler Please review the docs

@cmonr

This comment has been minimized.

Copy link
Contributor

commented Feb 19, 2019

CI started whist waiting on final reviewers

@cmonr cmonr added needs: review and removed needs: CI labels Feb 19, 2019

@cmonr

This comment has been minimized.

Copy link
Contributor

commented Feb 19, 2019

@0xc0170 Remember that @AnotherButler will review the Review Notes once they're consolidated.

@mbed-ci

This comment has been minimized.

Copy link

commented Feb 19, 2019

Test run: FAILED

Summary: 1 of 8 test jobs failed
Build number : 1
Build artifacts

Failed test jobs:

  • jenkins-ci/mbed-os-ci_build-ARM

@0xc0170 0xc0170 added needs: CI and removed needs: review labels Feb 20, 2019

@0xc0170

This comment has been minimized.

Copy link
Member

commented Feb 20, 2019

CI restarted

@mbed-ci

This comment has been minimized.

Copy link

commented Feb 20, 2019

Test run: SUCCESS

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

@0xc0170 0xc0170 added needs: review and removed needs: CI labels Feb 20, 2019

@0xc0170

This comment has been minimized.

Copy link
Member

commented Feb 20, 2019

@donatieng / @SenRamakri Please review

Waiting for the final approval

@kjbracey-arm
Copy link
Contributor

left a comment

If this is just renaming CellularBase to CellularInterface, I personally approve on naming consistency grounds. It's inline with all the rest of the IP core stuff.

#4119 for Mbed OS 5.5 started with CellularInterface, but it got turned into CellularBase during review. (Mainly feedback from @geky and @sg-, as I recall). IIRC, it was partly confusion about whether it was a "C++ interface" or a "network interface" (it's actually both, of course).

No corresponding changes were ever made anywhere else in the networking stuff, so that's just left it just an odd one out, which is annoying. (And I'm unclear how CellularInterface continued to exist alongside CellularBase)

@0xc0170 0xc0170 merged commit 5ada4bf into ARMmbed:master Feb 20, 2019

27 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(+0 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 10443 cycles (+138 cycles)
Details
travis-ci/gitattributestest Local gitattributestest testing has passed
Details
travis-ci/include_check Local include_check testing has passed
Details
travis-ci/licence_check Local licence_check testing has passed
Details
travis-ci/littlefs Passed, code size is 8408B (+0.00%)
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
travis-ci/tools-py3.5 Local tools-py3.5 testing has passed
Details
travis-ci/tools-py3.6 Local tools-py3.6 testing has passed
Details
travis-ci/tools-py3.7 Local tools-py3.7 testing has passed
Details

@blind-owl blind-owl deleted the blind-owl:retire_cellularbase_class branch Feb 21, 2019

@SeppoTakalo SeppoTakalo referenced this pull request Feb 21, 2019

Merged

New Wiced binaries #9796

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.