Uncategorized

Function:  set_hibernation(val)

Purpose:

Manually control whether the ICE XL Publisher is allowed to enter hibernation mode. Useful to force the publisher to stay active (e.g., during scheduled workflows or dashboards) or allow it to conserve resources when idle.

Function Signature:

set_hibernation(val: bool) -> None

Parameters:

Name Type Required Default Description
val bool Yes — Set to True to allow hibernation; False to keep the publisher active.

Default Behavior & Internals:

  • By default the publisher hibernates automatically when idle.
  • True enables hibernation when the publisher is not in use; False prevents it from hibernating (keeps it active).
  • Disabling hibernation can help with long dashboards, repeated API calls, or time-sensitive workflows.

Notes:

  • Only affects automatic hibernation behavior — it does not stop the publisher.
  • Always use bool values (True/False); strings or integers may not be supported.