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:

Functions

RDM_RETCODE rdm_tfsAllocDatabase (RDM_TFS tfs, RDM_DB *pDb)
Allocate memory for a new RaimaDB db. More...
RDM_RETCODE rdm_tfsAllocEncrypt (RDM_TFS hTFS, const char *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 char *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_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_tfsGetOption (RDM_TFS tfs, const char *keyword, char *optValue, size_t bytesIn, size_t *bytesOut)
Get a single TFS option into a string. More...
RDM_RETCODE rdm_tfsGetOptions (RDM_TFS tfs, char *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 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...
RDM_RETCODE rdm_tfsSetOption (RDM_TFS tfs, const char *keyword, const char *strValue)
Set a single TFS option from a string. More...
RDM_RETCODE rdm_tfsSetOptions (RDM_TFS tfs, const char *optString)
Set TFS options. More...
RDM_RETCODE rdm_tfsGetCapability (RDM_TFS tfs, const char *name, bool *pvalue)
Get a TFS library capability. More...
RDM_RETCODE rdm_tfsInitialize (RDM_TFS tfs)
Initialize a RDM_TFS instance. More...
RDM_RETCODE rdm_tfsSetCertificate (RDM_TFS tfs, const char *certificate)
Set an SSL certificate for an RDM_TFS instance. More...
RDM_RETCODE rdm_tfsSetKey (RDM_TFS tfs, const char *private_key)
Set an SSL private key for an RDM_TFS instance. More...

Detailed Description

Header for the Transactional File Server (TFS) API.


Raima Database Manager

Copyright (c) 2014 Raima Inc., All rights reserved.

Use of this software, whether in source code format, or in executable, binary object code form, is governed by the Raima LICENSE which is fully described in the LICENSE.TXT file, included within this

distribution of files.