package sock

Import Path
	github.com/tetratelabs/wazero/internal/sock (on go.dev)

Dependency Relation
	imports 4 packages, and imported by 3 packages

Involved Source Files

	    sock.go
	    sock_supported.go
Package-Level Type Names (total 5)

	/* sort by: alphabet | popularity */
	 type Config (struct)
		Config is an internal struct meant to implement
		the interface in experimental/sock/Config.

		Fields (only one)
			TCPAddresses []TCPAddress
				TCPAddresses is a slice of the configured host:port pairs.

		Methods (total 2)
			(*Config) BuildTCPListeners() (tcpListeners []*net.TCPListener, err error)
				BuildTCPListeners build listeners from the current configuration.

			(*Config) WithTCPListener(host string, port int) *Config
				WithTCPListener implements the method of the same name in experimental/sock/Config.
				
				However, to avoid cyclic dependencies, this is returning the *Config in this scope.
				The interface is implemented in experimental/sock/Config via delegation.

		As Outputs Of (at least one exported)
			func (*Config).WithTCPListener(host string, port int) *Config

	 type ConfigKey (struct)
		ConfigKey is a context.Context Value key. Its associated value should be a Config.

	 type TCPAddress (struct)
		TCPAddress is a host:port pair to pre-open.

		Fields (total 2)
			Host string
				Host is the host name for this listener.

			Port int
				Port is the port number for this listener.

		Methods (only one)
			( TCPAddress) String() string
		Implements (at least 2)
			 TCPAddress : expvar.Var
			 TCPAddress : fmt.Stringer

	 type TCPConn (interface)
		TCPConn is a pseudo-file representing a TCP connection.

		Methods (total 19)
			( TCPConn) Close() sys.Errno
				Close closes the underlying file.
				
				A zero Errno is returned if unimplemented or success.
				
				# Notes
				
				  - This is like syscall.Close and `close` in POSIX. See
				    https://pubs.opengroup.org/onlinepubs/9699919799/functions/close.html

			( TCPConn) Datasync() sys.Errno
				Datasync synchronizes the data of a file.
				
				# Errors
				
				A zero Errno is success. The below are expected otherwise:
				  - EBADF: the file or directory was closed.
				
				# Notes
				
				  - This is like syscall.Fdatasync and `fdatasync` in POSIX. See
				    https://pubs.opengroup.org/onlinepubs/9699919799/functions/fdatasync.html
				  - This returns with no error instead of ENOSYS when
				    unimplemented. This prevents fake filesystems from erring.
				  - As this is commonly missing, some implementations dispatch to Sync.

			( TCPConn) Dev() (uint64, sys.Errno)
				Dev returns the device ID (Stat_t.Dev) of this file, zero if unknown or
				an error retrieving it.
				
				# Errors
				
				Possible errors are those from Stat, except ENOSYS should not
				be returned. Zero should be returned if there is no implementation.
				
				# Notes
				
				  - Implementations should cache this result.
				  - This combined with Ino can implement os.SameFile.

			( TCPConn) Ino() (sys.Inode, sys.Errno)
				Ino returns the serial number (Stat_t.Ino) of this file, zero if unknown
				or an error retrieving it.
				
				# Errors
				
				Possible errors are those from Stat, except ENOSYS should not
				be returned. Zero should be returned if there is no implementation.
				
				# Notes
				
				  - Implementations should cache this result.
				  - This combined with Dev can implement os.SameFile.

			( TCPConn) IsAppend() bool
				IsAppend returns true if the file was opened with O_APPEND, or
				SetAppend was successfully enabled on this file.
				
				# Notes
				
				  - This might not match the underlying state of the file descriptor if
				    the file was not opened via OpenFile.

			( TCPConn) IsDir() (bool, sys.Errno)
				IsDir returns true if this file is a directory or an error there was an
				error retrieving this information.
				
				# Errors
				
				Possible errors are those from Stat, except ENOSYS should not
				be returned. false should be returned if there is no implementation.
				
				# Notes
				
				  - Implementations should cache this result.

			( TCPConn) Pread(buf []byte, off int64) (n int, errno sys.Errno)
				Pread attempts to read all bytes in the file into `p`, starting at the
				offset `off`, and returns the count read even on error.
				
				# Errors
				
				A zero Errno is success. The below are expected otherwise:
				  - ENOSYS: the implementation does not support this function.
				  - EBADF: the file or directory was closed or not readable.
				  - EINVAL: the offset was negative.
				  - EISDIR: the file was a directory.
				
				# Notes
				
				  - This is like io.ReaderAt and `pread` in POSIX, preferring semantics
				    of io.ReaderAt. See https://pubs.opengroup.org/onlinepubs/9699919799/functions/pread.html
				  - Unlike io.ReaderAt, there is no io.EOF returned on end-of-file. To
				    read the file completely, the caller must repeat until `n` is zero.

			( TCPConn) Pwrite(buf []byte, off int64) (n int, errno sys.Errno)
				Pwrite attempts to write all bytes in `p` to the file at the given
				offset `off`, and returns the count written even on error.
				
				# Errors
				
				A zero Errno is success. The below are expected otherwise:
				  - ENOSYS: the implementation does not support this function.
				  - EBADF: the file or directory was closed or not writeable.
				  - EINVAL: the offset was negative.
				  - EISDIR: the file was a directory.
				
				# Notes
				
				  - This is like io.WriterAt and `pwrite` in POSIX, preferring semantics
				    of io.WriterAt. See https://pubs.opengroup.org/onlinepubs/9699919799/functions/pwrite.html

			( TCPConn) Read(buf []byte) (n int, errno sys.Errno)
				Read attempts to read all bytes in the file into `buf`, and returns the
				count read even on error.
				
				# Errors
				
				A zero Errno is success. The below are expected otherwise:
				  - ENOSYS: the implementation does not support this function.
				  - EBADF: the file or directory was closed or not readable.
				  - EISDIR: the file was a directory.
				
				# Notes
				
				  - This is like io.Reader and `read` in POSIX, preferring semantics of
				    io.Reader. See https://pubs.opengroup.org/onlinepubs/9699919799/functions/read.html
				  - Unlike io.Reader, there is no io.EOF returned on end-of-file. To
				    read the file completely, the caller must repeat until `n` is zero.

			( TCPConn) Readdir(n int) (dirents []sys.Dirent, errno sys.Errno)
				Readdir reads the contents of the directory associated with file and
				returns a slice of up to n Dirent values in an arbitrary order. This is
				a stateful function, so subsequent calls return any next values.
				
				If n > 0, Readdir returns at most n entries or an error.
				If n <= 0, Readdir returns all remaining entries or an error.
				
				# Errors
				
				A zero Errno is success. The below are expected otherwise:
				  - ENOSYS: the implementation does not support this function.
				  - EBADF: the file was closed or not a directory.
				  - ENOENT: the directory could not be read (e.g. deleted).
				
				# Notes
				
				  - This is like `Readdir` on os.File, but unlike `readdir` in POSIX.
				    See https://pubs.opengroup.org/onlinepubs/9699919799/functions/readdir.html
				  - Unlike os.File, there is no io.EOF returned on end-of-directory. To
				    read the directory completely, the caller must repeat until the
				    count read (`len(dirents)`) is less than `n`.
				  - See /RATIONALE.md for design notes.

			( TCPConn) Recvfrom(p []byte, flags int) (n int, errno sys.Errno)
				Recvfrom only supports the flag sysfs.MSG_PEEK
				TODO: document this like sys.File with known sys.Errno

			( TCPConn) Seek(offset int64, whence int) (newOffset int64, errno sys.Errno)
				Seek attempts to set the next offset for Read or Write and returns the
				resulting absolute offset or an error.
				
				# Parameters
				
				The `offset` parameters is interpreted in terms of `whence`:
				  - io.SeekStart: relative to the start of the file, e.g. offset=0 sets
				    the next Read or Write to the beginning of the file.
				  - io.SeekCurrent: relative to the current offset, e.g. offset=16 sets
				    the next Read or Write 16 bytes past the prior.
				  - io.SeekEnd: relative to the end of the file, e.g. offset=-1 sets the
				    next Read or Write to the last byte in the file.
				
				# Behavior when a directory
				
				The only supported use case for a directory is seeking to `offset` zero
				(`whence` = io.SeekStart). This should have the same behavior as
				os.File, which resets any internal state used by Readdir.
				
				# Errors
				
				A zero Errno is success. The below are expected otherwise:
				  - ENOSYS: the implementation does not support this function.
				  - EBADF: the file or directory was closed or not readable.
				  - EINVAL: the offset was negative.
				
				# Notes
				
				  - This is like io.Seeker and `fseek` in POSIX, preferring semantics
				    of io.Seeker. See https://pubs.opengroup.org/onlinepubs/9699919799/functions/fseek.html

			( TCPConn) SetAppend(enable bool) sys.Errno
				SetAppend toggles the append mode (O_APPEND) of this file.
				
				# Errors
				
				A zero Errno is success. The below are expected otherwise:
				  - ENOSYS: the implementation does not support this function.
				  - EBADF: the file or directory was closed.
				
				# Notes
				
				  - There is no `O_APPEND` for `fcntl` in POSIX, so implementations may
				    have to re-open the underlying file to apply this. See
				    https://pubs.opengroup.org/onlinepubs/9699919799/functions/open.html

			( TCPConn) Shutdown(how int) sys.Errno
				TODO: document this like sys.File with known sys.Errno

			( TCPConn) Stat() (sys.Stat_t, sys.Errno)
				Stat is similar to syscall.Fstat.
				
				# Errors
				
				A zero Errno is success. The below are expected otherwise:
				  - ENOSYS: the implementation does not support this function.
				  - EBADF: the file or directory was closed.
				
				# Notes
				
				  - This is like syscall.Fstat and `fstatat` with `AT_FDCWD` in POSIX.
				    See https://pubs.opengroup.org/onlinepubs/9699919799/functions/stat.html
				  - A fs.FileInfo backed implementation sets atim, mtim and ctim to the
				    same value.
				  - Windows allows you to stat a closed directory.

			( TCPConn) Sync() sys.Errno
				Sync synchronizes changes to the file.
				
				# Errors
				
				A zero Errno is success. The below are expected otherwise:
				  - EBADF: the file or directory was closed.
				
				# Notes
				
				  - This is like syscall.Fsync and `fsync` in POSIX. See
				    https://pubs.opengroup.org/onlinepubs/9699919799/functions/fsync.html
				  - This returns with no error instead of ENOSYS when
				    unimplemented. This prevents fake filesystems from erring.
				  - Windows does not error when calling Sync on a closed file.

			( TCPConn) Truncate(size int64) sys.Errno
				Truncate truncates a file to a specified length.
				
				# Errors
				
				A zero Errno is success. The below are expected otherwise:
				  - ENOSYS: the implementation does not support this function.
				  - EBADF: the file or directory was closed.
				  - EINVAL: the `size` is negative.
				  - EISDIR: the file was a directory.
				
				# Notes
				
				  - This is like syscall.Ftruncate and `ftruncate` in POSIX. See
				    https://pubs.opengroup.org/onlinepubs/9699919799/functions/ftruncate.html
				  - Windows does not error when calling Truncate on a closed file.

			( TCPConn) Utimens(atim, mtim int64) sys.Errno
				Utimens set file access and modification times of this file, at
				nanosecond precision.
				
				# Parameters
				
				The `atim` and `mtim` parameters refer to access and modification time
				stamps as defined in sys.Stat_t. To retain one or the other, substitute
				it with the pseudo-timestamp UTIME_OMIT.
				
				# Errors
				
				A zero Errno is success. The below are expected otherwise:
				  - ENOSYS: the implementation does not support this function.
				  - EBADF: the file or directory was closed.
				
				# Notes
				
				  - This is like syscall.UtimesNano and `futimens` in POSIX. See
				    https://pubs.opengroup.org/onlinepubs/9699919799/functions/futimens.html
				  - Windows requires files to be open with O_RDWR, which means you
				    cannot use this to update timestamps on a directory (EPERM).

			( TCPConn) Write(buf []byte) (n int, errno sys.Errno)
				Write attempts to write all bytes in `p` to the file, and returns the
				count written even on error.
				
				# Errors
				
				A zero Errno is success. The below are expected otherwise:
				  - ENOSYS: the implementation does not support this function.
				  - EBADF: the file was closed, not writeable, or a directory.
				
				# Notes
				
				  - This is like io.Writer and `write` in POSIX, preferring semantics of
				    io.Writer. See https://pubs.opengroup.org/onlinepubs/9699919799/functions/write.html

		Implements (at least one exported)
			 TCPConn : github.com/tetratelabs/wazero/experimental/sys.File
		As Outputs Of (at least one exported)
			func TCPSock.Accept() (TCPConn, sys.Errno)

	 type TCPSock (interface)
		TCPSock is a pseudo-file representing a TCP socket.

		Methods (total 18)
			( TCPSock) Accept() (TCPConn, sys.Errno)
			( TCPSock) Close() sys.Errno
				Close closes the underlying file.
				
				A zero Errno is returned if unimplemented or success.
				
				# Notes
				
				  - This is like syscall.Close and `close` in POSIX. See
				    https://pubs.opengroup.org/onlinepubs/9699919799/functions/close.html

			( TCPSock) Datasync() sys.Errno
				Datasync synchronizes the data of a file.
				
				# Errors
				
				A zero Errno is success. The below are expected otherwise:
				  - EBADF: the file or directory was closed.
				
				# Notes
				
				  - This is like syscall.Fdatasync and `fdatasync` in POSIX. See
				    https://pubs.opengroup.org/onlinepubs/9699919799/functions/fdatasync.html
				  - This returns with no error instead of ENOSYS when
				    unimplemented. This prevents fake filesystems from erring.
				  - As this is commonly missing, some implementations dispatch to Sync.

			( TCPSock) Dev() (uint64, sys.Errno)
				Dev returns the device ID (Stat_t.Dev) of this file, zero if unknown or
				an error retrieving it.
				
				# Errors
				
				Possible errors are those from Stat, except ENOSYS should not
				be returned. Zero should be returned if there is no implementation.
				
				# Notes
				
				  - Implementations should cache this result.
				  - This combined with Ino can implement os.SameFile.

			( TCPSock) Ino() (sys.Inode, sys.Errno)
				Ino returns the serial number (Stat_t.Ino) of this file, zero if unknown
				or an error retrieving it.
				
				# Errors
				
				Possible errors are those from Stat, except ENOSYS should not
				be returned. Zero should be returned if there is no implementation.
				
				# Notes
				
				  - Implementations should cache this result.
				  - This combined with Dev can implement os.SameFile.

			( TCPSock) IsAppend() bool
				IsAppend returns true if the file was opened with O_APPEND, or
				SetAppend was successfully enabled on this file.
				
				# Notes
				
				  - This might not match the underlying state of the file descriptor if
				    the file was not opened via OpenFile.

			( TCPSock) IsDir() (bool, sys.Errno)
				IsDir returns true if this file is a directory or an error there was an
				error retrieving this information.
				
				# Errors
				
				Possible errors are those from Stat, except ENOSYS should not
				be returned. false should be returned if there is no implementation.
				
				# Notes
				
				  - Implementations should cache this result.

			( TCPSock) Pread(buf []byte, off int64) (n int, errno sys.Errno)
				Pread attempts to read all bytes in the file into `p`, starting at the
				offset `off`, and returns the count read even on error.
				
				# Errors
				
				A zero Errno is success. The below are expected otherwise:
				  - ENOSYS: the implementation does not support this function.
				  - EBADF: the file or directory was closed or not readable.
				  - EINVAL: the offset was negative.
				  - EISDIR: the file was a directory.
				
				# Notes
				
				  - This is like io.ReaderAt and `pread` in POSIX, preferring semantics
				    of io.ReaderAt. See https://pubs.opengroup.org/onlinepubs/9699919799/functions/pread.html
				  - Unlike io.ReaderAt, there is no io.EOF returned on end-of-file. To
				    read the file completely, the caller must repeat until `n` is zero.

			( TCPSock) Pwrite(buf []byte, off int64) (n int, errno sys.Errno)
				Pwrite attempts to write all bytes in `p` to the file at the given
				offset `off`, and returns the count written even on error.
				
				# Errors
				
				A zero Errno is success. The below are expected otherwise:
				  - ENOSYS: the implementation does not support this function.
				  - EBADF: the file or directory was closed or not writeable.
				  - EINVAL: the offset was negative.
				  - EISDIR: the file was a directory.
				
				# Notes
				
				  - This is like io.WriterAt and `pwrite` in POSIX, preferring semantics
				    of io.WriterAt. See https://pubs.opengroup.org/onlinepubs/9699919799/functions/pwrite.html

			( TCPSock) Read(buf []byte) (n int, errno sys.Errno)
				Read attempts to read all bytes in the file into `buf`, and returns the
				count read even on error.
				
				# Errors
				
				A zero Errno is success. The below are expected otherwise:
				  - ENOSYS: the implementation does not support this function.
				  - EBADF: the file or directory was closed or not readable.
				  - EISDIR: the file was a directory.
				
				# Notes
				
				  - This is like io.Reader and `read` in POSIX, preferring semantics of
				    io.Reader. See https://pubs.opengroup.org/onlinepubs/9699919799/functions/read.html
				  - Unlike io.Reader, there is no io.EOF returned on end-of-file. To
				    read the file completely, the caller must repeat until `n` is zero.

			( TCPSock) Readdir(n int) (dirents []sys.Dirent, errno sys.Errno)
				Readdir reads the contents of the directory associated with file and
				returns a slice of up to n Dirent values in an arbitrary order. This is
				a stateful function, so subsequent calls return any next values.
				
				If n > 0, Readdir returns at most n entries or an error.
				If n <= 0, Readdir returns all remaining entries or an error.
				
				# Errors
				
				A zero Errno is success. The below are expected otherwise:
				  - ENOSYS: the implementation does not support this function.
				  - EBADF: the file was closed or not a directory.
				  - ENOENT: the directory could not be read (e.g. deleted).
				
				# Notes
				
				  - This is like `Readdir` on os.File, but unlike `readdir` in POSIX.
				    See https://pubs.opengroup.org/onlinepubs/9699919799/functions/readdir.html
				  - Unlike os.File, there is no io.EOF returned on end-of-directory. To
				    read the directory completely, the caller must repeat until the
				    count read (`len(dirents)`) is less than `n`.
				  - See /RATIONALE.md for design notes.

			( TCPSock) Seek(offset int64, whence int) (newOffset int64, errno sys.Errno)
				Seek attempts to set the next offset for Read or Write and returns the
				resulting absolute offset or an error.
				
				# Parameters
				
				The `offset` parameters is interpreted in terms of `whence`:
				  - io.SeekStart: relative to the start of the file, e.g. offset=0 sets
				    the next Read or Write to the beginning of the file.
				  - io.SeekCurrent: relative to the current offset, e.g. offset=16 sets
				    the next Read or Write 16 bytes past the prior.
				  - io.SeekEnd: relative to the end of the file, e.g. offset=-1 sets the
				    next Read or Write to the last byte in the file.
				
				# Behavior when a directory
				
				The only supported use case for a directory is seeking to `offset` zero
				(`whence` = io.SeekStart). This should have the same behavior as
				os.File, which resets any internal state used by Readdir.
				
				# Errors
				
				A zero Errno is success. The below are expected otherwise:
				  - ENOSYS: the implementation does not support this function.
				  - EBADF: the file or directory was closed or not readable.
				  - EINVAL: the offset was negative.
				
				# Notes
				
				  - This is like io.Seeker and `fseek` in POSIX, preferring semantics
				    of io.Seeker. See https://pubs.opengroup.org/onlinepubs/9699919799/functions/fseek.html

			( TCPSock) SetAppend(enable bool) sys.Errno
				SetAppend toggles the append mode (O_APPEND) of this file.
				
				# Errors
				
				A zero Errno is success. The below are expected otherwise:
				  - ENOSYS: the implementation does not support this function.
				  - EBADF: the file or directory was closed.
				
				# Notes
				
				  - There is no `O_APPEND` for `fcntl` in POSIX, so implementations may
				    have to re-open the underlying file to apply this. See
				    https://pubs.opengroup.org/onlinepubs/9699919799/functions/open.html

			( TCPSock) Stat() (sys.Stat_t, sys.Errno)
				Stat is similar to syscall.Fstat.
				
				# Errors
				
				A zero Errno is success. The below are expected otherwise:
				  - ENOSYS: the implementation does not support this function.
				  - EBADF: the file or directory was closed.
				
				# Notes
				
				  - This is like syscall.Fstat and `fstatat` with `AT_FDCWD` in POSIX.
				    See https://pubs.opengroup.org/onlinepubs/9699919799/functions/stat.html
				  - A fs.FileInfo backed implementation sets atim, mtim and ctim to the
				    same value.
				  - Windows allows you to stat a closed directory.

			( TCPSock) Sync() sys.Errno
				Sync synchronizes changes to the file.
				
				# Errors
				
				A zero Errno is success. The below are expected otherwise:
				  - EBADF: the file or directory was closed.
				
				# Notes
				
				  - This is like syscall.Fsync and `fsync` in POSIX. See
				    https://pubs.opengroup.org/onlinepubs/9699919799/functions/fsync.html
				  - This returns with no error instead of ENOSYS when
				    unimplemented. This prevents fake filesystems from erring.
				  - Windows does not error when calling Sync on a closed file.

			( TCPSock) Truncate(size int64) sys.Errno
				Truncate truncates a file to a specified length.
				
				# Errors
				
				A zero Errno is success. The below are expected otherwise:
				  - ENOSYS: the implementation does not support this function.
				  - EBADF: the file or directory was closed.
				  - EINVAL: the `size` is negative.
				  - EISDIR: the file was a directory.
				
				# Notes
				
				  - This is like syscall.Ftruncate and `ftruncate` in POSIX. See
				    https://pubs.opengroup.org/onlinepubs/9699919799/functions/ftruncate.html
				  - Windows does not error when calling Truncate on a closed file.

			( TCPSock) Utimens(atim, mtim int64) sys.Errno
				Utimens set file access and modification times of this file, at
				nanosecond precision.
				
				# Parameters
				
				The `atim` and `mtim` parameters refer to access and modification time
				stamps as defined in sys.Stat_t. To retain one or the other, substitute
				it with the pseudo-timestamp UTIME_OMIT.
				
				# Errors
				
				A zero Errno is success. The below are expected otherwise:
				  - ENOSYS: the implementation does not support this function.
				  - EBADF: the file or directory was closed.
				
				# Notes
				
				  - This is like syscall.UtimesNano and `futimens` in POSIX. See
				    https://pubs.opengroup.org/onlinepubs/9699919799/functions/futimens.html
				  - Windows requires files to be open with O_RDWR, which means you
				    cannot use this to update timestamps on a directory (EPERM).

			( TCPSock) Write(buf []byte) (n int, errno sys.Errno)
				Write attempts to write all bytes in `p` to the file, and returns the
				count written even on error.
				
				# Errors
				
				A zero Errno is success. The below are expected otherwise:
				  - ENOSYS: the implementation does not support this function.
				  - EBADF: the file was closed, not writeable, or a directory.
				
				# Notes
				
				  - This is like io.Writer and `write` in POSIX, preferring semantics of
				    io.Writer. See https://pubs.opengroup.org/onlinepubs/9699919799/functions/write.html

		Implements (at least one exported)
			 TCPSock : github.com/tetratelabs/wazero/experimental/sys.File
		As Outputs Of (at least one exported)
			func github.com/tetratelabs/wazero/internal/sysfs.NewTCPListenerFile(tl *net.TCPListener) TCPSock


Package-Level Constants (total 3)

	const SHUT_RD = 0
	const SHUT_RDWR = 2
	const SHUT_WR = 1

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.