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

design.md Update #144

Open
tagatac opened this issue Jul 13, 2023 · 1 comment
Open

design.md Update #144

tagatac opened this issue Jul 13, 2023 · 1 comment

Comments

@tagatac
Copy link

tagatac commented Jul 13, 2023

Is your feature request related to a problem? Please describe.
It's not clear what the design of wslink is currently. design.md was written in 2017, and seems to contain several notes about possible implementations. Thus, I cannot tell without reading the code what design was actually implemented and how it has changed since 2017.

Describe the solution you'd like
An update to design.md to make it clear what has been implemented through version 1.11, and a removal of any notes that are no longer relevant.

Describe alternatives you've considered
Remove the design doc, and tell users to read the code instead (not ideal).

Additional context
Thanks for the project!

@jourdain
Copy link
Collaborator

The description and background still stand:

  • Python server / JavaScript client
  • RPC using Python decorator (JS can call Python. Not symmetric) with support for args and kwargs.
  • Pub/Sub can be done from either side.
  • Binary attachments can be added to RPC and Pub/Sub messages

The rest are just implementation details.

The big difference when we moved to v1.0.0+ was to use Python 3.6+ only and asyncio as core. The first initial backend implementation is based on aiohttp. A generic backend is available and tested by enabling tornado via the generic one.

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

No branches or pull requests

2 participants