iText 7 7.1.9 API
iText.Kernel.Pdf.MemoryLimitsAwareHandler Class Reference

A MemoryLimitsAwareHandler handles memory allocation and prevents decompressed pdf streams from occupation of more space than allowed. More...

Public Member Functions

  MemoryLimitsAwareHandler ()
  Creates a MemoryLimitsAwareHandler which will be used to handle decompression of pdf streams. More...
 
  MemoryLimitsAwareHandler (long documentSize)
  Creates a MemoryLimitsAwareHandler which will be used to handle decompression of pdf streams. More...
 
virtual int  GetMaxSizeOfSingleDecompressedPdfStream ()
  Gets the maximum allowed size which can be occupied by a single decompressed pdf stream. More...
 
virtual iText.Kernel.Pdf.MemoryLimitsAwareHandler  SetMaxSizeOfSingleDecompressedPdfStream (int maxSizeOfSingleDecompressedPdfStream)
  Sets the maximum allowed size which can be occupied by a single decompressed pdf stream. More...
 
virtual long  GetMaxSizeOfDecompressedPdfStreamsSum ()
  Gets the maximum allowed size which can be occupied by all decompressed pdf streams. More...
 
virtual iText.Kernel.Pdf.MemoryLimitsAwareHandler  SetMaxSizeOfDecompressedPdfStreamsSum (long maxSizeOfDecompressedPdfStreamsSum)
  Sets the maximum allowed size which can be occupied by all decompressed pdf streams. More...
 

Detailed Description

A MemoryLimitsAwareHandler handles memory allocation and prevents decompressed pdf streams from occupation of more space than allowed.

Constructor & Destructor Documentation

◆ MemoryLimitsAwareHandler() [1/2]

iText.Kernel.Pdf.MemoryLimitsAwareHandler.MemoryLimitsAwareHandler ( )
inline

Creates a MemoryLimitsAwareHandler which will be used to handle decompression of pdf streams.

Creates a MemoryLimitsAwareHandler which will be used to handle decompression of pdf streams. The max allowed memory limits will be generated by default.

◆ MemoryLimitsAwareHandler() [2/2]

iText.Kernel.Pdf.MemoryLimitsAwareHandler.MemoryLimitsAwareHandler ( long  documentSize )
inline

Creates a MemoryLimitsAwareHandler which will be used to handle decompression of pdf streams.

Creates a MemoryLimitsAwareHandler which will be used to handle decompression of pdf streams. The max allowed memory limits will be generated by default, based on the size of the document.

Parameters
documentSize the size of the document, which is going to be handled by iText.

Member Function Documentation

◆ GetMaxSizeOfDecompressedPdfStreamsSum()

virtual long iText.Kernel.Pdf.MemoryLimitsAwareHandler.GetMaxSizeOfDecompressedPdfStreamsSum ( )
inlinevirtual

Gets the maximum allowed size which can be occupied by all decompressed pdf streams.

Returns
the maximum allowed size value which streams may occupy

◆ GetMaxSizeOfSingleDecompressedPdfStream()

virtual int iText.Kernel.Pdf.MemoryLimitsAwareHandler.GetMaxSizeOfSingleDecompressedPdfStream ( )
inlinevirtual

Gets the maximum allowed size which can be occupied by a single decompressed pdf stream.

Returns
the maximum allowed size which can be occupied by a single decompressed pdf stream.

◆ SetMaxSizeOfDecompressedPdfStreamsSum()

virtual iText.Kernel.Pdf.MemoryLimitsAwareHandler iText.Kernel.Pdf.MemoryLimitsAwareHandler.SetMaxSizeOfDecompressedPdfStreamsSum ( long  maxSizeOfDecompressedPdfStreamsSum )
inlinevirtual

Sets the maximum allowed size which can be occupied by all decompressed pdf streams.

Sets the maximum allowed size which can be occupied by all decompressed pdf streams. This value can be limited by the maximum expected PDF file size when it's completely decompressed. Setting this value correlates with the maximum processing time spent on document reading iText will throw an exception if during decompression pdf streams with two or more filters of identical type occupy more memory than allowed.

Parameters
maxSizeOfDecompressedPdfStreamsSum he maximum allowed size which can be occupied by all decompressed pdf streams.
Returns
this MemoryLimitsAwareHandler instance.

◆ SetMaxSizeOfSingleDecompressedPdfStream()

virtual iText.Kernel.Pdf.MemoryLimitsAwareHandler iText.Kernel.Pdf.MemoryLimitsAwareHandler.SetMaxSizeOfSingleDecompressedPdfStream ( int  maxSizeOfSingleDecompressedPdfStream )
inlinevirtual

Sets the maximum allowed size which can be occupied by a single decompressed pdf stream.

Sets the maximum allowed size which can be occupied by a single decompressed pdf stream. This value correlates with maximum heap size. This value should not exceed limit of the heap size. iText will throw an exception if during decompression a pdf stream with two or more filters of identical type occupies more memory than allowed.

Parameters
maxSizeOfSingleDecompressedPdfStream the maximum allowed size which can be occupied by a single decompressed pdf stream.
Returns
this MemoryLimitsAwareHandler instance.