GC.KeepAlive(Object) Yöntem

Tanım

Ad Alanı:

System

Bütünleştirilmiş Kod:

System.Runtime.dll

Bütünleştirilmiş Kod:

mscorlib.dll

Bütünleştirilmiş Kod:

netstandard.dll

Belirtilen nesneye başvurur, bu da geçerli yordamın başlangıcından bu yöntemin çağrıldığı noktaya kadar çöp toplama için uygun değildir.

C#

public static void KeepAlive (object obj);

C#

public static void KeepAlive (object? obj);

Parametreler

obj

Object

Başvurulacak nesne.

Örnekler

Aşağıdaki kod örneği, yönteminin Main başında bir nesne oluşturur ve yöntem çağrıldığında sonuna kadar nesneye KeepAlive yeniden başvurmaz. nesnesi, ve WaitForPendingFinalizers yöntemlerine yapılan çağrılara Collect rağmen yöntemin Main 30 saniyelik süresi boyunca kalır.

C#

using System;
using System.Threading;
using System.Runtime.InteropServices;

// A simple class that exposes two static Win32 functions.
// One is a delegate type and the other is an enumerated type.
public class MyWin32
{
    // Declare the SetConsoleCtrlHandler function
    // as external and receiving a delegate.
    [DllImport("Kernel32")]
    public static extern Boolean SetConsoleCtrlHandler(HandlerRoutine Handler,
        Boolean Add);

    // A delegate type to be used as the handler routine
    // for SetConsoleCtrlHandler.
    public delegate Boolean HandlerRoutine(CtrlTypes CtrlType);

    // An enumerated type for the control messages
    // sent to the handler routine.
    public enum CtrlTypes
    {
        CTRL_C_EVENT = 0,
        CTRL_BREAK_EVENT,
        CTRL_CLOSE_EVENT,
        CTRL_LOGOFF_EVENT = 5,
        CTRL_SHUTDOWN_EVENT
    }
}

public class MyApp
{
    // A private static handler function in the MyApp class.
    static Boolean Handler(MyWin32.CtrlTypes CtrlType)
    {
        String message = "This message should never be seen!";

        // A switch to handle the event type.
        switch(CtrlType)
        {
            case MyWin32.CtrlTypes.CTRL_C_EVENT:
                message = "A CTRL_C_EVENT was raised by the user.";
                break;
            case MyWin32.CtrlTypes.CTRL_BREAK_EVENT:
                message = "A CTRL_BREAK_EVENT was raised by the user.";
                break;
            case MyWin32.CtrlTypes.CTRL_CLOSE_EVENT:
                message = "A CTRL_CLOSE_EVENT was raised by the user.";
                break;
            case MyWin32.CtrlTypes.CTRL_LOGOFF_EVENT:
                message = "A CTRL_LOGOFF_EVENT was raised by the user.";
                break;
            case MyWin32.CtrlTypes.CTRL_SHUTDOWN_EVENT:
                message = "A CTRL_SHUTDOWN_EVENT was raised by the user.";
                break;
        }

        // Use interop to display a message for the type of event.
        Console.WriteLine(message);

        return true;
    }

    public static void Main()
    {

        // Use interop to set a console control handler.
        MyWin32.HandlerRoutine hr = new MyWin32.HandlerRoutine(Handler);
        MyWin32.SetConsoleCtrlHandler(hr, true);

        // Give the user some time to raise a few events.
        Console.WriteLine("Waiting 30 seconds for console ctrl events...");

        // The object hr is not referred to again.
        // The garbage collector can detect that the object has no
        // more managed references and might clean it up here while
        // the unmanaged SetConsoleCtrlHandler method is still using it.
        
        // Force a garbage collection to demonstrate how the hr
        // object will be handled.
        GC.Collect();
        GC.WaitForPendingFinalizers();
        GC.Collect();
        
        Thread.Sleep(30000);

        // Display a message to the console when the unmanaged method
        // has finished its work.
        Console.WriteLine("Finished!");

        // Call GC.KeepAlive(hr) at this point to maintain a reference to hr.
        // This will prevent the garbage collector from collecting the
        // object during the execution of the SetConsoleCtrlHandler method.
        GC.KeepAlive(hr);
        Console.Read();
    }
}

Açıklamalar

yönteminin KeepAlive amacı, atık toplayıcı tarafından erken geri kazanılma riski olan bir nesneye başvurunun mevcut olduğundan emin olmaktır. Bunun olabileceği yaygın bir senaryo, yönetilen kodda veya verilerde nesneye başvuru olmadığında ancak nesnenin Windows API'leri, yönetilmeyen DLL'ler veya COM kullanan yöntemler gibi yönetilmeyen kodlarda hala kullanımda olmasıdır.

Bu yöntem parametresine obj başvurur ve bu nesnenin yordamın başlangıcından bu yöntemin çağrıldığı yürütme sırasına kadar çöp toplama için uygun olmadığını gösterir. Bu yöntemi, kullanılabilir olması gereken yönergeler obj aralığının başında değil sonunda kodlayın.

KeepAlive yöntemi hiçbir işlem gerçekleştirmez ve parametre olarak geçirilen nesnenin ömrünü uzatma dışında hiçbir yan etki üretmez.

Şunlara uygulanır