Skip to main content

Site

Sites for the C++ Replication API

Abstract

An action can be pushed from the central point of control (<FC_PROD_REPLICATIOM_MGR>) to any node in the Site and executed by that node.

The site class represents all the Hardware (computer systems such as servers, tablets, and phones) that are eligible for replication. A system must have a Replication Agent installed to be eligible for replication. The site includes hardware that is connected by local networks, remote networks, the cloud, and so forth.

Class

FCREPLSite

Represents the top level of the Replication Manager hierarchy. Could represent the local network, cloud, remote data center, and so forth.

Getters

Getters are not applicable.

Inherited getters

Table 1. Inherited getters

Site identification

int GetID();

Site name

const char *GetName();

Site type

const char *GetType();

Site description

const char *GetDescription();



Setters

Table 2. Setters

Site name

void SetName(const char *name) { ((pRCESSite)this)->SetName(name); };

Site type

void SetType(const char *type) { ((pRCESSite)this)->SetType(type); };

Site description

void SetDescription(const char *description) { ((pRCESSite)this)->SetDescription(description); };



Inherited setters

Table 3. Inherited setters

Site identification

void SetID(int id);

Site name

void SetName(const char *name);

Site type

void SetType(const char *type);

Site description

void SetDescription(const char *description);



Retrieve all the site entity objects

Prototype

FCREPL_API int fcReplGetSites(pFCREPLConn replConn, ppFCREPLSite *siteList, int *siteCount);

Parameters

Table 4. Parameters

Parameter

Description

replConn [IN]

Replication connection handle

siteList [OUT]

Site entity list

siteCount [OUT]

Number of site entities in the list



Return

Error code

Retrieve the site entity object by its name.

Prototype

FCREPL_API int fcReplGetSite(pFCREPLConn replConn, const char *name, ppFCREPLSite site);

Parameters

Table 5. Parameters

Parameter

Description

replConn [IN]

Replication connection handle

name [IN]

Site name to be retrieved

site [OUT]

Site entity retrieved



Return

Error code

Add a site entity to the database. If there already is a site with the given name, update the existing record.

Prototype

FCREPL_API int fcReplPersistSite(pFCREPLConn replConn, pFCREPLSite site);

Parameters

Table 6. Parameters

Parameter

Description

replConn [IN]

Replication connection handle

site [IN]

Site entity to be persisted



Return

Error code

Delete the site by its identification.

Protocol

FCREPL_API int fcReplRemoveSite(pFCREPLConn replConn, int siteID, bool recursive);

Parameters

Table 7. Parameters

Parameter

Description

replConn [IN]

Replication connection handle

siteID [IN]

Site identification to be removed

recursive [IN]

Recursive flag



Return

Error code