OpenHiva::Ready

Description

Checks the OpenHiva framework status.

Prototype

bool OpenHiva::Ready()

Parameters

None

Returns

The return value is of the Boolean type. If the process is enabled, true is returned. If the node is shut down or fails to be initialized, false is returned.

Usage

This interface is used to check whether the node status in the process is normal.

Precautions

  • Reentrant, synchronous interface.
  • If OpenHiva::Init is not invoked for initialization or OpenHiva::Init fails to be invoked, OpenHiva::Ready returns false. If OpenHiva::Init is invoked successfully, OpenHiva::Ready returns true.
  • After OpenHiva::Shutdown is invoked, OpenHiva::Ready returns false.