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

feat(net): Switch to typedefs for WiFiClient, WiFiServer, WiFiUdp and WiFiClientSecure #9909

Merged
merged 3 commits into from
Jun 24, 2024

Conversation

me-no-dev
Copy link
Member

Deprecates WiFiClient, WiFiServer, WiFiUdp and WiFiClientSecure

Fixes: #9891

Deprecates WiFiClient, WiFiServer, WiFiUdp and WiFiClientSecure
Copy link
Contributor

github-actions bot commented Jun 20, 2024

Messages
📖 You might consider squashing your 3 commits (simplifying branch history).

👋 Hello me-no-dev, we appreciate your contribution to this project!


Click to see more instructions ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- Addressing info messages (📖) is strongly recommended; they're less critical but valuable.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests.

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
4. If the change is approved and passes the tests it is merged into the default branch.

Generated by 🚫 dangerJS against d9b88b6

Copy link
Contributor

github-actions bot commented Jun 20, 2024

Test Results

 56 files   56 suites   5m 17s ⏱️
 21 tests  21 ✅ 0 💤 0 ❌
135 runs  135 ✅ 0 💤 0 ❌

Results for commit d9b88b6.

♻️ This comment has been updated with latest results.

Copy link
Contributor

Memory usage test (comparing PR against master branch)

The table below shows the summary of memory usage change (decrease - increase) in bytes and percentage for each target.

MemoryFLASH [bytes]FLASH [%]RAM [bytes]RAM [%]
TargetDECINCDECINCDECINCDECINC
ESP32S3000.000.00000.000.00
ESP32S2000.000.00000.000.00
ESP32C3000.000.00000.000.00
ESP32C6000.000.00000.000.00
ESP32000.000.00000.000.00
Click to expand the detailed deltas report [usage change in BYTES]
TargetESP32S3ESP32S2ESP32C3ESP32C6ESP32
ExampleFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAM
NetworkClientSecure/examples/WiFiClientInsecure0000000000
NetworkClientSecure/examples/WiFiClientPSK0000000000
NetworkClientSecure/examples/WiFiClientSecure0000000000
NetworkClientSecure/examples/WiFiClientSecureEnterprise0000000000
NetworkClientSecure/examples/WiFiClientSecureProtocolUpgrade0000000000
NetworkClientSecure/examples/WiFiClientShowPeerCredentials0000000000
NetworkClientSecure/examples/WiFiClientTrustOnFirstUse0000000000
WebServer/examples/UploadHugeFile0000000000
WiFi/examples/FTM/FTM_Initiator0000000000
WiFi/examples/FTM/FTM_Responder0000000000
WiFi/examples/SimpleWiFiServer0000000000
WiFi/examples/WPS0000000000
WiFi/examples/WiFiAccessPoint0000000000
WiFi/examples/WiFiBlueToothSwitch00--000000
WiFi/examples/WiFiClient0000000000
WiFi/examples/WiFiClientBasic0000000000
WiFi/examples/WiFiClientConnect0000000000
WiFi/examples/WiFiClientEnterprise0000000000
WiFi/examples/WiFiClientEvents0000000000
WiFi/examples/WiFiClientStaticIP0000000000
WiFi/examples/WiFiIPv60000000000
WiFi/examples/WiFiMulti0000000000
WiFi/examples/WiFiMultiAdvanced0000000000
WiFi/examples/WiFiScan0000000000
WiFi/examples/WiFiScanAsync0000000000
WiFi/examples/WiFiScanDualAntenna0000000000
WiFi/examples/WiFiSmartConfig0000000000
WiFi/examples/WiFiTelnetToSerial0000000000
WiFi/examples/WiFiUDPClient0000000000

Defines are added to not cause deprecation warnings. Will be removed in the future
@me-no-dev
Copy link
Member Author

It's just deprecation...

Defines do not allow forward declarations
@me-no-dev me-no-dev changed the title feat(net): Deprecate WiFiClient, WiFiServer, WiFiUdp and WiFiClientSecure feat(net): Switch to typedefs for WiFiClient, WiFiServer, WiFiUdp and WiFiClientSecure Jun 20, 2024
@JAndrassy
Copy link
Contributor

typedef is better. I wonder that there is no problem with the return value for server.accept(). but there isn't. I compiled the example of my TelnetStream library with the PR and it is OK.

@me-no-dev me-no-dev added the Status: Review needed Issue or PR is awaiting review label Jun 21, 2024
@SuGlider SuGlider self-requested a review June 23, 2024 19:51
@me-no-dev me-no-dev added Status: Pending Merge Pull Request is ready to be merged and removed Status: Review needed Issue or PR is awaiting review labels Jun 24, 2024
@me-no-dev me-no-dev merged commit ad1de0b into master Jun 24, 2024
99 of 104 checks passed
@me-no-dev me-no-dev deleted the feature/deprecate_wifi_client_server_udp branch June 24, 2024 07:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Pending Merge Pull Request is ready to be merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

WiFiClient and related macros - troubles when using forward declarations
4 participants