Skip to content
This repository was archived by the owner on Nov 25, 2025. It is now read-only.

Commit c2b436e

Browse files
badeendricochet
authored andcommitted
Add get-* prefix
1 parent 794c6b7 commit c2b436e

1 file changed

Lines changed: 20 additions & 20 deletions

File tree

wit-0.3.0-draft/types.wit

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ interface types {
221221
@since(version = 0.3.0)
222222
connect: async func(remote-address: ip-socket-address) -> result<_, error-code>;
223223

224-
/// Start listening return a stream of new inbound connections.
224+
/// Start listening and return a stream of new inbound connections.
225225
///
226226
/// Transitions the socket into the `listening` state. This can be called
227227
/// at most once per socket.
@@ -351,7 +351,7 @@ interface types {
351351
/// > If the socket has not been bound to a local name, the value
352352
/// > stored in the object pointed to by `address` is unspecified.
353353
///
354-
/// WASI is stricter and requires `local-address` to return `invalid-state` when the socket hasn't been bound yet.
354+
/// WASI is stricter and requires `get-local-address` to return `invalid-state` when the socket hasn't been bound yet.
355355
///
356356
/// # Typical errors
357357
/// - `invalid-state`: The socket is not bound to any local address.
@@ -362,7 +362,7 @@ interface types {
362362
/// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-getsockname>
363363
/// - <https://man.freebsd.org/cgi/man.cgi?getsockname>
364364
@since(version = 0.3.0)
365-
local-address: func() -> result<ip-socket-address, error-code>;
365+
get-local-address: func() -> result<ip-socket-address, error-code>;
366366

367367
/// Get the remote address.
368368
///
@@ -375,21 +375,21 @@ interface types {
375375
/// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-getpeername>
376376
/// - <https://man.freebsd.org/cgi/man.cgi?query=getpeername&sektion=2&n=1>
377377
@since(version = 0.3.0)
378-
remote-address: func() -> result<ip-socket-address, error-code>;
378+
get-remote-address: func() -> result<ip-socket-address, error-code>;
379379

380380
/// Whether the socket is in the `listening` state.
381381
///
382382
/// Equivalent to the SO_ACCEPTCONN socket option.
383383
@since(version = 0.3.0)
384-
is-listening: func() -> bool;
384+
get-is-listening: func() -> bool;
385385

386386
/// Whether this is a IPv4 or IPv6 socket.
387387
///
388388
/// This is the value passed to the constructor.
389389
///
390390
/// Equivalent to the SO_DOMAIN socket option.
391391
@since(version = 0.3.0)
392-
address-family: func() -> ip-address-family;
392+
get-address-family: func() -> ip-address-family;
393393

394394
/// Hints the desired listen queue size. Implementations are free to ignore this.
395395
///
@@ -413,7 +413,7 @@ interface types {
413413
///
414414
/// Equivalent to the SO_KEEPALIVE socket option.
415415
@since(version = 0.3.0)
416-
keep-alive-enabled: func() -> result<bool, error-code>;
416+
get-keep-alive-enabled: func() -> result<bool, error-code>;
417417
@since(version = 0.3.0)
418418
set-keep-alive-enabled: func(value: bool) -> result<_, error-code>;
419419

@@ -428,7 +428,7 @@ interface types {
428428
/// # Typical errors
429429
/// - `invalid-argument`: (set) The provided value was 0.
430430
@since(version = 0.3.0)
431-
keep-alive-idle-time: func() -> result<duration, error-code>;
431+
get-keep-alive-idle-time: func() -> result<duration, error-code>;
432432
@since(version = 0.3.0)
433433
set-keep-alive-idle-time: func(value: duration) -> result<_, error-code>;
434434

@@ -443,7 +443,7 @@ interface types {
443443
/// # Typical errors
444444
/// - `invalid-argument`: (set) The provided value was 0.
445445
@since(version = 0.3.0)
446-
keep-alive-interval: func() -> result<duration, error-code>;
446+
get-keep-alive-interval: func() -> result<duration, error-code>;
447447
@since(version = 0.3.0)
448448
set-keep-alive-interval: func(value: duration) -> result<_, error-code>;
449449

@@ -458,7 +458,7 @@ interface types {
458458
/// # Typical errors
459459
/// - `invalid-argument`: (set) The provided value was 0.
460460
@since(version = 0.3.0)
461-
keep-alive-count: func() -> result<u32, error-code>;
461+
get-keep-alive-count: func() -> result<u32, error-code>;
462462
@since(version = 0.3.0)
463463
set-keep-alive-count: func(value: u32) -> result<_, error-code>;
464464

@@ -469,7 +469,7 @@ interface types {
469469
/// # Typical errors
470470
/// - `invalid-argument`: (set) The TTL value must be 1 or higher.
471471
@since(version = 0.3.0)
472-
hop-limit: func() -> result<u8, error-code>;
472+
get-hop-limit: func() -> result<u8, error-code>;
473473
@since(version = 0.3.0)
474474
set-hop-limit: func(value: u8) -> result<_, error-code>;
475475

@@ -484,11 +484,11 @@ interface types {
484484
/// # Typical errors
485485
/// - `invalid-argument`: (set) The provided value was 0.
486486
@since(version = 0.3.0)
487-
receive-buffer-size: func() -> result<u64, error-code>;
487+
get-receive-buffer-size: func() -> result<u64, error-code>;
488488
@since(version = 0.3.0)
489489
set-receive-buffer-size: func(value: u64) -> result<_, error-code>;
490490
@since(version = 0.3.0)
491-
send-buffer-size: func() -> result<u64, error-code>;
491+
get-send-buffer-size: func() -> result<u64, error-code>;
492492
@since(version = 0.3.0)
493493
set-send-buffer-size: func(value: u64) -> result<_, error-code>;
494494
}
@@ -658,7 +658,7 @@ interface types {
658658
/// > If the socket has not been bound to a local name, the value
659659
/// > stored in the object pointed to by `address` is unspecified.
660660
///
661-
/// WASI is stricter and requires `local-address` to return `invalid-state` when the socket hasn't been bound yet.
661+
/// WASI is stricter and requires `get-local-address` to return `invalid-state` when the socket hasn't been bound yet.
662662
///
663663
/// # Typical errors
664664
/// - `invalid-state`: The socket is not bound to any local address.
@@ -669,7 +669,7 @@ interface types {
669669
/// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-getsockname>
670670
/// - <https://man.freebsd.org/cgi/man.cgi?getsockname>
671671
@since(version = 0.3.0)
672-
local-address: func() -> result<ip-socket-address, error-code>;
672+
get-local-address: func() -> result<ip-socket-address, error-code>;
673673

674674
/// Get the address the socket is currently "connected" to.
675675
///
@@ -682,15 +682,15 @@ interface types {
682682
/// - <https://learn.microsoft.com/en-us/windows/win32/api/winsock/nf-winsock-getpeername>
683683
/// - <https://man.freebsd.org/cgi/man.cgi?query=getpeername&sektion=2&n=1>
684684
@since(version = 0.3.0)
685-
remote-address: func() -> result<ip-socket-address, error-code>;
685+
get-remote-address: func() -> result<ip-socket-address, error-code>;
686686

687687
/// Whether this is a IPv4 or IPv6 socket.
688688
///
689689
/// This is the value passed to the constructor.
690690
///
691691
/// Equivalent to the SO_DOMAIN socket option.
692692
@since(version = 0.3.0)
693-
address-family: func() -> ip-address-family;
693+
get-address-family: func() -> ip-address-family;
694694

695695
/// Equivalent to the IP_TTL & IPV6_UNICAST_HOPS socket options.
696696
///
@@ -699,7 +699,7 @@ interface types {
699699
/// # Typical errors
700700
/// - `invalid-argument`: (set) The TTL value must be 1 or higher.
701701
@since(version = 0.3.0)
702-
unicast-hop-limit: func() -> result<u8, error-code>;
702+
get-unicast-hop-limit: func() -> result<u8, error-code>;
703703
@since(version = 0.3.0)
704704
set-unicast-hop-limit: func(value: u8) -> result<_, error-code>;
705705

@@ -714,11 +714,11 @@ interface types {
714714
/// # Typical errors
715715
/// - `invalid-argument`: (set) The provided value was 0.
716716
@since(version = 0.3.0)
717-
receive-buffer-size: func() -> result<u64, error-code>;
717+
get-receive-buffer-size: func() -> result<u64, error-code>;
718718
@since(version = 0.3.0)
719719
set-receive-buffer-size: func(value: u64) -> result<_, error-code>;
720720
@since(version = 0.3.0)
721-
send-buffer-size: func() -> result<u64, error-code>;
721+
get-send-buffer-size: func() -> result<u64, error-code>;
722722
@since(version = 0.3.0)
723723
set-send-buffer-size: func(value: u64) -> result<_, error-code>;
724724
}

0 commit comments

Comments
 (0)