Connect/disconnect pool

Return current configuration object

pFCREPLConfig GetConfig() { return (pFCREPLConfig)((pRCESConn)this)->GetConfig(); };

EMBEDDED YES

YES

Indicates if the Replication Manager agent will be standalone or embedded in a DBEngine.

LOG_FILE <file name>

NULL

Null means no log.

MEMPHIS_TYPE <CTREE> or <ODBC>

<CTREE>

MEMPHIS_SERVER_NAME <master server name>

<MEMPHIS>

MEMPHIS_SQL_PORT <master server SQL port>

<6597>

MEMPHIS_HOST <master server host>

<>

MEMPHIS_DATABASE <master database name>

<MEMPHIS>

MEMPHIS_MAX_CONN <maximum master connection count>

<8>

QUEUE_THREAD_COUNT <queue thread count for the non-ctree consumer>

4

LOCAL_CTREE_CHECK <YES or NO>

YES

CTREE_CHECK_MASK <File mask to be checked as c-tree file>

<*.dat;*.idx>

Supported multiple masks delimited by [;].

DBENGINE_CHECK <YES for automatic scan and track c-tree DBEngine changes>

YES

VERBOSE_SCAN_COUNT <frequency of scan files to be displayed> or <0>

<0>

VERBOSE_SHOW_NAME <YES for display file name on scan message displayed> or <NO>

<NO>

LOCAL_CONN_POOL_SIZE <local connection pool size>

50

SCAN_THREAD_COUNT <scan thread count>

50

ADV_FULL_MASK <YES for enable the full mask advanced filter by the callback>

NO

MASTER_CONN_POOL_SIZE = <master connection pool size>

10

LOAD_THREAD_COUNT = <load thread count to insert the filesystem blocks into the master DB>

4

STANDALONE_AGENT <YES for standalone agent only>

<YES>

TRACE NO

NO

Enable the tracing for the Replication Manager agent.

DBENGINE_CONN_BY_IP <YES | NO | ip address>

<NO>

Defines how the DBEngine should be connected by the Replication Manager.

ACCEPT_CONN <YES | NO>

<YES>

This is a flag indicating if the agent accept external connection or not.

JVM_LIB <JBM library path>

<>

If embedded in a SQL server, use the JVM from SQL.

WEB_TRACE NO

NO (enable the tracing for the web server)

INACTIVE_TIMEOUT <pool inactive timeout in seconds>

60 (seconds)

MEMPHIS_CONN_POOL_SIZE <memphis connection pool size>

10

CHECKSTATUS_WAIT <seconds to wait for the next DBEngine Status check>

30 (seconds)

DEBUG_WEB_API <YES for WEB API debug>

NO

ARCHIVE_ACTION <number of days to wait before archiving ACTION events>

1

ARCHIVE_LOG <number of days to wait before archiving LOG events>

7

ARCHIVE_REPLSTAT <number of days to wait before archiving REPLSTAT events>

7

CHECK_DBENGINE_THRD_COUNT <number of threads to be used for checking DBEngines status>

10

CHECK_REPLPLAN_THRD_COUNT <number of threads to be used for checking replication plan status>

5

Local agent type (DBEngine, ReplStudio, ReplAgent, WebServer, and so forth)

FCREPLLogAgent GetAgentType() { return (FCREPLLogAgent)((pRCESConfig)this)->GetAgentType(); };

Retrieve a configuration value by its name

const char *GetParam(const char *key) { return ((pRCESConfig)this)->GetParam(key); };

Retrieve a configuration value by its code

const char *GetParam(RCESParam param) { return ((pRCESConfig)this)->GetParam(param); };

Retrieve the username and password from an authentication .set file

void GetUser(char *authFileName, char **userName, char **userPass) { ((pRCESConfig)this)->GetUser(authFileName, userName, userPass); };

Check if the provided configuration object matches the current one

bool Matches(pFCConfig config);

Retrieve an advanced configuration by its KEY

const char *GetParam(const char *key);

Retrieve an advanced configuration by its param

const char *GetParam(RCESParam param);

Return if connection will check for local FairCom files: LOCAL_CTREE_CHECK

bool HasCtreeLocalCheck();

Return if file system scan is set to be executed in multi-threaded mode: SCAN_THREAD_COUNT

bool HasMultiThreadScan();

Return if file system scan has a full mask advanced filter by the callback: ADV_FULL_MASK

bool IsAdvFullMask();

Printf the configuration options

static void PrintfConfigOptions();

Retrieve the username and password

void GetUser(char *authFileName, char **userName, char **userPass);

Local DBEngine identification

int GetLocalDBEngineID();

Local agent identification

int GetAgentID() { return _agentID; };

Return if current agent is embedded into a DBEngine

bool IsEmbedded();

Local library handle (can be mtclient.dll or ctreedbs.dll handles)

void *GetLocalLibHandle();

Local logger

pRCESLogger GetLoggerLocal();

Agent type

RCESLogAgent GetAgentType();

Local agent name

const char *GetAgentName();

Local server name

const char *GetLocalServerName();

Local user name

const char *GetLocalUserName();

Local user password

const char *GetLocalUserPass();

Return if WebAPIDebug is enabled

bool IsWebAPIDebug();

Memphis Volume identification

int GetMemphisDBVolID();

Memphis directory

const char *GetMemphisDBDir();

Local directory path

const char *GetLocalPath();

Retrieve a path buffer populated with the local directory

char *GetLocalPathBuffer();

