IMinimizeGarbageCollection Interface
Indicates that Carmenta Engine should clean up temporary objects passed to and returned by a .NET or Java custom object.
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECustomObjects assembly)
Syntax
public interface IMinimizeGarbageCollectionRemarks
The IMinimizeGarbageCollection interface is an empty marker interface. A .NET or Java custom object can add the IMinimizeGarbageCollection interface to the implementing class to indicate that Carmenta Engine should automatically dispose reference objects passed to, or returned from, the custom object. This can increase the performance of a custom object significantly, due to less work being generated for the garbage collector, as well limit the amount of memory that is used.
Adding the IMinimizeGarbageCollection interface to a custom object implementation will also make Carmenta Engine dispose reference objects passed to, or returned from, any associated custom object interface. For example, if Carmenta Engine disposes objects passed to, or returned from, a custom dataset then objects passed to, or returned from, the associated IQueryResult implementation will also be disposed automatically.
IMinimizeGarbageCollection should not be added to custom objects that cache objects between updates since a cached object will no longer be valid after it has been disposed by Carmenta Engine.
Platforms
Windows, Linux, Android
See Also
Reference
CustomObjects Module
CustomDataSetAdapter
CustomOperatorAdapter
ICustomDataSet
ICustomNativeSymbol
ICustomNativeVisualizer
ICustomOperator
ICustomSymbol
ICustomVisualizer
IMinimizeGarbageCollection Members
The IMinimizeGarbageCollection type has the following members.