openclose

Documentation

Overview

Package openclose provides a synchronization primitive (similar to a semaphore)

Index

• type OpenClose
  • func (oc *OpenClose) IsCloseRequested() bool
  • func (oc *OpenClose) IsClosed() bool
  • func (oc *OpenClose) Open(fn func()) (bool, func())
  • func (oc *OpenClose) RequestClose(fn func()) bool
  • func (oc *OpenClose) RequestCloseWait(fn func()) bool

Types

type OpenClose

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

OpenClose represents a synchronization primitive (similar to a semaphore) that can be used to signal that an operation has started. All methods are safe to call from multiple goroutines.

func (*OpenClose) IsCloseRequested

func (oc *OpenClose) IsCloseRequested() bool

IsCloseRequested returns true if the OpenClose is requested to be closed.

func (*OpenClose) IsClosed

func (oc *OpenClose) IsClosed() bool

IsClosed returns true if the OpenClose is closed.

func (*OpenClose) Open

func (oc *OpenClose) Open(fn func()) (bool, func())

Open opens the OpenClose and returns a function that can be used to close it. If the OpenClose is already opened or closed, it returns false and a nil function. If fn is not nil, it will be called before the OpenClose is opened.

func (*OpenClose) RequestClose

func (oc *OpenClose) RequestClose(fn func()) bool

RequestClose requests that the OpenClose be closed and calls fn if close has not been requested. It will run fn even if the OpenClose is already closed from Open callback, but it was not requested to be closed.

func (*OpenClose) RequestCloseWait

func (oc *OpenClose) RequestCloseWait(fn func()) bool

RequestCloseWait requests that the OpenClose be closed and calls fn if close has not been requested. It will run fn even if the OpenClose is already closed from Open callback, but it was not requested to be closed. It waits until the Open callback is called and the OpenClose is closed.