English | 日本
PDF Java
Shopping CartContact Us
Knowledgebase
BCL easy PDF SDK

Managing timeout during PDF creation with easyPDF SDK

Last Updated: 3/11/2014

BCL's PDF SDKs have Timeout Values to help make sure that a single failed conversion does not freeze the entire production line. These Timeout Value all have Default Values, generally either 1 or 5 minutes, and will terminate any PDF conversion if their aspect of the conversion takes longer than the time specified. Remember that the Timeouts themselves are defined in Milliseconds. For easyPDF SDK, all of the Timeouts can be completely disabled by setting them to 0. This will cause the PDF SDK to wait indefinitely for the Process to complete. This is therefore not advised for a Production Environment, however it can be useful for testing the PDF SDK and determining more appropriate Timeout Values.

For easyPDF SDK, we have several Timeouts. The core three are part of PrintJob, and are inherited by all of the derivative PrintJob objects such as WordPrintJob.

  • PrintJob.InitializationTimeout
    Default = 1 Minute : Which determines how long the PDF SDK waits for the Host Application, such as Word, to start up.
  • PrintJob.PageConversionTimeout
    Default = 1 Minute : Which determines how long the PDF SDK waits for each Page to be converted.
  • PrintJob.FileConversionTimeout
    Default = 5 Minutes : Which determines how long the PDF SDK waits for the entire file to be converted.

Some of the PDF SDK Objects also have their own Unique Timeouts. These Timeouts include :

  • WordPrintJob.AddInTimeout
    Used when ConvertHyperlinks and ConvertBookmarks are true as both can be very processor intensive.
  • ExcelPrintJobEx.ExcelTimeout
    Determines how long the PDF SDK will wait for the File to XPS conversion and does not include the Printing Time.
  • PowerPointPrintJobEx.ExcelTimeout
    Determines how long the PDF SDK will wait for the File to XPS conversion and does not include the Printing Time.
  • PublisherPrintJobEx.ExcelTimeout
    Determines how long the PDF SDK will wait for the File to XPS conversion and does not include the Printing Time.
  • VisioPrintJobEx.ExcelTimeout
    Determines how long the PDF SDK will wait for the File to XPS conversion and does not include the Printing Time.
  • WordPrintJobEx.ExcelTimeout
    Determines how long the PDF SDK will wait for the File to XPS conversion and does not include the Printing Time.
  • OutlookPrintJob.QueueWaitTimeout
    OutlookPrintJob cannot be multithreaded, and this determines how long each job will wait in the queue.
  • PowerPointPrintJob.QueueWaitTimeout
    PowerPointPrintJob cannot be multithreaded, and this determines how long each job will wait in the queue.
  • PowerPointPrintJobEx.QueueWaitTimeout
    PowerPointPrintJobEx cannot be multithreaded, and this determines how long each job will wait in the queue.

For easyConverter SDK (for converting PDF to Word), there is only one Timeout, Converter.FileConversionTimeout. This Timeout is also set in milliseconds, and also has a Default Value of 5. However unlike the easyPDF SDK Timeouts, it is not disabled by setting it to 0. If you set the Timeout to 0 then the Application will Timeout if it does not complete everything in 0 milliseconds.

Generally, if a Timeout is reached, BCL’s PDF SDKs will cancel the job and report an error that explicitly mentions the Timeout that caused the cancel, however this is not always the case.  If the PDF SDK was frozen, and the Timeout caused the job to cancel, it will instead try to report the error the PDF SDK was receiving.  If the error seems to be intermittent or related to the processing load of the machine, extending or disabling the timeouts is the best place to start for troubleshooting.


PDF SDK Knowledgebase
 
BCL
© 1993 - , BCL Technologies.
All other trademarks are the property of their respective owners.