DistributedSession Constructors

Definition

Namespace:

Microsoft.AspNetCore.Session

Assembly:

Microsoft.AspNetCore.Session.dll

Package:

Microsoft.AspNetCore.App.Ref v8.0.0

Overloads

DistributedSession(IDistributedCache, String, TimeSpan, TimeSpan, Func<Boolean>, ILoggerFactory, Boolean)

Initializes a new instance of DistributedSession.

DistributedSession(IDistributedCache, String, TimeSpan, TimeSpan, Func<Boolean>, ILoggerFactory, Boolean)

Initializes a new instance of DistributedSession.

public:
 DistributedSession(Microsoft::Extensions::Caching::Distributed::IDistributedCache ^ cache, System::String ^ sessionKey, TimeSpan idleTimeout, TimeSpan ioTimeout, Func<bool> ^ tryEstablishSession, Microsoft::Extensions::Logging::ILoggerFactory ^ loggerFactory, bool isNewSessionKey);

public DistributedSession (Microsoft.Extensions.Caching.Distributed.IDistributedCache cache, string sessionKey, TimeSpan idleTimeout, TimeSpan ioTimeout, Func<bool> tryEstablishSession, Microsoft.Extensions.Logging.ILoggerFactory loggerFactory, bool isNewSessionKey);

new Microsoft.AspNetCore.Session.DistributedSession : Microsoft.Extensions.Caching.Distributed.IDistributedCache * string * TimeSpan * TimeSpan * Func<bool> * Microsoft.Extensions.Logging.ILoggerFactory * bool -> Microsoft.AspNetCore.Session.DistributedSession

Public Sub New (cache As IDistributedCache, sessionKey As String, idleTimeout As TimeSpan, ioTimeout As TimeSpan, tryEstablishSession As Func(Of Boolean), loggerFactory As ILoggerFactory, isNewSessionKey As Boolean)

Parameters

cache

IDistributedCache

The IDistributedCache used to store the session data.

sessionKey

String

A unique key used to lookup the session.

idleTimeout

TimeSpan

How long the session can be inactive (e.g. not accessed) before it will expire.

ioTimeout

TimeSpan

The maximum amount of time LoadAsync(CancellationToken) and CommitAsync(CancellationToken) are allowed take.

tryEstablishSession

Func<Boolean>

A callback invoked during Set(String, Byte[]) to verify that modifying the session is currently valid. If the callback returns false, Set(String, Byte[]) throws an InvalidOperationException. SessionMiddleware provides a callback that returns false if the session was not established prior to sending the response.

loggerFactory

ILoggerFactory

The ILoggerFactory.

isNewSessionKey

Boolean

true if establishing a new session; false if resuming a session.