eventfd

package

v0.0.0-...-8940ca0 Latest Latest Go to latest Published: Mar 9, 2023 License: Apache-2.0, MIT Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package eventfd wraps Linux's eventfd(2) syscall.

This section is empty.

This section is empty.

This section is empty.

type Eventfd struct {
	// contains filtered or unexported fields
}

Eventfd represents a Linux eventfd object.

func Create() (Eventfd, error)

Create returns an initialized eventfd.

func Wrap(fd int) Eventfd

Wrap returns an initialized Eventfd using the provided fd.

func (ev Eventfd) Close() error

Close closes the eventfd, after which it should not be used.

func (ev Eventfd) Dup() (Eventfd, error)

Dup copies the eventfd, calling dup(2) on the underlying file descriptor.

func (ev Eventfd) FD() int

FD returns the underlying file descriptor. Use with care, as this breaks the Eventfd abstraction.

func (ev Eventfd) Notify() error

Notify alerts other users of the eventfd. Users can receive alerts by calling Wait or Read.

func (ev Eventfd) Read() (uint64, error)

Read blocks until eventfd is non-zero (i.e. someone calls Notify or Write) and returns the value read.

func (ev Eventfd) Wait() error

Wait blocks until eventfd is non-zero (i.e. someone calls Notify or Write).

func (ev Eventfd) Write(val uint64) error

Write writes a specific value to the eventfd.