IGCMetadata Interface

GC-specific metadata to be written into the summary.

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/container-runtime/legacy.

For more information about our API support guarantees, see here.

Signature

export interface IGCMetadata

Properties

Property	Alerts	Modifiers	Type	Description
gcFeature	Alpha	optional, readonly	GCVersion	The version of the GC code that was run to generate the GC data that is written in the summary. If the persisted value doesn't match the current value in the code, saved GC data will be discarded and regenerated from scratch. Also, used to determine whether GC is enabled for this container or not: - A value of 0 or undefined means GC is disabled. - A value greater than 0 means GC is enabled.
gcFeatureMatrix	Alpha	optional, readonly	GCFeatureMatrix	A collection of different numerical "Generations" for different features, used to determine feature availability over time. This info may come from multiple sources (FF code, config service, app via Container Runtime Options), and pertains to aspects of the document that may be fixed for its lifetime. For each dimension, if the persisted value doesn't match the currently provided value, then this file does not support the corresponding feature as currently implemented. Guidance is that if no value is provided at runtime, it should result in the current default behavior.
sessionExpiryTimeoutMs	Alpha	optional, readonly	number	If this is present, the session for this container will expire after this time and the container will close
sweepEnabled	Deprecated, Alpha	optional, readonly	boolean	Tells whether the GC sweep phase is enabled for this container. - True means sweep phase is enabled. - False means sweep phase is disabled. If GC is disabled as per gcFeature, sweep is also disabled.
tombstoneTimeoutMs	Alpha	optional, readonly	number	How long to wait after an object is unreferenced before it becomes a Tombstone. After this point, there's a grace period before the object is deleted.

Property Details

gcFeature

The version of the GC code that was run to generate the GC data that is written in the summary. If the persisted value doesn't match the current value in the code, saved GC data will be discarded and regenerated from scratch. Also, used to determine whether GC is enabled for this container or not: - A value of 0 or undefined means GC is disabled. - A value greater than 0 means GC is enabled.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/container-runtime/alpha.

For more information about our API support guarantees, see here.

Signature

readonly gcFeature?: GCVersion;

Type: GCVersion

gcFeatureMatrix

A collection of different numerical "Generations" for different features, used to determine feature availability over time. This info may come from multiple sources (FF code, config service, app via Container Runtime Options), and pertains to aspects of the document that may be fixed for its lifetime.

For each dimension, if the persisted value doesn't match the currently provided value, then this file does not support the corresponding feature as currently implemented.

Guidance is that if no value is provided at runtime, it should result in the current default behavior.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/container-runtime/alpha.

For more information about our API support guarantees, see here.

Signature

readonly gcFeatureMatrix?: GCFeatureMatrix;

Type: GCFeatureMatrix

sessionExpiryTimeoutMs

If this is present, the session for this container will expire after this time and the container will close

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/container-runtime/alpha.

For more information about our API support guarantees, see here.

Signature

readonly sessionExpiryTimeoutMs?: number;

Type: number

sweepEnabled

Tells whether the GC sweep phase is enabled for this container. - True means sweep phase is enabled. - False means sweep phase is disabled. If GC is disabled as per gcFeature, sweep is also disabled.

This API is deprecated and will be removed in a future release.

use GCFeatureMatrix.gcGeneration instead.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/container-runtime/alpha.

For more information about our API support guarantees, see here.

Signature

readonly sweepEnabled?: boolean;

Type: boolean

See Also

GCFeatureMatrix.gcGeneration

tombstoneTimeoutMs

How long to wait after an object is unreferenced before it becomes a Tombstone.

After this point, there's a grace period before the object is deleted.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/container-runtime/alpha.

For more information about our API support guarantees, see here.

Signature

readonly tombstoneTimeoutMs?: number;

Type: number

See Also

IGCRuntimeOptions.sweepGracePeriodMs

So the full sweep timeout in a session is tombstoneTimeoutMs + sweepGracePeriodMs.