Products Support Documentation Download
rdmtfsapi.h File Reference

Header for the Transactional File Server (TFS) API. More...

#include "rdmtfstypes.h"
#include "rdmtypes.h"
Include dependency graph for rdmtfsapi.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

RDM_RETCODE rdm_tfsAllocDatabase (RDM_TFS tfs, RDM_DB *pDb)
 Allocate memory for a new RDM db. More...
 
RDM_RETCODE rdm_tfsAllocEncrypt (RDM_TFS hTFS, const RDM_TCHAR_T *passcode, RDM_ENCRYPT *pEnc)
 Allocate an encryption context. More...
 
RDM_RETCODE rdm_tfsDisableListener (RDM_TFS hTFS)
 Stop the listener process for the TFS. More...
 
RDM_RETCODE rdm_tfsDropDatabase (RDM_TFS tfs, const RDM_TCHAR_T *dbNameSpec)
 Drop the specified database. More...
 
RDM_RETCODE rdm_tfsEnableListener (RDM_TFS hTFS)
 Starts the listener process for the TFS. More...
 
RDM_RETCODE rdm_tfsFree (RDM_TFS hTFS)
 Terminate a TFS service. 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_tfsGetOption (RDM_TFS tfs, const RDM_TCHAR_T *keyword, RDM_TCHAR_T *optValue, size_t bytesIn, size_t *bytesOut)
 Get a single TFS option into a string. More...
 
RDM_RETCODE rdm_tfsGetOptions (RDM_TFS tfs, RDM_TCHAR_T *optString, size_t bytesIn, size_t *bytesOut)
 Get TFS options. 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...
 
RDM_RETCODE rdm_tfsSetOption (RDM_TFS tfs, const RDM_TCHAR_T *keyword, const RDM_TCHAR_T *strValue)
 Set a single TFS option from a string. More...
 
RDM_RETCODE rdm_tfsSetOptions (RDM_TFS tfs, const RDM_TCHAR_T *optString)
 Set TFS options. More...
 

Detailed Description

Header for the Transactional File Server (TFS) API.

Definition in file rdmtfsapi.h.