Uncategorized

Function:  get_hibernation

Purpose:

Returns the current hibernation state of the ICE XL Publisher. The publisher enters hibernation mode when idle to reduce resource usage; this function lets you check whether it is currently active or hibernating.

Function Signature:

get_hibernation() -> str

Parameters:

Name Type Required Default Description
(none) — — — This function does not take any arguments.

Return:

Returns the current state as a string — 'True' if hibernating, 'False' if active.

Default Behavior & Internals:

  • The publisher enters hibernation automatically when no data functions are running and no active subscriptions are held.
  • It automatically wakes upon the next data request.
  • Active subscriptions (e.g., subscribe=True) prevent the publisher from entering hibernation.

Notes:

  • Does not modify state — it is a passive check.
  • Calling a data function will automatically resume the publisher if it is hibernating.