Master conn pool

FCPool<RCESMasterConnPooled> *GetMasterConnPool();

Return if local server is shutting down

bool IsShutDown();

Return if Trace is active

bool IsTrace();

Return if WebTrace is active

bool IsWebTrace();

Return if its local agent is executing a FileSystem scan

bool HasFSScan();

Memphis OpSystem identification

int GetMasterOS();

Local OpSystem identification

int GetAgentOS();

Return if local DBEngine is Memphis

bool IsMasterAgent();

Return is automatic scan and track FairCom DBEngine changes: DBENGINE_CHECK

bool IsCheckDBEngine();

Memphis database user login

const char *GetMasterLogin();

Memphis database password

const char *GetMasterPass();

Plan manager hash

FCHashTable<RCESReplPlanMngr> *GetReplPlanMngrHash();

Engine manager hash

FCHashTable<RCESDBEngineMngr> *GetDBEngineMngrHash();

Failover hash

FCHashTable<RCESFailOverMngr> *GetFailOverMngrHash();

Repl agent data hash

FCHashTable<ReplicationAgentData> *GetReplAgentDataHash();

Repl monitor data hash

FCHashTable<ReplicationMonitorData> *GetReplMonitorDataHash();

Repl dump data hash

FCHashTable<ReplicationDumpData> *GetReplDumpDataHash();

Platform

RCESPlatform GetPlatform();

Retrieve the Platform name

const char *GetPlatformName();

Retrieve accept connection

bool GetAcceptConn();

Retrieve read-only

RCESReadOnly GetReadOnly();

Retrieve the JVM lib path

const char *GetJVMLibPath();

Clean up global FailOver manager hash

void CleanFailOverMngrHash();

Retrieve ISConnected flag

bool IsConnected();

Local agent type (DBEngine, ReplStudio, ReplAgent, WebServer, and so forth)

void SetAgentType(FCREPLLogAgent agentType) { ((pRCESConfig)this)->SetAgentType((RCESLogAgent)agentType); };

Local agent name

void SetAgentName(const char *agentName) { ((pRCESConfig)this)->SetAgentName(agentName); };

Local server name

void SetLocalServerName(const char *localServerName) { ((pRCESConfig)this)->SetLocalServerName(localServerName); };

Local user name

void SetLocalUserName(const char *localUserName) { ((pRCESConfig)this)->SetLocalUserName(localUserName); };

Local user password

void SetLocalUserPass(const char *localUserPass) { ((pRCESConfig)this)->SetLocalUserPass(localUserPass); };

Memphis directory

void SetMemphisDBDir(const char *dbDir) { ((pRCESConfig)this)->SetMemphisDBDir(dbDir); };

Local directory path

void SetLocalPath(const char *localPath) { ((pRCESConfig)this)->SetLocalPath(localPath); };

Memphis database user login

void SetMasterLogin(const char *masterLogin) { ((pRCESConfig)this)->SetMasterLogin(masterLogin); };

Memphis database password

void SetMasterPass(const char *masterPass) { ((pRCESConfig)this)->SetMasterPass(masterPass); };

Memphis OpSystem identification

void SetMasterOS( int masterOS );

Local OpSystem identification

void SetAgentOS( int agentOS );

Local DBEngine identification

void SetLocalDBEngineID( int localDBEngineID );

Local agent identification

void SetAgentID( int agentID );

Set if current agent is embedded to a DBEngine

void SetIsEmbedded( bool isEmbedded );

Local library handle (can be mtclient.dll or ctreedbs.dll handles)

void SetLocalLibHandle( void *localLibHandle );

Set agent type

void SetAgentType(RCESLogAgent agentType);

Set agent name

void SetAgentName(const char *agentName);

Set local server name

void SetLocalServerName(const char *localServerName);

Set local user name

void SetLocalUserName(const char *localUserName);

Set local user password

void SetLocalUserPass(const char *localUserPass);

Return if WebAPIDebug is enabled

void SetWebAPIDebug( bool enable );

Memphis volume identification

void SetMemphisDBVolID( int volumeID );

Set Memphis DB directory

void SetMemphisDBDir(const char *dbDir);

Set local path

void SetLocalPath(const char *localPath);

Set master connection pool

void SetMasterConnPool(FCPool<RCESMasterConnPooled> *masterConnPool);

Trace status

void SetTrace( bool isTrace );

Web trace status

void SetWebTrace( bool webTrace );

FilSystem scan

void SetFSScan(bool fsScan);

Set master login

void SetMasterLogin(const char *masterLogin);

Set master password

void SetMasterPass(const char *masterPass);

Set DB engine manager hash

void SetDBEngineMngrHash(FCHashTable<RCESDBEngineMngr> *dbEngineMngrHash);

Set accept connection flag

void SetAcceptConn(bool acceptConn);

Set read only

void SetJVMLibPath(const char *jvmLibPath);

Set JVM library path

void SetJVMLibPath(const char *jvmLibPath);

Set is connected path

void SetIsConnected(bool isConnected);

config [IN]

Configuration object

replConn [OUT]

New replication connection object

errorMsg [OUT]

Error message buffer

masterHost [IN]

Master server host

masterServerName [IN]

Master server name

masterSQLPort [IN]

Master SQL port

masterDatabase [IN]

Master database name

masterLogin [IN]

Master database user login

masterPass [IN]

Master database user password

replConn [OUT]

New replication connection handle

errorMsg [OUT]

Error message buffer

replConn [IN]

Replication connection handle