Skip to main content

Sasa.Weak<T> - Typed Weak References

This is the ninth post in my ongoing series covering the abstractions in Sasa. Previous posts:

System.WeakReference is a special runtime class used for collection and finalization of resources that have no other live references. The only problem is that the encapsulated value is of type "object", and so using it requires a lot more casting than it should. More often than not, a WeakReference will only encapsulate a value of one type, so this casting is often superfluous.

Enter Sasa.Weak<T>, which is a struct that wraps WeakReference and provides a typed interface to encapsulated values. As a struct, it does not incur any additional memory allocation costs, and the casting it performs are operations you would likely have to do anyway, so the overhead of the typed interface is virtually nil. Sasa.Weak<T> is available in the core Sasa.dll assembly.

Sasa.Weak<T>.HasValue

Sasa.Weak<T>.HasValue has the same purpose as Weak<T>.IsAlive, but fulfills the requirements to satisfy the IResolvable<T> interface:

string original = new string("hello world!".ToCharArray());
Weak<string> foo = original;
Console.WriteLine(foo.HasValue);

// lose all live references and run collection
original = null;
GC.Collect();
GC.WaitForPendingFinalizers();
Console.WriteLine(foo.HasValue);

// outputs:
// true
// false

Sasa.Weak<T>.IsAlive

Sasa.Weak<T>.IsAlive checks whether the target of the weak reference has yet to be collected:

string original = new string("hello world!".ToCharArray());
Weak<string> foo = original;
Console.WriteLine(foo.IsAlive);

// lose all live references and run collection
original = null;
GC.Collect();
GC.WaitForPendingFinalizers();
Console.WriteLine(foo.IsAlive);

// outputs:
// true
// false

Sasa.Weak<T>.Value

Sasa.Weak<T>.Value obtains the current value encapsulated in the weak reference, or null if the object has been collected:

string original = new string("hello world!".ToCharArray());
Weak<string> foo = original;
Console.WriteLine(foo.Value);

// lose all live references and run collection
original = null;
GC.Collect();
GC.WaitForPendingFinalizers();
Console.WriteLine(foo.Value ?? "<null>");

// outputs:
// hello world!
// <null>

The Value property also fulfills the requirements for the IValue<T> interface.

Sasa.Weak<T>.TryGetValue

Sasa.Weak<T>.TryGetValue checks whether a weak reference to a target is alive, and returns a live reference to that target in one step:

string original = new string("hello world!".ToCharArray());
Weak<string> foo = original;
Console.WriteLine(foo.TryGetValue(out original));
Console.WriteLine(original);

// lose all live references and run collection
original = null;
GC.Collect();
GC.WaitForPendingFinalizers();
Console.WriteLine(foo.TryGetValue(out original));
Console.WriteLine(original ?? "<null>");

// outputs:
// true
// hello world!
// false
// <null>

This method also satisfies the requirements for the IVolatile<T> interface.

Comments

Rodrigo Kumpera said…
Since version 4.5m there's a WeakReference variant that offers the same interface.
Sandro Magi said…
Good to hear. Sasa is written for .NET 3.5, and I've had Weak for over 5 years now.

Popular posts from this blog

async.h - asynchronous, stackless subroutines in C

The async/await idiom is becoming increasingly popular. The first widely used language to include it was C#, and it has now spread into JavaScript and Rust. Now C/C++ programmers don't have to feel left out, because async.h is a header-only library that brings async/await to C! Features: It's 100% portable C. It requires very little state (2 bytes). It's not dependent on an OS. It's a bit simpler to understand than protothreads because the async state is caller-saved rather than callee-saved. #include "async.h" struct async pt; struct timer timer; async example(struct async *pt) { async_begin(pt); while(1) { if(initiate_io()) { timer_start(&timer); await(io_completed() || timer_expired(&timer)); read_data(); } } async_end; } This library is basically a modified version of the idioms found in the Protothreads library by Adam Dunkels, so it's not truly ground bre

Building a Query DSL in C#

I recently built a REST API prototype where one of the endpoints accepted a string representing a filter to apply to a set of results. For instance, for entities with named properties "Foo" and "Bar", a string like "(Foo = 'some string') or (Bar > 99)" would filter out the results where either Bar is less than or equal to 99, or Foo is not "some string". This would translate pretty straightforwardly into a SQL query, but as a masochist I was set on using Google Datastore as the backend, which unfortunately has a limited filtering API : It does not support disjunctions, ie. "OR" clauses. It does not support filtering using inequalities on more than one property. It does not support a not-equal operation. So in this post, I will describe the design which achieves the following goals: A backend-agnostic querying API supporting arbitrary clauses, conjunctions ("AND"), and disjunctions ("OR"). Implemen

Easy Automatic Differentiation in C#

I've recently been researching optimization and automatic differentiation (AD) , and decided to take a crack at distilling its essence in C#. Note that automatic differentiation (AD) is different than numerical differentiation . Math.NET already provides excellent support for numerical differentiation . C# doesn't seem to have many options for automatic differentiation, consisting mainly of an F# library with an interop layer, or paid libraries . Neither of these are suitable for learning how AD works. So here's a simple C# implementation of AD that relies on only two things: C#'s operator overloading, and arrays to represent the derivatives, which I think makes it pretty easy to understand. It's not particularly efficient, but it's simple! See the "Optimizations" section at the end if you want a very efficient specialization of this technique. What is Automatic Differentiation? Simply put, automatic differentiation is a technique for calcu