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

Old-style net API deprecation #1762

Closed
3 of 4 tasks
djphoenix opened this issue Jan 26, 2017 · 12 comments
Closed
3 of 4 tasks

Old-style net API deprecation #1762

djphoenix opened this issue Jan 26, 2017 · 12 comments

Comments

@djphoenix
Copy link
Contributor

djphoenix commented Jan 26, 2017

Now we have new APIs for creation TLS connections and UDP sockets, and so old APIs that kept only for backward compatibility (just convenience calls):

  • net.createConnection(net.UDP) -> net.createUDPSocket()
  • net.createServer(net.UDP) -> net.createUDPSocket()
  • net.createConnection(net.TCP, 1) -> tls.createConnection()

I propose to:

  • After upcoming master drop, set net.createConnection() behaviour to create plain tcp connection by default (without options).
  • Add deprecation message to the docs
  • Add deprecation message to the firmware (requires Add generic function to print deprecation notes #1538).
  • After (upcoming+1) master drop, completely remove deprecated feature, and keep only separated APIs.
@marcelstoer
Copy link
Member

I basically agree but this

Add deprecation message to docs

should be done before the upcoming merge.

@jmattsson
Copy link
Member

No objections from me.

@devsaurus
Copy link
Member

For sure the way to go 👍

@djphoenix
Copy link
Contributor Author

@marcelstoer

I basically agree but this [deprecation message to docs] should be done before the upcoming merge.

Can you add right message by yourself? I have not excellent english, you see :)

@marcelstoer
Copy link
Member

@djphoenix issue number 2 from your list above can be ticked off, see http://nodemcu.readthedocs.io/en/latest/en/modules/net/#netcreateconnection

@djphoenix djphoenix reopened this Feb 2, 2017
@marcelstoer
Copy link
Member

Add deprecation message to the firmware (requires #1538).

That PR is now ready.

@marcelstoer
Copy link
Member

This is fast reaching its 2nd birthday. @nwf retired the static timers in #2603. Maybe it would be a good time to finally close this one here as well.

@stale
Copy link

stale bot commented Jan 7, 2020

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label Jan 7, 2020
@nwf
Copy link
Member

nwf commented Jan 7, 2020

Hey, more dead code to eliminate. I'll take this on, too, as part of my rampaging around the network stack.

@stale stale bot removed the stale label Jan 7, 2020
@marcelstoer
Copy link
Member

more dead code

And dead documentation, too 😉

@stale
Copy link

stale bot commented Jan 2, 2021

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label Jan 2, 2021
@nwf nwf removed the stale label Jan 2, 2021
@HHHartmann
Copy link
Member

I can`t see anything to do here anymore. Documentation looks good and the implementation also does not allow for options anymore.

Can we close this?

@nwf nwf closed this as completed Jan 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

6 participants