THPDFParserBudgetStatistics Record

Reports parser budget limits, token totals, peaks, breaches, and session validity

Declaration

THPDFParserBudgetStatistics= record
  MaxTokenBytes: Integer;
  MaxTotalTokens: Int64;
  MaxContainerItems: Integer;
  MaxBadTokens: Integer;
  TokenCount: Int64;
  BadTokenCount: Int64;
  PeakTokenBytes: Integer;
  PeakContainerItems: Integer;
  LimitBreachCount: Int64;
  LastLimit: THPDFParserBudgetLimit;
  LastObserved: Int64;
  LastMaximum: Int64;
  Exceeded: boolean;
  Valid: boolean;
end;

Unit

HPDFDoc

Fields

FieldPurpose
MaxTokenBytesConfigured cap on total token bytes for the session
MaxTotalTokensConfigured cap on the number of tokens scanned
MaxContainerItemsConfigured cap on items inside one array or dictionary container
MaxBadTokensConfigured cap on malformed tokens tolerated per session
TokenCountTokens consumed so far in the session
BadTokenCountMalformed tokens encountered so far
PeakTokenBytesLargest single token byte size observed
PeakContainerItemsLargest container item count observed
LimitBreachCountNumber of times any budget limit was hit during the session
LastLimitWhich limit kind produced the most recent breach (THPDFParserBudgetLimit)
LastObservedObserved value of the most recent breach
LastMaximumConfigured maximum of the most recent breach
ExceededTrue once any limit has been exceeded and the load was aborted
ValidTrue while a budget-tracked parser session is active; GetLastParserBudgetStatistics returns this value

Usage notes

Related APIs