Products Support Documentation Download
TFS Functions
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_tfsGetConnections (RDM_TFS hTFS, const RDM_TCHAR_T *uri, const RDM_TCHAR_T *const **ppszUserIDs, uint32_t *puUserCount)
 Get the list of users connected to the TFS. More...
 
RDM_RETCODE rdm_tfsGetEncrypt (RDM_TFS hTFS, RDM_ENCRYPT *pEncCtx)
 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 RDM_TCHAR_T *uri)
 Kill all the TFS connections. More...
 
RDM_RETCODE rdm_tfsKillRemoteConnection (RDM_TFS hTFS, const RDM_TCHAR_T *uri, const RDM_TCHAR_T *dbUserID)
 Kill the TFS connection associated with a user. More...
 
RDM_RETCODE rdm_tfsPing (RDM_TFS hTFS, const RDM_TCHAR_T *uri)
 Ping a remote TFS. More...
 

Detailed Description

The TFS function API. The functions here are located in Transactional File Server Interface Library (TFS). 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
sOKAYNormal, successful return.
See also
rdm_tfsEnableListener
rdm_tfsFree
Parameters
[in]hTFSTFS handle

◆ 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
sOKAYNormal, successful return.
See also
rdm_rdmAllocTFS
rdm_tfsSetOptions
rdm_tfsDisableListener
rdm_tfsFree
Parameters
[in]hTFSTFS handle

◆ rdm_tfsGetConnections()

RDM_RETCODE rdm_tfsGetConnections ( RDM_TFS  hTFS,
const RDM_TCHAR_T uri,
const RDM_TCHAR_T *const **  ppszUserIDs,
uint32_t *  puUserCount 
)

#include <rdmtfsapi.h>

Get the list of users connected to the TFS.

This function returns an array of user IDs, each of which represents a TFS connection.

Return values
sOKAYNormal, successful return.
See also
rdm_rdmAllocTFS
rdm_tfsKillRemoteConnection
rdm_tfsFree
Parameters
[in]hTFSTFS handle
[in]uriConnection URI for remote TFS
[out]ppszUserIDsArray of user IDs
[out]puUserCountNumber of user IDs

◆ rdm_tfsGetEncrypt()

RDM_RETCODE rdm_tfsGetEncrypt ( RDM_TFS  hTFS,
RDM_ENCRYPT pEncCtx 
)

#include <rdmtfsapi.h>

Get the encryption context from a TFS.

Return values
sOKAYNormal, successful return.
See also
rdm_rdmAllocTFS
rdm_tfsAllocEncrypt
rdm_tfsFree
Parameters
[in]hTFSTFS handle
[out]pEncCtxencryption context

◆ 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
sOKAYNormal, successful return.
See also
rdm_rdmAllocTFS
rdm_rdmAllocTFSWithMemBuf
Parameters
[in]tfsTFS handle
[out]curr_usageThe current memory usage
[out]max_usageThe maximum memory usage

◆ 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
sOKAYNormal, successful return.
See also
rdm_rdmAllocTFS
rdm_tfsFree
Parameters
[in]hTFSTFS handle
[out]pMajorVmajor version
[out]pMinorVminor version
[out]pTfsTypeTFS type

◆ rdm_tfsKillAllRemoteConnections()

RDM_RETCODE rdm_tfsKillAllRemoteConnections ( RDM_TFS  tfs,
const RDM_TCHAR_T uri 
)

#include <rdmtfsapi.h>

Kill all the TFS connections.

Return values
sOKAYNormal, successful return.
See also
rdm_rdmAllocTFS
rdm_tfsGetConnections
rdm_tfsKillRemoteConnection
rdm_tfsPing
rdm_tfsFree
Parameters
[in]tfsTFS handle
[in]uriConnection URI for TFSR

◆ rdm_tfsKillRemoteConnection()

RDM_RETCODE rdm_tfsKillRemoteConnection ( RDM_TFS  hTFS,
const RDM_TCHAR_T uri,
const RDM_TCHAR_T dbUserID 
)

#include <rdmtfsapi.h>

Kill the TFS connection associated with a user.

Return values
sOKAYNormal, successful return.
See also
rdm_tfsKillAllRemoteConnections
rdm_tfsPing
Parameters
[in]hTFSTFS handle
[in]uriConnection URI for TFSR
[in]dbUserIDUser whose connection to kill

◆ rdm_tfsPing()

RDM_RETCODE rdm_tfsPing ( RDM_TFS  hTFS,
const RDM_TCHAR_T 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
sOKAYNormal, successful return.
See also
rdm_rdmAllocTFS
rdm_tfsKillAllRemoteConnections
Parameters
[in]hTFSTFS handle
[in]uriConnection URI for TFSR