Files
golib/semaphore/interface.go
Nicolas JUHEL e28c21b26c Package Semaphore :
+ Add interface SemBar to expose same interface between ProgressBar & Semaphore
  + Add empty function for compatibility with SemBar
Package Progress :
  + Refactor sem function to depend of Sem interface
  + Replace interface function into interface and use Sem & SemBar interface as dependencies
Update following test
2022-08-03 13:09:23 +02:00

87 lines
2.1 KiB
Go

/*
* MIT License
*
* Copyright (c) 2019 Nicolas JUHEL
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
*/
package semaphore
import (
"context"
"runtime"
"sync/atomic"
liberr "github.com/nabbar/golib/errors"
"golang.org/x/sync/semaphore"
)
type SemBar interface {
Sem
Current() int64
Completed() bool
Reset(total, current int64)
ResetDefined(current int64)
Done()
Increment(n int)
Increment64(n int64)
}
type FuncContext func() context.Context
type Sem interface {
NewWorker() liberr.Error
NewWorkerTry() bool
DeferWorker()
DeferMain()
WaitAll() liberr.Error
}
func GetMaxSimultaneous() int {
return runtime.GOMAXPROCS(0)
}
/*
Deprecated: func without context will be deprecated
*/
func NewSemaphore(maxSimultaneous int) Sem {
return NewSemaphoreWithContext(context.Background(), maxSimultaneous)
}
func NewSemaphoreWithContext(ctx context.Context, maxSimultaneous int) Sem {
if maxSimultaneous < 1 {
maxSimultaneous = GetMaxSimultaneous()
}
x, c := NewContext(ctx, 0, EmptyTime())
return &sem{
d: new(atomic.Value),
i: int64(maxSimultaneous),
s: semaphore.NewWeighted(int64(maxSimultaneous)),
x: x,
c: c,
}
}