ThreadScopedLifestyle Class

Simple Injector
Defines a lifestyle that caches instances during the lifetime of an explicitly defined scope using the BeginScope method. A scope is thread-specific, each thread should define its own scope. Scopes can be nested and nested scopes will get their own instance. Instances created by this lifestyle can be disposed when the created scope gets disposed.
Inheritance Hierarchy
SystemObject
  SimpleInjectorLifestyle
    SimpleInjectorScopedLifestyle
      SimpleInjector.LifestylesThreadScopedLifestyle

Namespace:  SimpleInjector.Lifestyles
Assembly:  SimpleInjector (in SimpleInjector.dll) Version: 5.3.0
Syntax
Copy
public class ThreadScopedLifestyle : ScopedLifestyle

The ThreadScopedLifestyle type exposes the following members.

Constructors
  NameDescription
Public methodThreadScopedLifestyle
Initializes a new instance of the ThreadScopedLifestyle class. The created and cached instance will be disposed when the created Scope instance gets disposed and when the created object implements IDisposable.
Top
Properties
  NameDescription
Public propertyLength
Gets the length of the lifestyle. Implementers must implement this property. The diagnostic services use this value to compare lifestyles with each other to determine lifestyle misconfigurations.
(Inherited from ScopedLifestyle.)
Public propertyName
Gets the user friendly name of this lifestyle.
(Inherited from Lifestyle.)
Top
Methods
  NameDescription
Public methodStatic memberCode exampleBeginScope
Begins a new scope for the given container. Services, registered using the ThreadScopedLifestyle are cached during the lifetime of that scope. The scope should be disposed explicitly.
Protected methodCreateCurrentScopeProvider
Creates a delegate that upon invocation return the current Scope for this lifestyle and the given container, or null when the delegate is executed outside the context of such scope.
(Overrides ScopedLifestyleCreateCurrentScopeProvider(Container).)
Public methodCreateProducer(Type, Type, Container)
Creates a new InstanceProducer instance for the given serviceType that will create new instances of specified implementationType with the caching as specified by this lifestyle.
(Inherited from Lifestyle.)
Public methodCreateProducerTService(FuncTService, Container)
Creates a new InstanceProducer instance for the given TService that will create new instances instance using the supplied instanceCreator with the caching as specified by this lifestyle.
(Inherited from Lifestyle.)
Public methodCreateProducerTService(Type, Container)
Creates a new InstanceProducer instance for the given TService that will create new instances of specified implementationType caching as specified by this lifestyle.
(Inherited from Lifestyle.)
Public methodCreateProducerTService, TImplementation(Container)
Creates a new InstanceProducer instance for the given TService that will create new instances of specified TImplementation with the caching as specified by this lifestyle.
(Inherited from Lifestyle.)
Public methodCreateRegistration(Type, Container)
Creates a new Registration instance defining the creation of the specified concreteType with the caching as specified by this lifestyle, or returns an already created Registration instance for this container + lifestyle + type combination. This method might fail when run in a partial trust sandbox when concreteType is an internal type.
(Inherited from Lifestyle.)
Public methodCreateRegistration(Type, FuncObject, Container)
Creates a new Registration instance defining the creation of the specified serviceType using the supplied instanceCreator with the caching as specified by this lifestyle.
(Inherited from Lifestyle.)
Public methodCreateRegistrationTConcrete(Container)
Creates a new Registration instance defining the creation of the specified TConcrete with the caching as specified by this lifestyle, or returns an already created Registration instance for this container + lifestyle + type combination.
(Inherited from Lifestyle.)
Public methodCreateRegistrationTService(FuncTService, Container)
Creates a new Registration instance defining the creation of the specified TService using the supplied instanceCreator with the caching as specified by this lifestyle.
(Inherited from Lifestyle.)
Protected methodCreateRegistrationCore(Type, Container)
When overridden in a derived class, creates a new Registration instance defining the creation of the specified concreteType with the caching as specified by this lifestyle.
(Inherited from ScopedLifestyle.)
Protected methodCreateRegistrationCoreTService(FuncTService, Container)
When overridden in a derived class, creates a new Registration instance defining the creation of the specified TService using the supplied instanceCreator with the caching as specified by this lifestyle.
(Inherited from Lifestyle.)
Protected methodCreateRegistrationCoreTService(FuncTService, Container)
When overridden in a derived class, creates a new Registration instance defining the creation of the specified TService using the supplied instanceCreator with the caching as specified by this lifestyle.
(Inherited from ScopedLifestyle.)
Public methodGetCurrentScope
Returns the current Scope for this lifestyle and the given container, or null when this method is executed outside the context of a scope.
(Inherited from ScopedLifestyle.)
Protected methodGetCurrentScopeCore
Returns the current Scope for this lifestyle and the given container, or null when this method is executed outside the context of a scope.
(Overrides ScopedLifestyleGetCurrentScopeCore(Container).)
Public methodRegisterForDisposal
Adds the disposable to the list of items that will get disposed when the scope ends.
(Inherited from ScopedLifestyle.)
Public methodSetCurrentScope
Sets the given scope as current scope in the given context. An existing scope will be overridden and not disposed of. If the overridden scope must be disposed of, this must be done manually.
(Inherited from ScopedLifestyle.)
Protected methodSetCurrentScopeCore
Sets the given scope as current scope in the given context.
(Overrides ScopedLifestyleSetCurrentScopeCore(Scope).)
Public methodWhenScopeEnds
Allows registering an action delegate that will be called when the scope ends, but before the scope disposes any instances.
(Inherited from ScopedLifestyle.)
Top
Examples
The following example shows the usage of the ThreadScopedLifestyle class:
C#
Copy
var container = new Container();
container.Options.DefaultScopedLifestyle = new ThreadScopedLifestyle();

container.Register<IUnitOfWork, EntityFrameworkUnitOfWork>(Lifestyle.Scoped);

using (container.BeginLifetimeScope())
{
    var instance1 = container.GetInstance<IUnitOfWork>();

    // This call will return the same instance.
    var instance2 = container.GetInstance<IUnitOfWork>();

    Assert.IsTrue(object.ReferenceEquals(instance1, instance2));

    // Create a nested scope.
    using (container.BeginLifetimeScope())
    {
        // A nested scope gets its own instance.
        var instance3 = container.GetInstance<IUnitOfWork>();

        Assert.IsFalse(object.ReferenceEquals(instance1, instance3));

        // This call will return the same instance.
        var instance4 = container.GetInstance<IUnitOfWork>();

        Assert.IsTrue(object.ReferenceEquals(instance3, instance4));
    }
}
See Also

Reference

SimpleInjector.Lifestyles Namespace