Collaboration diagram for TFS Functions:

Functions
RDM_RETCODE	rdm_tfsDisableListener (RDM_TFS hTFS)
	Stop the listener process for the TFS. More...

RDM_RETCODE	rdm_tfsEnableListener (RDM_TFS hTFS)
	Starts the listener process for the TFS. More...

RDM_RETCODE	rdm_tfsGetMemUsage (RDM_TFS tfs, size_t curr_usage, size_t max_usage)
	Get memory usage associated with the TFS. More...

RDM_RETCODE	rdm_tfsGetInfo (RDM_TFS hTFS, const char uri, const char optString, size_t bufSizeInBytes, char buffer, size_t numBytesWritten)
	Get information about the TFS. More...

RDM_RETCODE	rdm_tfsGetEncrypt (RDM_TFS tfs, RDM_ENCRYPT_C *enc)
	Get the encryption context from a TFS. More...

RDM_RETCODE	rdm_tfsGetVersion (RDM_TFS hTFS, uint16_t pMajorV, uint16_t pMinorV, TFS_TYPE *pTfsType)
	Get the TFS type and version. More...

RDM_RETCODE	rdm_tfsKillAllRemoteConnections (RDM_TFS tfs, const char *uri)
	Kill all the TFS connections. More...

RDM_RETCODE	rdm_tfsKillRemoteConnection (RDM_TFS hTFS, const char uri, const char dbUserID)
	Kill the TFS connection associated with a user. More...

RDM_RETCODE	rdm_tfsPing (RDM_TFS hTFS, const char *uri)
	Ping a remote TFS. More...

Detailed Description

The TFS function API. The functions here are located in Transactional File Server Interface Library. Linker option:

    -lrdmtfs

Function Documentation

rdm_tfsDisableListener()

RDM_RETCODE rdm_tfsDisableListener ( RDM_TFS hTFS )

#include <rdmtfsapi.h>

Stop the listener process for the TFS.

This function will stop the listener process for the specified TFS. Stopping the listener process prevents new remote connections to TFS from being processed.

Note: This function does not terminate remote connections to the TFS that have already been established.

Return values

sOKAY Normal, successful return.

See also: rdm_tfsEnableListener; rdm_tfsFree

Parameters

[in] hTFS TFS handle

Examples: core38Example_main.c.

rdm_tfsEnableListener()

RDM_RETCODE rdm_tfsEnableListener ( RDM_TFS hTFS )

#include <rdmtfsapi.h>

Starts the listener process for the TFS.

This function will enable the listener process for the specified TFS. The listener process allows new remote connections to TFS to be processed.

Return values

sOKAY Normal, successful return.

See also: rdm_rdmAllocTFS; rdm_tfsSetOptions; rdm_tfsDisableListener; rdm_tfsFree

Parameters

[in] hTFS TFS handle

rdm_tfsGetEncrypt()

RDM_RETCODE rdm_tfsGetEncrypt	(	RDM_TFS	tfs,
		RDM_ENCRYPT_C *	enc
	)

#include <rdmtfsapi.h>

Get the encryption context from a TFS.

Return values

sOKAY Normal, successful return.

See also: rdm_rdmAllocTFS; rdm_tfsAllocEncrypt; rdm_tfsFree

Parameters

[in]	tfs	TFS handle
[out]	enc	encryption context

rdm_tfsGetInfo()

RDM_RETCODE rdm_tfsGetInfo	(	RDM_TFS	hTFS,
		const char *	uri,
		const char *	optString,
		size_t	bufSizeInBytes,
		char *	buffer,
		size_t *	numBytesWritten
	)

#include <rdmtfsapi.h>

Get information about the TFS.

This function returns information in various categories about the TFS. The information will be returned in JSON format via the provided buffer.

The valid key/value boolean options are:

Key	Description
databases	If true, list the databases names available in the docroot directory.
users	If true, list the current users accessing the TFS.
version	If true, list the version info for the TFS

The optString is a semicolon delimited list of keys to specifiy the information to be retrieved in the buffer. For example, "databases=true;users=true" will retrieve database and user names.

Return values

sOKAY	Normal, successful return.
sTRUNCATE	Result is truncated.

See also: rdm_rdmAllocTFS; rdm_tfsFree

Parameters

[in]	hTFS	TFS handle
[in]	uri	Connection URI for Remote TFS
[in]	optString	Option string to specify what information to retrieve
[in]	bufSizeInBytes	size of buffer
[out]	buffer	A buffer to put TFS information (in JSON format)
[out]	numBytesWritten	Number of bytes written to buffer

rdm_tfsGetMemUsage()

RDM_RETCODE rdm_tfsGetMemUsage	(	RDM_TFS	tfs,
		size_t *	curr_usage,
		size_t *	max_usage
	)

#include <rdmtfsapi.h>

Get memory usage associated with the TFS.

This function returns the current and maximum memory usage of the TFS and all database and database objects associated with the TFS.

Note: Untill further notice this function will report memory usage for all TFS handles and its databases. This semantic is subject to change.

Return values

sOKAY Normal, successful return.

See also: rdm_rdmAllocTFS; rdm_rdmAllocTFSWithMemBuf

Parameters

[in]	tfs	TFS handle
[out]	curr_usage	The current memory usage
[out]	max_usage	The maximum memory usage

Examples: cpp50Example_main.cpp.

rdm_tfsGetVersion()

RDM_RETCODE rdm_tfsGetVersion	(	RDM_TFS	hTFS,
		uint16_t *	pMajorV,
		uint16_t *	pMinorV,
		TFS_TYPE *	pTfsType
	)

#include <rdmtfsapi.h>

Get the TFS type and version.

This function will obtain the type and version of a specified TFS

Return values

sOKAY Normal, successful return.

See also: rdm_rdmAllocTFS; rdm_tfsFree

Parameters

[in]	hTFS	TFS handle
[out]	pMajorV	major version
[out]	pMinorV	minor version
[out]	pTfsType	TFS type

rdm_tfsKillAllRemoteConnections()

RDM_RETCODE rdm_tfsKillAllRemoteConnections	(	RDM_TFS	tfs,
		const char *	uri
	)

#include <rdmtfsapi.h>

Kill all the TFS connections.

Return values

sOKAY Normal, successful return.

See also: rdm_rdmAllocTFS; rdm_tfsKillRemoteConnection; rdm_tfsPing; rdm_tfsFree

Parameters

[in]	tfs	TFS handle
[in]	uri	Connection URI for Remote TFS

Examples: core38Example_main.c.

rdm_tfsKillRemoteConnection()

RDM_RETCODE rdm_tfsKillRemoteConnection	(	RDM_TFS	hTFS,
		const char *	uri,
		const char *	dbUserID
	)

#include <rdmtfsapi.h>

Kill the TFS connection associated with a user.

Return values

sOKAY Normal, successful return.

See also: rdm_tfsKillAllRemoteConnections; rdm_tfsPing

Parameters

[in]	hTFS	TFS handle
[in]	uri	Connection URI for Remote TFS
[in]	dbUserID	User whose connection to kill

rdm_tfsPing()

RDM_RETCODE rdm_tfsPing	(	RDM_TFS	hTFS,
		const char *	uri
	)

#include <rdmtfsapi.h>

Ping a remote TFS.

This function will ping the TFS specified by the URI to see if the TFS is active.

Return values

sOKAY Normal, successful return.

See also: rdm_rdmAllocTFS; rdm_tfsKillAllRemoteConnections

Parameters

[in]	hTFS	TFS handle
[in]	uri	Connection URI for Remote TFS