layout: home
keysemaphore - Keyed Semaphores 
Quick Start
To use keysemaphore in an existing SBT project with Scala 2.12, 2.13, or 3.0, add the following dependencies to your
build.sbt depending on your needs:
libraryDependencies ++= Seq(
"io.chrisdavenport" %% "keysemaphore" % "<version>"
)
Example
Quick Imports
import cats.effect._
import io.chrisdavenport.keysemaphore.KeySemaphore
import cats.effect.unsafe.implicits.global
Then we build some operations
// Second Action Can't Get Permit
val action1 = {
for {
sem <- KeySemaphore.of[IO, Unit]{_ => 1L}
first <- sem(()).tryAcquire
second <- sem(()).tryAcquire
} yield (first, second)
}
// action1: IO[(Boolean, Boolean)] = FlatMap(
// ioe = Map(
// ioe = Delay(
// thunk = cats.effect.IO$$$Lambda$10894/0x0000000102ed7440@76415d8,
// event = cats.effect.tracing.TracingEvent$StackTrace
// ),
// f = io.chrisdavenport.keysemaphore.KeySemaphore$$$Lambda$10895/0x0000000102ed6040@5f6563a,
// event = cats.effect.tracing.TracingEvent$StackTrace
// ),
// f = <function1>,
// event = cats.effect.tracing.TracingEvent$StackTrace
// )
action1.unsafeRunSync()
// res0: (Boolean, Boolean) = (true, false)
// Not Affected By Other Keys
val action2 = {
for {
sem <- KeySemaphore.of[IO, Int]{(_: Int) => 1L}
first <- sem(1).tryAcquire
second <- sem(2).tryAcquire
third <- sem(1).tryAcquire
} yield (first, second, third)
}
// action2: IO[(Boolean, Boolean, Boolean)] = FlatMap(
// ioe = Map(
// ioe = Delay(
// thunk = cats.effect.IO$$$Lambda$10894/0x0000000102ed7440@1d3ad32c,
// event = cats.effect.tracing.TracingEvent$StackTrace
// ),
// f = io.chrisdavenport.keysemaphore.KeySemaphore$$$Lambda$10895/0x0000000102ed6040@76ac2285,
// event = cats.effect.tracing.TracingEvent$StackTrace
// ),
// f = <function1>,
// event = cats.effect.tracing.TracingEvent$StackTrace
// )
action2.unsafeRunSync()
// res1: (Boolean, Boolean, Boolean) = (true, true, false)
// Releases Based on Keys
// This is space safe, so when the semaphore returns to the
// default it removes it from the internal so memory is not
// leaked per key
val action3 = {
for {
sem <- KeySemaphore.of[IO, Int]{(_: Int) => 1L}
first <- sem(1).tryAcquire
second <- sem(1).tryAcquire
_ <- sem(1).release
third <- sem(1).tryAcquire
} yield (first, second, third)
}
// action3: IO[(Boolean, Boolean, Boolean)] = FlatMap(
// ioe = Map(
// ioe = Delay(
// thunk = cats.effect.IO$$$Lambda$10894/0x0000000102ed7440@66f18b19,
// event = cats.effect.tracing.TracingEvent$StackTrace
// ),
// f = io.chrisdavenport.keysemaphore.KeySemaphore$$$Lambda$10895/0x0000000102ed6040@3b4a4ae3,
// event = cats.effect.tracing.TracingEvent$StackTrace
// ),
// f = <function1>,
// event = cats.effect.tracing.TracingEvent$StackTrace
// )
action3.unsafeRunSync()
// res2: (Boolean, Boolean, Boolean) = (true, false, true)