package poll

import "internal/poll"

Package poll supports non-blocking I/O on file descriptors with polling. This supports I/O operations that block only a goroutine, not a thread. This is used by the net and os packages. It uses a poller built into the runtime, with support from the runtime scheduler.

Index

Variables 

var AcceptFunc func(syscall.Handle, syscall.Handle, *byte, uint32, uint32, uint32, *uint32, *syscall.Overlapped) error = syscall.AcceptEx

AcceptFunc is used to hook the accept call. 

var CloseFunc func(syscall.Handle) error = syscall.Closesocket

CloseFunc is used to hook the close call. 

var ConnectExFunc func(syscall.Handle, syscall.Sockaddr, *byte, uint32, *uint32, *syscall.Overlapped) error = syscall.ConnectEx

ConnectExFunc is used to hook the ConnectEx call. 

var ErrDeadlineExceeded error = &DeadlineExceededError{}

ErrDeadlineExceeded is returned for an expired deadline. This is exported by the os package as os.ErrDeadlineExceeded. 

var ErrFileClosing = errors.New("use of closed file")

ErrFileClosing is returned when a file descriptor is used after it has been closed. 

var ErrNetClosing = errNetClosing{}

ErrNetClosing is returned when a network descriptor is used after it has been closed. 

var ErrNoDeadline = errors.New("file type does not support deadline")

ErrNoDeadline is returned when a request is made to set a deadline on a file type that does not use the poller. 

var ErrNotPollable = errors.New("not pollable")

ErrNotPollable is returned when the file or socket is not suitable for event notification. 

var ReadConsole = syscall.ReadConsole // changed for testing

var TestHookDidWritev = func(wrote int) {}

TestHookDidWritev is a hook for testing writev.

Functions

func IsPollDescriptor 

func IsPollDescriptor(fd uintptr) bool

IsPollDescriptor reports whether fd is the descriptor being used by the poller. This is only used for testing.

func SendFile 

func SendFile(fd *FD, src syscall.Handle, n int64) (written int64, err error)

SendFile wraps the TransmitFile call.

Types

type DeadlineExceededError 

type DeadlineExceededError struct{}

DeadlineExceededError is returned for an expired deadline.

func (*DeadlineExceededError) Error 

func (e *DeadlineExceededError) Error() string

Implement the net.Error interface. The string is "i/o timeout" because that is what was returned by earlier Go versions. Changing it may break programs that match on error strings.

func (*DeadlineExceededError) Temporary 

func (e *DeadlineExceededError) Temporary() bool

func (*DeadlineExceededError) Timeout 

func (e *DeadlineExceededError) Timeout() bool

type FD 

type FD struct {

	// System file descriptor. Immutable until Close.
	Sysfd syscall.Handle

	// Whether this is a streaming descriptor, as opposed to a
	// packet-based descriptor like a UDP socket.
	IsStream bool

	// Whether a zero byte read indicates EOF. This is false for a
	// message based socket connection.
	ZeroReadIsEOF bool
	// contains filtered or unexported fields
}

FD is a file descriptor. The net and os packages embed this type in a larger type representing a network connection or OS file.

func (*FD) Accept 

func (fd *FD) Accept(sysSocket func() (syscall.Handle, error)) (syscall.Handle, []syscall.RawSockaddrAny, uint32, string, error)

Accept handles accepting a socket. The sysSocket parameter is used to allocate the net socket.

func (*FD) Close 

func (fd *FD) Close() error

Close closes the FD. The underlying file descriptor is closed by the destroy method when there are no remaining references.

func (*FD) ConnectEx 

func (fd *FD) ConnectEx(ra syscall.Sockaddr) error

Call ConnectEx. This doesn't need any locking, since it is only called when the descriptor is first created. This is here rather than in the net package so that it can use fd.wop.

func (*FD) Fchdir 

func (fd *FD) Fchdir() error

Fchdir wraps syscall.Fchdir.

func (*FD) Fchmod 

func (fd *FD) Fchmod(mode uint32) error

Fchmod updates syscall.ByHandleFileInformation.Fileattributes when needed.

