MemoryFailPoint Třída

Definice

Obor názvů:

System.Runtime

Sestavení:

netstandard.dll, System.Runtime.dll

Zdroj:

MemoryFailPoint.cs

Před provedením operace zkontroluje dostatečné paměťové prostředky. Tato třída se nemůže dědit.

public ref class MemoryFailPoint sealed : System::Runtime::ConstrainedExecution::CriticalFinalizerObject, IDisposable

public sealed class MemoryFailPoint : System.Runtime.ConstrainedExecution.CriticalFinalizerObject, IDisposable

type MemoryFailPoint = class
    inherit CriticalFinalizerObject
    interface IDisposable

Public NotInheritable Class MemoryFailPoint
Inherits CriticalFinalizerObject
Implements IDisposable

Dědičnost

Object

CriticalFinalizerObject

MemoryFailPoint

Implementuje

IDisposable

Příklady

MemoryFailPoint umožňuje aplikaci zpomalit, aby se zabránilo nedostatku paměti poškozeným způsobem. Měla by být použita v rámci lexikálního rozsahu. Následující příklad spustí vlákna pro zpracování položek v pracovní frontě. Před spuštěním každého vlákna jsou dostupné paměťové prostředky kontrolovány pomocí MemoryFailPoint. Pokud je vyvolán výjimka, hlavní metoda čeká, dokud není paměť k dispozici před spuštěním dalšího vlákna.

using System;
using System.Runtime;
using System.IO;
using System.Threading;
using System.Collections.Generic;
using System.Collections;

class MemoryFailPointExample
{
    // Allocate in chunks of 64 megabytes.
    private const uint chunkSize = 64 << 20;
    // Use more than the total user-available address space (on 32 bit machines)
    // to drive towards getting an InsufficientMemoryException.
    private const uint numWorkItems = 1 + ((1U << 31) / chunkSize);
    static Queue workQueue = new Queue(50);

    // This value can be computed separately and hard-coded into the application.
    // The method is included to illustrate the technique.
    private static int EstimateMemoryUsageInMB()
    {
        int memUsageInMB = 0;

        long memBefore = GC.GetTotalMemory(true);
        int numGen0Collections = GC.CollectionCount(0);
        // Execute a test version of the method to estimate memory requirements.
        // This test method only exists to determine the memory requirements.
        ThreadMethod();
        // Includes garbage generated by the worker function.
        long memAfter = GC.GetTotalMemory(false);
        // If a garbage collection occurs during the measuring, you might need a greater memory requirement.
        Console.WriteLine("Did a GC occur while measuring?  {0}", numGen0Collections == GC.CollectionCount(0));
        // Set the field used as the parameter for the MemoryFailPoint constructor.
        long memUsage = (memAfter - memBefore);
        if (memUsage < 0)
        {
            Console.WriteLine("GC's occurred while measuring memory usage.  Try measuring again.");
            memUsage = 1 << 20;
        }

        // Round up to the nearest MB.
        memUsageInMB = (int)(1 + (memUsage >> 20));
        Console.WriteLine("Memory usage estimate: {0} bytes, rounded to {1} MB", memUsage, memUsageInMB);
        return memUsageInMB;
    }

    static void Main()
    {
        Console.WriteLine("Attempts to allocate more than 2 GB of memory across worker threads.");
        int memUsageInMB = EstimateMemoryUsageInMB();

        // For a production application consider using the threadpool instead.
        Thread[] threads = new Thread[numWorkItems];
        // Create a work queue to be processed by multiple threads.
        int n = 0;
        for (n = 0; n < numWorkItems; n++)
            workQueue.Enqueue(n);
        // Continue to launch threads until the work queue is empty.
        while (workQueue.Count > 0)
        {
            Console.WriteLine(" GC heap (live + garbage): {0} MB", GC.GetTotalMemory(false) >> 20);
            MemoryFailPoint memFailPoint = null;
            try
            {
                // Check for available memory.
                memFailPoint = new MemoryFailPoint(memUsageInMB);
                n = (int)workQueue.Dequeue();
                threads[n] =
                    new Thread(new ParameterizedThreadStart(ThreadMethod));
                WorkerState state = new WorkerState(n, memFailPoint);
                threads[n].Start(state);
                Thread.Sleep(10);
            }
            catch (InsufficientMemoryException e)
            {
                // MemoryFailPoint threw an exception, handle by sleeping for a while,  then
                // continue processing the queue.
                Console.WriteLine("Expected InsufficientMemoryException thrown.  Message: " + e.Message);
                // We could optionally sleep until a running worker thread
                // has finished, like this:  threads[joinCount++].Join();
                Thread.Sleep(1000);
            }
        }

        Console.WriteLine("WorkQueue is empty - blocking to ensure all threads quit (each thread sleeps for 10 seconds)");
        foreach (Thread t in threads)
            t.Join();
        Console.WriteLine("All worker threads are finished - exiting application.");
    }

    // Test version of the working code to determine memory requirements.
    static void ThreadMethod()
    {
        byte[] bytes = new byte[chunkSize];
    }

