Interromper operação de salvamento pendente

Infelizmente, existem situações em que o aplicativo fica pendente durante o salvamento do documento e deixa de responder. Este recurso permite que você cancele operações de longa duração de forma elegante, como salvar documentos PDF grandes ou complexos, prevenindo congelamentos do aplicativo e melhorando a capacidade de resposta. Você encontrará as informações relevantes para integrar essa funcionalidade em seus aplicativos. Observe que essa abordagem garante que seu aplicativo permaneça responsivo mesmo durante operações que consomem muitos recursos.

A classe ‘InterruptMonitor’ fornece a capacidade de interromper o processo de salvamento do documento se ele demorar demais. (https://reference.aspose.com/pdf/net/aspose.pdf.multithreading/interruptmonitor/).

O seguinte trecho de código também funciona com a biblioteca Aspose.PDF.Drawing.

Usando InterruptMonitor

Vamos destacar que a implementação envolve várias etapas-chave:

1. Criação do InterruptMonitor: Instancie um objeto InterruptMonitor. Este objeto atua como um sinal para a interrupção da thread.

2. Atribuição de ThreadLocalInstance: Antes de iniciar a operação de longa duração do Aspose.PDF, atribua a instância do InterruptMonitor a InterruptMonitor.ThreadLocalInstance para a thread atual. Isso vincula o monitor à thread.

3. Execução da Thread: Execute o código contendo a operação do Aspose.PDF (por exemplo, Document.Save()) dentro de uma thread separada.

4. Sinal de Interrupção: Em um ponto adequado (por exemplo, após um tempo limite ou ação do usuário), chame monitor.Interrupt(). Isso sinaliza a thread para terminar.

5. Tratamento de Exceções: O método Document.Save() lança uma OperationCanceledException se for interrompido. Trate essa exceção usando um bloco try-catch. Lembre-se de que o tratamento adequado de exceções é crucial para a estabilidade do aplicativo.

O seguinte trecho de código mostra como usar o InterruptMonitor no processamento de PDF.

.NET Core 3.1

// For complete examples and data files, visit https://github.com/aspose-pdf/Aspose.PDF-for-.NET
private static void InterruptMonitorExample()
{
    // The path to the documents directory
    var dataDir = RunExamples.GetDataDir_AsposePdf_Text();
    // Path to a large text file 
    var longTextFile = dataDir + "LongTextFile.txt";
    var outputFile = dataDir + "interrupt_output.pdf";
    var longText = File.ReadAllText(longTextFile);

    // Create an InterruptMonitor instance
    using (var monitor = new InterruptMonitor())
    {
        // Create a RowSpanWorker instance, passing the monitor
        var worker = new RowSpanWorker(outputFile, monitor, longText);

        // Start the worker thread
        var thread = new Thread(worker.Work);
        thread.Start();

        // Simulate a timeout (adjust as needed)
        Thread.Sleep(500);

        // Interrupt the thread
        monitor.Interrupt();

        // Wait for the thread to finish
        thread.Join();
    }
}

// Helper class to demonstrate how to handle PDF generation with interruption support
private class RowSpanWorker
{
    private readonly string outputPath;
    private readonly string longText;
    private readonly Aspose.Pdf.Multithreading.InterruptMonitor monitor;

    public RowSpanWorker(string outputPath, Aspose.Pdf.Multithreading.InterruptMonitor monitor, string longText)
    {
        this.outputPath = outputPath;
        this.monitor = monitor;
        this.longText = longText;
    }

    public void Work()
    {
        // Create PDF document
        using (var document  = new Aspose.Pdf.Document())
        {
            // Assign the InterruptMonitor to the current thread
            Aspose.Pdf.Multithreading.InterruptMonitor.ThreadLocalInstance = this.monitor;
            var page = document.Pages.Add();

            var table = new Aspose.Pdf.Table
            {
                DefaultCellBorder = new Aspose.Pdf.BorderInfo(Aspose.Pdf.BorderSide.All, 0.1F)
            };

            var row0 = table.Rows.Add();

            // Add a cell spanning multiple rows with long text
            var cell00 = row0.Cells.Add(this.longText);
            cell00.RowSpan = 2;
            cell00.IsWordWrapped = true;
            row0.Cells.Add("Ipsum Ipsum Ipsum");
            row0.Cells.Add("Dolor Dolor Dolor");

            var row1 = table.Rows.Add();
            row1.Cells.Add("Ipsum Dolor");
            row1.Cells.Add("Dolor Dolor");

            page.Paragraphs.Add(table);

            try
            {
                // Save the document (this operation can be interrupted)
                document.Save(this.outputPath);
            }
            catch (OperationCanceledException ex)
            {
                Console.WriteLine($"Operation cancelled: {ex.Message}");
            }
        }
    }
}

.NET 8

private static void InterruptMonitorExample()
{
    // The path to the documents directory
    var dataDir = RunExamples.GetDataDir_AsposePdf_Text();

    // Construct a long text string to simulate a long process
    var longTextFile = Path.Combine(dataDir, "LongTextFile.txt");
    var outputFile = Path.Combine(dataDir, "interrupt_output.pdf");
    var longText = File.ReadAllText(longTextFile);

    // Create an InterruptMonitor instance
    using Aspose.Pdf.Multithreading.InterruptMonitor monitor = new();

    // Create a RowSpanWorker instance, passing the monitor
    var worker = new RowSpanWorker(outputFile, monitor, longText);

    // Start the worker thread
    var thread = new Thread(worker.Work);
    thread.Start();

    // Simulate a timeout (adjust as needed)
    Thread.Sleep(500);

    // Interrupt the thread
    monitor.Interrupt();

    // Wait for the thread to finish
    thread.Join();    
}

// Helper class to demonstrate how to handle PDF generation with interruption support
public class RowSpanWorker
{
    private readonly string _outputFile;
    private readonly InterruptMonitor _monitor;
    private readonly string _longText;

    public RowSpanWorker(string outputFile, Aspose.Pdf.Multithreading.InterruptMonitor monitor, string longText)
    {
        _outputFile = outputFile;
        _monitor = monitor;
        _longText = longText;
    }

    public void Work()
    {
        // Create PDF document
        using Aspose.Pdf.Document document = new();

        // Assign the InterruptMonitor to the current thread
        Aspose.Pdf.Multithreading.InterruptMonitor.ThreadLocalInstance = this._monitor;
        var page = document.Pages.Add();

        var table = new Aspose.Pdf.Table
        {
            DefaultCellBorder = new Aspose.Pdf.BorderInfo(Aspose.Pdf.BorderSide.All, 0.1F)
        };

        var row0 = table.Rows.Add();

        // Add a cell spanning multiple rows with long text
        var cell00 = row0.Cells.Add(this._longText);
        cell00.RowSpan = 2;
        cell00.IsWordWrapped = true;
        row0.Cells.Add("Ipsum Ipsum Ipsum Ipsum Ipsum Ipsum ");
        row0.Cells.Add("Dolor Dolor Dolor Dolor Dolor Dolor ");

        var row1 = table.Rows.Add();
        row1.Cells.Add("IpsumDolor Dolor Dolor Dolor Dolor ");
        row1.Cells.Add("DolorDolor Dolor Dolor Dolor Dolor ");

        page.Paragraphs.Add(table);
        try
        {
            // Save() operation supports interruption 
            document.Save(this._outputFile);
        }
        catch (OperationCanceledException ex)
        {
            // Print operation cancel exception's message to console 
            Console.WriteLine(ex.Message);
        }
    }
}