func (*FD) Fchown 

func (fd *FD) Fchown(uid, gid int) error

Fchown wraps syscall.Fchown.

func (*FD) Fsync 

func (fd *FD) Fsync() error

Fsync wraps syscall.Fsync.

func (*FD) Ftruncate 

func (fd *FD) Ftruncate(size int64) error

Ftruncate wraps syscall.Ftruncate.

func (*FD) GetFileInformationByHandle 

func (fd *FD) GetFileInformationByHandle(data *syscall.ByHandleFileInformation) error

GetFileInformationByHandle wraps GetFileInformationByHandle.

func (*FD) GetFileType 

func (fd *FD) GetFileType() (uint32, error)

GetFileType wraps syscall.GetFileType.

func (*FD) GetsockoptInt 

func (fd *FD) GetsockoptInt(level, name int) (int, error)

GetsockoptInt wraps the getsockopt network call with an int argument.

func (*FD) Init 

func (fd *FD) Init(net string, pollable bool) (string, error)

Init initializes the FD. The Sysfd field should already be set. This can be called multiple times on a single FD. The net argument is a network name from the net package (e.g., "tcp"), or "file" or "console" or "dir". Set pollable to true if fd should be managed by runtime netpoll.

func (*FD) Pread 

func (fd *FD) Pread(b []byte, off int64) (int, error)

Pread emulates the Unix pread system call.

func (*FD) Pwrite 

func (fd *FD) Pwrite(buf []byte, off int64) (int, error)

Pwrite emulates the Unix pwrite system call.

func (*FD) RawControl 

func (fd *FD) RawControl(f func(uintptr)) error

RawControl invokes the user-defined function f for a non-IO operation.

func (*FD) RawRead 

func (fd *FD) RawRead(f func(uintptr) bool) error

RawRead invokes the user-defined function f for a read operation.

func (*FD) RawWrite 

func (fd *FD) RawWrite(f func(uintptr) bool) error

RawWrite invokes the user-defined function f for a write operation.

func (*FD) Read 

func (fd *FD) Read(buf []byte) (int, error)

Read implements io.Reader.

func (*FD) ReadFrom 

func (fd *FD) ReadFrom(buf []byte) (int, syscall.Sockaddr, error)

ReadFrom wraps the recvfrom network call.

func (*FD) ReadFromInet4 

func (fd *FD) ReadFromInet4(buf []byte, sa4 *syscall.SockaddrInet4) (int, error)

ReadFromInet4 wraps the recvfrom network call for IPv4.

func (*FD) ReadFromInet6 

func (fd *FD) ReadFromInet6(buf []byte, sa6 *syscall.SockaddrInet6) (int, error)

ReadFromInet6 wraps the recvfrom network call for IPv6.

func (*FD) ReadMsg 

func (fd *FD) ReadMsg(p []byte, oob []byte, flags int) (int, int, int, syscall.Sockaddr, error)

ReadMsg wraps the WSARecvMsg network call.

func (*FD) ReadMsgInet4 

func (fd *FD) ReadMsgInet4(p []byte, oob []byte, flags int, sa4 *syscall.SockaddrInet4) (int, int, int, error)

ReadMsgInet4 is ReadMsg, but specialized to return a syscall.SockaddrInet4.

func (*FD) ReadMsgInet6 

func (fd *FD) ReadMsgInet6(p []byte, oob []byte, flags int, sa6 *syscall.SockaddrInet6) (int, int, int, error)

ReadMsgInet6 is ReadMsg, but specialized to return a syscall.SockaddrInet6.

func (*FD) Seek 

func (fd *FD) Seek(offset int64, whence int) (int64, error)

Seek wraps syscall.Seek.

func (*FD) SetDeadline 

func (fd *FD) SetDeadline(t time.Time) error

SetDeadline sets the read and write deadlines associated with fd.

func (*FD) SetReadDeadline 

func (fd *FD) SetReadDeadline(t time.Time) error

SetReadDeadline sets the read deadline associated with fd.

func (*FD) SetWriteDeadline 

