ownPoller is best-effort

typelevel · Oct 23, 2024 · a2fd0cb · a2fd0cb
1 parent 5489d3a
commit a2fd0cb
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/core/jvm-native/src/main/scala/cats/effect/unsafe/PollingSystem.scala b/core/jvm-native/src/main/scala/cats/effect/unsafe/PollingSystem.scala
@@ -112,7 +112,9 @@ trait PollerProvider[P] {
   def accessPoller(cb: P => Unit): Unit
 
   /**
-   * Returns `true` if it is safe to interact with this `Poller`
+   * Returns `true` if it is safe to interact with this `Poller`. Implementors of this method
+   * may be best-effort: it is always safe to return `false`, so callers must have an adequate
+   * fallback for the non-owning case.
    */
   def ownPoller(poller: P): Boolean
 }