Cardano.KESAgent.Util.RefCounting

A reference-counted value.

Reference count. We use a signed integer so that we can catch cases where a reference is released beyond zero (which shouldn't happen, but we want to be able to detect it when it does).

CRef lifecycle events.

CRef lifecycle event types.

Unique identifier for a CRef. Mainly used for debugging.

Reference underflow exception: this will be thrown when a reference count is released beyond zero (i.e., becomes negative). This is generally a bug, caused by user code releasing a reference that it hasn't acquired.

Increment the CRef counter such that it will not be finalized until we releaseCRef it again.

Gets the current reference count for the CRef.

Create a fresh CRef. Its counter will be initialized to 1; the caller is responsible for calling releaseCRef to release it. newCRef f i creates a CRef with an initial value of i, and a finalizer f.

Create a fresh CRef attaching a custom tracer (see newCRef).

Read a CRef without acquiring it. The caller is responsible for making sure the CRef has been acquired appropriately for the duration of the call, and while using the wrapped resource. It is generally preferable to use withCRefValue instead.

Release a CRef by decrementing its counter. When the counter reaches zero, the resource is finalized. Releasing a CRef more often than it has been acquired is an error, and will (eventually) throwIO ReferenceCountUnderflow exceptions.

Operate on a CRef. The CRef is guaranteed to not finalize for the duration of the wrapped function call.

Operate on a CRef. The CRef is guaranteed to not finalize for the duration of the wrapped function call.

Create a fresh CRef and operate on it immediately. See newCRef.

Create a fresh CRef and operate on its value immediately. See newCRef.

Create a fresh CRef with a tracer and operate on its value immediately. See newCRefWith.

Create a fresh CRef with a tracer and operate on it immediately. See newCRefWith.