func (fd *FD) SetWriteDeadline(t time.Time) error

SetWriteDeadline sets the write deadline associated with fd.

func (*FD) SetsockoptIPMreq 

func (fd *FD) SetsockoptIPMreq(level, name int, mreq *syscall.IPMreq) error

SetsockoptIPMreq wraps the setsockopt network call with an IPMreq argument.

func (*FD) SetsockoptIPv6Mreq 

func (fd *FD) SetsockoptIPv6Mreq(level, name int, mreq *syscall.IPv6Mreq) error

SetsockoptIPv6Mreq wraps the setsockopt network call with an IPv6Mreq argument.

func (*FD) SetsockoptInet4Addr 

func (fd *FD) SetsockoptInet4Addr(level, name int, arg [4]byte) error

SetsockoptInet4Addr wraps the setsockopt network call with an IPv4 address.

func (*FD) SetsockoptInt 

func (fd *FD) SetsockoptInt(level, name, arg int) error

SetsockoptInt wraps the setsockopt network call with an int argument.

func (*FD) SetsockoptLinger 

func (fd *FD) SetsockoptLinger(level, name int, l *syscall.Linger) error

SetsockoptLinger wraps the setsockopt network call with a Linger argument.

func (*FD) Shutdown 

func (fd *FD) Shutdown(how int) error

Shutdown wraps syscall.Shutdown.

func (*FD) WSAIoctl 

func (fd *FD) WSAIoctl(iocc uint32, inbuf *byte, cbif uint32, outbuf *byte, cbob uint32, cbbr *uint32, overlapped *syscall.Overlapped, completionRoutine uintptr) error

WSAIoctl wraps the WSAIoctl network call.

func (*FD) Write 

func (fd *FD) Write(buf []byte) (int, error)

Write implements io.Writer.

func (*FD) WriteMsg 

func (fd *FD) WriteMsg(p []byte, oob []byte, sa syscall.Sockaddr) (int, int, error)

WriteMsg wraps the WSASendMsg network call.

func (*FD) WriteMsgInet4 

func (fd *FD) WriteMsgInet4(p []byte, oob []byte, sa *syscall.SockaddrInet4) (int, int, error)

WriteMsgInet4 is WriteMsg specialized for syscall.SockaddrInet4.

func (*FD) WriteMsgInet6 

func (fd *FD) WriteMsgInet6(p []byte, oob []byte, sa *syscall.SockaddrInet6) (int, int, error)

WriteMsgInet6 is WriteMsg specialized for syscall.SockaddrInet6.

func (*FD) WriteTo 

func (fd *FD) WriteTo(buf []byte, sa syscall.Sockaddr) (int, error)

WriteTo wraps the sendto network call.

func (*FD) WriteToInet4 

func (fd *FD) WriteToInet4(buf []byte, sa4 *syscall.SockaddrInet4) (int, error)

WriteToInet4 is WriteTo, specialized for syscall.SockaddrInet4.

func (*FD) WriteToInet6 

func (fd *FD) WriteToInet6(buf []byte, sa6 *syscall.SockaddrInet6) (int, error)

WriteToInet6 is WriteTo, specialized for syscall.SockaddrInet6.

func (*FD) Writev 

func (fd *FD) Writev(buf *[][]byte) (int64, error)

Writev emulates the Unix writev system call.

type String 

type String string

String is an internal string definition for methods/functions that is not intended for use outside the standard libraries.

Other packages in std that import internal/poll and have some exported APIs (now we've got some in net.rawConn) which are only used internally and are not intended to be used outside the standard libraries, Therefore, we make those APIs use internal types like poll.FD or poll.String in their function signatures to disable the usability of these APIs from external codebase.

Source Files

errno_windows.go fd.go fd_fsync_windows.go fd_mutex.go fd_poll_runtime.go fd_posix.go fd_windows.go hook_windows.go sendfile_windows.go sockopt.go sockopt_windows.go sockoptip.go

Version
v1.22.10
Published
Nov 27, 2024
Platform
windows/amd64
Imports
11 packages
Last checked
2 minutes ago –

Tools for package owners.