Skip to content

sockets: Update documentation #884

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.

Sign up for GitHub

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

Open
badeend wants to merge 3 commits into
base: main
Choose a base branch
from
+151 −75
Open

sockets: Update documentation #884

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a71263a
Update sockets documentation:
badeend Feb 15, 2026
ad79238
Update proposals/sockets/wit-0.3.0-draft/types.wit
badeend Feb 25, 2026
50e0500
Apply suggestions from code review
badeend Feb 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion proposals/sockets/TcpSocketOperationalSemantics-0.3.0-draft.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ stateDiagram-v2
state "closed" as Closed


[*] --> Unbound: create-tcp-socket() -> ok
[*] --> Unbound: create() -> ok
Unbound --> Bound: bind() -> ok
Unbound --> Connecting: connect()

Expand Down
12 changes: 6 additions & 6 deletions proposals/sockets/wit-0.3.0-draft/ip-name-lookup.wit
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ interface ip-name-lookup {
@since(version = 0.3.0-rc-2026-02-09)
enum error-code {
/// Unknown error
///
/// This is an escape hatch for WASI implementations to handle failures
/// that can not be categorized under any of the other error codes.
unknown,

/// Access denied.
Expand Down Expand Up @@ -37,9 +40,9 @@ interface ip-name-lookup {

/// Resolve an internet host name to a list of IP addresses.
///
/// Unicode domain names are automatically converted to ASCII using IDNA encoding.
/// If the input is an IP address string, the address is parsed and returned
/// as-is without making any external requests.
/// Unicode domain names are automatically converted to ASCII using IDNA
/// encoding. If the input is an IP address string, the address is parsed
/// and returned as-is without making any external requests.
///
/// See the wasi-socket proposal README.md for a comparison with getaddrinfo.
///
Expand All @@ -49,9 +52,6 @@ interface ip-name-lookup {
/// with at least one address. Additionally, this function never returns
/// IPv4-mapped IPv6 addresses.
///
/// The returned future will resolve to an error code in case of failure.
/// It will resolve to success once the returned stream is exhausted.
///
/// # References:
/// - <https://pubs.opengroup.org/onlinepubs/9699919799/functions/getaddrinfo.html>
/// - <https://man7.org/linux/man-pages/man3/getaddrinfo.3.html>
Expand Down
Loading