Resharper: Implicitly captured closure: this

C#.NetResharper

C# Problem Overview


I am getting this warning ("Implicity captured closure: this") from Resharper: does this mean that somehow this code is capturing the entire enclosing object?

    internal Timer Timeout = new Timer
							{
								Enabled = false,
								AutoReset = false
							};
    public Task<Response> ResponseTask
    {
		get
		{
			var tcs = new TaskCompletionSource<Response>();

			Timeout.Elapsed += (e, a) => tcs.SetException(new TimeoutException("Timeout at " + a.SignalTime));

			if (_response != null) tcs.SetResult(_response);
			else ResponseHandler += r => tcs.SetResult(_response);
			return tcs.Task;
		}
    }

I'm not sure how or why it's doing so - the only variable it should be capturing is the TaskCompletionSource, which is intentional. Is this actually a problem and how would I go about solving it if it is?

EDIT: The warning is on the first lambda (the Timeout event).

C# Solutions


Solution 1 - C#

It seems that the problem isn't the line I think it is.

The problem is that I have two lambdas referencing fields in the parent object: The compiler generates a class with two methods and a reference to the parent class (this).

I think this would be a problem because the reference to this could potentially stay around in the TaskCompletionSource object, preventing it from being GCed. At least that's what I've found on this issue suggests.

The generated class would look something like this (obviously names will be different and unpronounceable):

class GeneratedClass {
    Request _this;
    TaskCompletionSource tcs;
    
    public lambda1 (Object e, ElapsedEventArgs a) {
        tcs.SetException(new TimeoutException("Timeout at " + a.SignalTime));
    }

    public lambda2 () {
        tcs.SetResult(_this._response);
    }
}

The reason the compiler does this is probably efficiency, I suppose, as the TaskCompletionSource is used by both lambdas; but now as long as a reference to one of those lambdas is still referenced the reference to Request object is also maintained.

I'm still no closer to figuring out how to avoid this issue, though.

EDIT: I obviously didn't think through this when I was writing it. I solved the problem by changing the method like this:

    public Task<Response> TaskResponse
    {
		get
		{
			var tcs = new TaskCompletionSource<Response>();

			Timeout.Elapsed += (e, a) => tcs.SetException(new TimeoutException("Timeout at " + a.SignalTime));
			
			if (_response != null) tcs.SetResult(_response);
			else ResponseHandler += tcs.SetResult; //The event passes an object of type Response (derp) which is then assigned to the _response field.
			return tcs.Task;
		}
    }

Solution 2 - C#

It looks like _response is a field in your class.

Referencing _response from the lambda will capture this in the closure, and will read this._response when the lambda executes.

To prevent this, you can copy _response to a local variable and use that instead. Note that that will cause it to use the current value of _response rather than its eventual value.

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionAaron MaslenView Question on Stackoverflow
Solution 1 - C#Aaron MaslenView Answer on Stackoverflow
Solution 2 - C#SLaksView Answer on Stackoverflow