aio

package module

v0.0.0-...-5209c1f Latest Latest Go to latest Published: Nov 16, 2016 License: MPL-2.0 Imports: 8 Imported by: 2

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

Repository

github.com/rainycape/aio

Links

Open Source Insights

README ¶

Asynchronous IO for Go

Package aio implements asynchronous IO in Go (epoll/kqueue based).

    go get github.com/rainycape/aio

Documentation ¶

Rendered for

Overview ¶

Package aio implements asynchronous style IO for Go.

Index ¶

func Fd(file interface{}) (int, error)
func Pipe(flag PipeFlag) (r *os.File, w *os.File, err error)
type Event
type Flags
type Handler
type PipeFlag
type Set
- func New() (*Set, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Fd ¶

func Fd(file interface{}) (int, error)

Fd returns the underlying OS file descriptor for the given file. Currently, only *os.File is supported.

func Pipe ¶

func Pipe(flag PipeFlag) (r *os.File, w *os.File, err error)

Pipe returns a connected pair of Files; reads from r return bytes written to w. It returns the files and an error, if any. Optionally, r or w might be set to non-blocking mode using the appropriate flags. To obtain a blocking pipe just pass 0 as the flag.

Types ¶

type Event ¶

type Event struct {
	File  interface{}
	Flags Flags
	Data  interface{}
}

type Flags ¶

type Flags int

const (
	In Flags = 1 << iota
	Out
	OneShot
)

type Handler ¶

type Handler func(ev *Event)

type PipeFlag ¶

type PipeFlag int

PipeFlag might be used to specify options when creating a pipe.

const (
	// ReadNonBlock causes the read end of the pipe to be non-blocking.
	ReadNonBlock PipeFlag = 1 << iota
	// ReadNonBlock causes the write end of the pipe to be non-blocking.
	WriteNonBlock
)

type Set ¶

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

func New ¶

func New() (*Set, error)

func (*Set) Add ¶

func (s *Set) Add(file interface{}, flags Flags, data interface{}, handler Handler) error

func (*Set) Delete ¶

func (s *Set) Delete(file interface{}) error

func (*Set) Run ¶

func (s *Set) Run() error

func (*Set) Stop ¶

func (s *Set) Stop() error

func (*Set) Wait ¶

func (s *Set) Wait(duration time.Duration) ([]*Event, error)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL