poll

Documentation

Index

• Constants
• type Poller
  • func New() (*Poller, error)
  • func (p *Poller) AddRead(fd int) error
  • func (p *Poller) Watch(processEventFn func(fd int, eFlags uint32) error) error

Constants

const (
	// ExceptionEvents represents problematic epoll events.
	ExceptionEvents = unix.EPOLLHUP |

		unix.EPOLLRDHUP |

		unix.EPOLLERR // read end closed

	// ReadEvents represents read epoll events.
	ReadEvents = ExceptionEvents |

		unix.EPOLLIN |

		unix.EPOLLPRI //exceptional condition, visit https://man7.org/linux/man-pages/man2/poll.2.html

	// WriteEvents represents write epoll events.
	WriteEvents = ExceptionEvents |

		unix.EPOLLOUT // associated file is available for write operation

	// ReadWriteEvents represents both read and write epoll events.
	ReadWriteEvents = ReadEvents | WriteEvents
)

Types

type Poller

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

Poller is responsible for watching file descriptors for events.

func New

func New() (*Poller, error)

New returns a newly created poller.

func (*Poller) AddRead

func (p *Poller) AddRead(fd int) error

AddRead put the fs in epoll's interest list with read event on.

func (*Poller) Watch

func (p *Poller) Watch(processEventFn func(fd int, eFlags uint32) error) error

Watch monitors the epoll for events.