Table of Contents

Class ContextContainer<TParent>

Namespace
CMS.Base
Assembly
CMS.Base.dll

Container class for storing ambient context data. The container is backed by both the HTTP context items (if available) and an System.Threading.AsyncLocal<T> field so that the data are available along the asynchronous control flow in a web application.

public class ContextContainer<TParent> : AbstractHierarchicalObject<TParent>, IDataContainer, ISimpleDataContainer, IVirtualHierarchicalObject, IHierarchicalObject, INameIndexable where TParent : ContextContainer<TParent>, new()

Type Parameters

TParent
Inheritance
object
ContextContainer<TParent>
Implements
Derived
Inherited Members
Extension Methods

Remarks

To prevent the ambient context data from flowing along the asynchronous control flow or to child threads use the System.Threading.ExecutionContext.SuppressFlow() method.

The CMSThread class prevents the ambient context data from implicitly flowing. Instead, the context data are explicitly cloned upon initializing the new thread.

Fields

AddToContainers

If true (default), the object is added to the thread containers so that it is cloned for a new thread

protected static bool AddToContainers

Field Value

bool

Properties

Current

Current request data

protected static TParent Current { get; set; }

Property Value

TParent

IsDefault

Returns true if the context is the default request context

public bool IsDefault { get; protected set; }

Property Value

bool

Key

Unique container key

[Obsolete("Property was not intended for public use and will be removed in the next version.")]
[ObsoleteSince(28, 3)]
public string Key { get; }

Property Value

string

Methods

Clear()

Clears the current context value

public static void Clear()

ClearCurrent()

Clears the current context value

public void ClearCurrent()

EnsureCurrent()

Creates the internal ContextContainer<TParent> storage if it does not exist yet.

public void EnsureCurrent()

SetAsCurrent()

Sets the current instance as the current thread item

public virtual void SetAsCurrent()

See Also

CMSThread