TimeoutMilliseconds Property

Summary

Timeout in milliseconds.

Syntax

C++/CLI

Python

public int TimeoutMilliseconds {get; set;}

public:  
   property Int32 TimeoutMilliseconds 
   { 
      Int32 get() 
      void set(Int32 value) 
   }

TimeoutMilliseconds # get and set (CodecsTimeoutOptions)

Property Value

Value	Description
0	No timeout on long-running operations. Default value is 0.
>0	Timeout in milliseconds, at which point to abort long-running operations.

Remarks

For additional information, refer to CodecsTimeoutOptions for more information.

Example

Java

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing; 
using Leadtools.ImageProcessing.Color; 
using Leadtools.Svg; 
 
 
// Call this method with a very large and complex XLSX document and a timeout in seconds value 
// Returns true on success and false if aborted 
// For each page, the image is loaded and passed to the processImage action 
public bool CodecsTimeoutExample(string inputFileName, int timeoutSeconds, Action<RasterImage, int> processImage) 
{ 
   using (var rasterCodecs = new RasterCodecs()) 
   { 
      // Set the timeout 
      // CodecsTimeoutOptions reference 
      rasterCodecs.Options.Timeout.TimeoutMilliseconds = timeoutSeconds * 1000; 
 
      // First, get information on the file to get the number of pages 
      RasterImageFormat format; 
      int pageCount = 0; 
      using (CodecsImageInfo imageInfo = rasterCodecs.GetInformation(inputFileName, true)) 
      { 
         // If GetInformationt took more than timeoutSeconds then RasterCodecs aborted the operation 
         // and GetInformation will return RasterImageFormat.Unknown 
         format = imageInfo.Format; 
         if (format != RasterImageFormat.Unknown) 
            pageCount = imageInfo.TotalPages; 
      } 
 
      // Did we abort? 
      if (format == RasterImageFormat.Unknown) 
      { 
         return false; 
      } 
 
      // Now load all the pages 
 
      for (int pageNumber = 1; pageNumber <= pageCount; pageNumber++) 
      { 
         RasterImage image = rasterCodecs.Load(inputFileName, pageNumber); 
         // If Load took more than timeoutSeconds then RasterCodecs aborted the operation 
         // and Load will return null 
 
         // Did we abort? 
         if (image == null) 
         { 
            // Yes, fail 
            return false; 
         } 
 
         // Process the image and then delete it 
         processImage(image, pageNumber); 
         image.Dispose(); 
      } 
 
      // We successfully loaded and processed all the pages from the file 
      return true; 
   } 
}

 
import java.io.*; 
import java.net.*; 
import java.nio.file.Paths; 
import java.util.*; 
import java.time.Instant; 
import java.time.Duration; 
 
import org.junit.*; 
import org.junit.runner.JUnitCore; 
import org.junit.runner.Result; 
import org.junit.runner.notification.Failure; 
import static org.junit.Assert.*; 
 
import leadtools.*; 
import leadtools.codecs.*; 
import leadtools.codecs.RasterCodecs.FeedCallbackThunk; 
import leadtools.drawing.internal.*; 
import leadtools.imageprocessing.*; 
import leadtools.imageprocessing.color.ChangeIntensityCommand; 
import leadtools.svg.*; 
 
 
// Call this method with a very large and complex XLSX document and a timeout in 
// seconds value 
// Returns true on success and false if aborted 
// For each page, the image is loaded and passed to the processImage action 
public void codecsTimeoutExample() throws InterruptedException { 
   final String LEAD_VARS_IMAGES_DIR = "C:\\LEADTOOLS23\\Resources\\Images"; 
   String inputFileName = combine(LEAD_VARS_IMAGES_DIR, "leadtools.pdf"); 
   RasterCodecs rasterCodecs = new RasterCodecs(); 
 
   // Set the timeout 
   // CodecsTimeoutOptions reference 
   rasterCodecs.getOptions().getTimeout().setTimeoutMilliseconds(timeoutSeconds * 1000); 
 
   // First, get information on the file to get the number of pages 
   RasterImageFormat format; 
   int pageCount = 0; 
   CodecsImageInfo imageInfo = rasterCodecs.getInformation(inputFileName, true); 
 
   // If GetInformationt took more than timeoutSeconds then RasterCodecs aborted 
   // the operation 
   // and GetInformation will return RasterImageFormat.Unknown 
   format = imageInfo.getFormat(); 
   if (format != RasterImageFormat.UNKNOWN) { 
      pageCount = imageInfo.getTotalPages(); 
   } 
 
   // Did we abort? 
   if (format == RasterImageFormat.UNKNOWN) { 
      return; 
   } 
 
   // Now load all the pages 
   int i = 0; 
   for (int pageNumber = 1; pageNumber <= pageCount; pageNumber++) { 
      i++; 
      RasterImage image = rasterCodecs.load(inputFileName, pageNumber); 
      // If Load took more than timeoutSeconds then RasterCodecs aborted the operation 
      // and Load will return null 
 
      // Did we abort? 
      if (image == null) { 
         // Yes, fail 
         return; 
      } 
 
      // Process the image and then delete it 
      processImage(image, pageNumber); 
      image.dispose(); 
   } 
 
   assertTrue("all pages are accounted for", i == pageCount); 
   System.out.println("all images have been loaded"); 
   // We successfully loaded and processed all the pages from the file 
   return; 
} 
 
public void processImage(RasterImage image, int pageNumber) throws InterruptedException { 
   Thread.sleep(1000); 
}

Requirements

Target Platforms

Reference

CodecsTimeoutOptions Class

CodecsTimeoutOptions Members

Leadtools.Codecs Namespace

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Codecs Assembly

Introduction

Getting Started

Namespaces

Leadtools.Codecs Namespace

Assemblies