Redundant Host API

An RH infrastructure that implements this function shall return the list of RH Instance IDs only for those RH Systems that it services.

If multiple RH infrastructures are present on the current host, an intermediate layer of functionality between the application and infrastructures may be defined, that implements this function. If this is the case, that intermediate layer should consolidate together the lists of RH Instance IDs returned by separate RH infrastructures and present the consolidated list to the application as the result of the call to RhEnumerateInstances. The intermediate layer may change the RH Instance IDs returned by separate infrastructures, qualifying them with textual identifiers of the corresponding infrastructures.

6.2.2.2RhOpen

Prototype:

HSI_STATUS

RhOpen(

IN char *InstanceId OPTIONAL,

OUT RH_HANDLE *pHandle );

Arguments:

 

InstanceId -

an RH Instance ID that chooses a specific RH system instance in the case

 

where the calling host is attached to more than one RH system. This is

 

an implementation-defined string. This parameter can be omitted

 

(specified as NULL). In that case, the caller will be using the RH system,

 

selected by default (defined by the first RH Instance ID, returned by

 

RhEnumerateInstances).

pHandle –

pointer to the variable that holds the connection handle to the

 

infrastructure of type RH_HANDLE. This type is generally opaque, but

 

is typedef’ed to the handle type for the target OS.

Return Value:

 

HSI_STATUS_SUCCESS

returned in the case of success

HSI_STATUS_INVALID_PARAMETER

invalid or unrecognized RH Instance ID

HSI_STATUS_NOT_SUPPORTED -

if the specified RH system is not available

Other, implementation-defined HSI_STATUS values

returned if other errors occurred during execution of this function

Synopsis:

This function initializes the connection between the application program and the RH infrastructure. It should be called in the beginning to initialize communication between the application and the infrastructure. This function creates a handle to the RH system and returns it to the application program. This handle is to be used in subsequent requests.

High Availability Software for the Intel® NetStructureTM ZT 4901 Technical Product Specification

43

Page 43
Image 43
Intel ZT 4901 manual RhOpen Char *InstanceId Optional OUT Rhhandle *pHandle, RhEnumerateInstances