Home2L - C/C++ API  v1.2-2-ga4fe (2023-04-15)
Smart Tools for a Private Home
Directory Services

Description

Querying local metadata directories (for shells or service tools)

Directory operations and host/driver/resource lookup.

Collaboration diagram for Directory Services:

Hosts ...

int RcGetHosts ()
 Get number of known hosts.
 
CRcHost * RcGetHost (int n)
 Get reference to host n, 0 <= n < number of hosts.
 
CRcHost * RcGetHost (const char *id)
 Lookup host by its ID.
 
const char * RcGetHostId (CRcHost *host)
 Get textual ID of 'host'.
 
static const char * RcLocalHostId ()
 Get the ID of the local instance.
 

Drivers (local) ...

int RcGetDrivers ()
 
CRcDriverRcGetDriver (int n)
 
CRcDriverRcGetDriver (const char *lid)
 
const char * RcGetDriverId (CRcDriver *cur)
 

Resources ...

int RcLockHostResources (CRcHost *host)
 Query number of resources for a remote host. More...
 
CResourceRcGetHostResource (CRcHost *host, int n)
 
void RcUnlockHostResources (CRcHost *host)
 
int RcLockDriverResources (CRcDriver *driver)
 Query the number of resources for a local driver. More...
 
CResourceRcGetDriverResource (CRcDriver *driver, int n)
 
void RcUnlockDriverResources (CRcDriver *driver)
 

Subscribers ...

int RcLockSubscribers ()
 Query the number of existing subscribers and lock the subscriber database. More...
 
CRcSubscriberRcGetSubscriber (int n)
 
void RcUnlockSubscribers ()
 

Function Documentation

◆ RcLockHostResources()

int RcLockHostResources ( CRcHost *  host)

Query number of resources for a remote host.

The set is locked internally, meaning that no registration of new resources is possible until 'RcUnlockHostResources' is called! Only presently known resources are returned, no network queries are performed.

◆ RcLockDriverResources()

int RcLockDriverResources ( CRcDriver driver)

Query the number of resources for a local driver.

The set is locked internally, meaning that no registration of new resources is possible until 'RcUnlockDriverResources' is called!

◆ RcLockSubscribers()

int RcLockSubscribers ( )

Query the number of existing subscribers and lock the subscriber database.

During the locked state, other operations are also locked out, so the caller should use this carefully and unlock as soon as possible.