-
Notifications
You must be signed in to change notification settings - Fork 4
Add full docs for the TCP api #3
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
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
These functions don't have a family argument
This is purely for the annotations dev experience
luasocket splits them into master, client, and server
Makes it fit with new type, also some stylistic changes
Collaborator
|
Thank you! |
Collaborator
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
These are all the docs in https://lunarmodules.github.io/luasocket/tcp.html, and some modifications to the existing docs related to tcp. The site only documents certain functions for specific types, like
acceptonly exists for server sockets. I've tried to encode this in the typesTCPSocketMaster,TCPSocketServer, andTCPSocketClient.It does mean that the user needs to cast the master socket to either a server or client socket when appropriate :(, I've written down in the documentation when this should happen. I feel like this provides the most type safety with only a little friction for the user.
Creating a socket would look kinda like this (note the cast):
Let me know what you think :D
PS: This should probably be a squash merge, I might have made too many commits. I'm happy to squash all of this into a single commit myself if it makes it easier for you :')