lifecycle

Documentation

Overview

Package lifecycle provides a concurrency-safe close guard that tracks whether a resource has been closed and signals waiters via a channel.

Index

• Variables
• type Guard
  • func New() *Guard
  • func (g *Guard) Close() error
  • func (g *Guard) Done() <-chan struct{}
  • func (g *Guard) IsClosed() bool

Variables

var ErrAlreadyClosed = errors.New("lifecycle: already closed")

ErrAlreadyClosed is returned by Guard.Close when the guard is already closed.

Types

type Guard

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

Guard is a concurrency-safe close guard. It tracks whether Close has been called and provides a Done channel for goroutines to wait on.

func New

func New() *Guard

New creates a new open Guard.

func (*Guard) Close

func (g *Guard) Close() error

Close marks the guard as closed and closes the Done channel. Returns ErrAlreadyClosed if called more than once.

func (*Guard) Done

func (g *Guard) Done() <-chan struct{}

Done returns a channel that is closed when Guard.Close is called. Callers can use this with select to detect shutdown.

func (*Guard) IsClosed

func (g *Guard) IsClosed() bool

IsClosed reports whether the guard has been closed.