service

Documentation

Overview

Package sync provides sync primitives.

Index

• type One
  • func NewOne() One

Types

type One

type One interface {
	// TryStart starts the function iff no other is running.
	TryStart(func(context.Context)) bool

	// TryStop stops the running function, if any. This method blocks until
	// the function finishes its work.
	TryStop() bool

	// IsRunning returns true iff the function is running.
	IsRunning() bool
}

One is an object that will allow to run only one function at a time.

func NewOne

func NewOne() One

NewOne creates an object which will allow to run only one function at a time.