cats-effect
3.6-1f95fd7
API
Generated with
cats-effect/cats.effect.unsafe/PollingSystem

PollingSystem

cats.effect.unsafe.PollingSystem
abstract class PollingSystem

Attributes

Source:
PollingSystem.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object SleepSystem.type

Members list

Concise view

Type members

Types

type GlobalPollingState <: AnyRef

The user-facing interface.

The user-facing interface.

Attributes

Source:
PollingSystem.scala
type Poller <: AnyRef

The thread-local data structure used for polling.

The thread-local data structure used for polling.

Attributes

Source:
PollingSystem.scala

Value members

Abstract methods

def closePoller(poller: Poller): Unit

Attributes

Source:
PollingSystem.scala
def interrupt(targetThread: Thread, targetPoller: Poller): Unit

Attributes

Source:
PollingSystem.scala
def makePoller(): Poller

Attributes

Source:
PollingSystem.scala
def needsPoll(poller: Poller): Boolean

Attributes

Returns:

whether poll should be called again (i.e., there are more events to be polled)

Source:
PollingSystem.scala
def poll(poller: Poller, nanos: Long, reportFailure: Throwable => Unit): Boolean

Attributes

nanos

the maximum duration for which to block, where nanos == -1 indicates to block indefinitely. ''However'', if nanos == -1 and there are no remaining events to poll for, this method should return false immediately. This is unfortunate but necessary so that the EventLoop can yield to the Scala Native global ExecutionContext which is currently hard-coded into every test framework, including MUnit, specs2, and Weaver.

Returns:

whether any events were polled

Source:
PollingSystem.scala
Generated with