    internal class WorkerState
    {
        internal int _threadNumber;
        internal MemoryFailPoint _memFailPoint;

        internal WorkerState(int threadNumber, MemoryFailPoint memoryFailPoint)
        {
            _threadNumber = threadNumber;
            _memFailPoint = memoryFailPoint;
        }

        internal int ThreadNumber
        {
            get { return _threadNumber; }
        }

        internal MemoryFailPoint MemoryFailPoint
        {
            get { return _memFailPoint; }
        }
    }

    // The method that does the work.
    static void ThreadMethod(Object o)
    {
        WorkerState state = (WorkerState)o;
        Console.WriteLine("Executing ThreadMethod, " +
            "thread number {0}.", state.ThreadNumber);
        byte[] bytes = null;
        try
        {
            bytes = new byte[chunkSize];
            // Allocated all the memory needed for this workitem.
            // Now dispose of the MemoryFailPoint, then process the workitem.
            state.MemoryFailPoint.Dispose();
        }
        catch (OutOfMemoryException oom)
        {
            Console.Beep();
            Console.WriteLine("Unexpected OutOfMemory exception thrown: " + oom);
        }

        // Do work here, possibly taking a lock if this app needs
        // synchronization between worker threads and/or the main thread.

        // Keep the thread alive for awhile to simulate a running thread.
        Thread.Sleep(10000);

        // A real thread would use the byte[], but to be an illustrative sample,
        // explicitly keep the byte[] alive to help exhaust the memory.
        GC.KeepAlive(bytes);
        Console.WriteLine("Thread {0} is finished.", state.ThreadNumber);
    }
}

Poznámky

Note

Tato třída je určena k použití v pokročilém vývoji.

Vytvoření instance MemoryFailPoint třídy vytvoří bránu paměti. Brána paměti kontroluje dostatečné prostředky před zahájením aktivity, která vyžaduje velké množství paměti. Selhání kontroly způsobí vyvolání InsufficientMemoryException výjimky. Tato výjimka brání spuštění operace a snižuje možnost selhání kvůli nedostatku prostředků. To vám umožní snížit výkon, abyste se vyhnuli výjimce OutOfMemoryException a poškození stavu, které by mohlo vést k nesprávnému zpracování výjimky v libovolných umístěních v kódu.

Important

Tento typ implementuje rozhraní IDisposable. Až tento typ dokončíte, měli byste ho odstranit buď přímo (zavoláním metody Dispose ), nebo nepřímo (s konstruktorem jazyka, například using v jazyce C#). Další informace naleznete v tématu Použití objektu, který implementuje IDisposable.

Vyvoláním InsufficientMemoryException výjimky může aplikace rozlišovat mezi odhadem, že operace nebude schopna dokončit a částečně dokončenou operaci, která mohla poškodit stav aplikace. To umožňuje aplikaci snížit frekvenci pesimistické zásady eskalace, které mohou vyžadovat uvolnění aktuálního AppDomain nebo recyklačního procesu.

MemoryFailPoint zkontroluje, jestli je ve všech haldách uvolňování paměti k dispozici dostatek paměti a po sobě jdoucího virtuálního adresního prostoru, a může zvětšit velikost prohození souboru. MemoryFailPoint neposkytuje žádné záruky týkající se dlouhodobé dostupnosti paměti během životnosti brány, ale volající by měli vždy použít metodu Dispose k zajištění uvolnění prostředků přidružených k prostředkům MemoryFailPoint .

Chcete-li použít bránu MemoryFailPoint paměti, musíte vytvořit objekt a zadat počet megabajtů (MB) paměti, kterou má další operace použít. Pokud není k dispozici dostatek paměti, InsufficientMemoryException vyvolá se výjimka.

Parametr konstruktoru musí být kladné celé číslo. Záporná hodnota nebo 0 vyvolá ArgumentOutOfRangeException výjimku.

MemoryFailPoint funguje v členitosti 16 MB. Všechny hodnoty menší než 16 MB se považují za 16 MB a další hodnoty se považují za další největší násobek 16 MB.

Konstruktory

Name	Description
MemoryFailPoint(Int32)	Inicializuje novou instanci MemoryFailPoint třídy a určuje množství paměti potřebné k úspěšnému spuštění.

Metody

Name	Description
Dispose()	Uvolní všechny prostředky používané nástrojem MemoryFailPoint.
Equals(Object)	Určuje, zda je zadaný objekt roven aktuálnímu objektu. (Zděděno od Object)
Finalize()	Zajišťuje uvolnění prostředků a provádění dalších operací čištění, když uvolňování paměti objekt uvolní MemoryFailPoint .
GetHashCode()	Slouží jako výchozí funkce hash. (Zděděno od Object)
GetType()	Získá Type aktuální instance. (Zděděno od Object)
MemberwiseClone()	Vytvoří mělkou kopii aktuálního Object. (Zděděno od Object)
ToString()	Vrátí řetězec, který představuje aktuální objekt. (Zděděno od Object)