IBM WebSphere™ eXtreme Scale Client for .NET Release 8.6.0.0 API Specification
Establishes the interval of time that any given cache entry can live for, which is referred to as "time to live"
or TTL. Setting a new TTL value affects cache entries that are accessed after this method call occurs. It does
not affect any cache entry that was created or accessed prior to this method call. By calling this method on this
IGridMapPessimisticTx, any previous value set by the
IGridMapPessimisticTx.TimeToLive property is
overridden for this map instnace. If this method is never called on the map, the default setting is used. The
default setting is to retain the time-to-live value for any existing map entry and to use the default value from
map configuration setting if a new map entry is being created. If TTL is never set on the map configuration, the cache entry
can live "forever".
This property can only be used when the TtlEvictorType property is set to LastAccessTime or
LastUpdateTime on the map configuration. If this method is called on the IGridMapPessimisticTx and the TtlEvictorType
is something other than LastAccessTime or LastUpdateTime, an ArgumentException is thrown.
To disable the TTL timeout, use a value of TimeSpan.Zero.
To revert the TTL value to the configured default, use a value of TimeSpan.MinValue.
Namespace: IBM.WebSphere.Caching.MapAssembly: Client.Api (in Client.Api.dll) Version: 8.6.0.0
TimeSpan TimeToLive { get; set; }
TimeSpan TimeToLive { get; set; }
Exception | Condition |
---|
System ArgumentException |
Occurs if the TimeSpan is not >=0 or TimeSpan.MinValue or if the TtlEvictorType
property is not LastAccessTime or LastUpdateTime.
|
Required Permission: MapPermission.INVALIDATE