Products Support Documentation Download
rdmtfsapi.h
Go to the documentation of this file.
1 /* ----------------------------------------------------------------------------
2  * Raima Database Manager
3  *
4  * Copyright (c) 2014 Raima Inc., All rights reserved.
5  *
6  * Use of this software, whether in source code format, or in executable,
7  * binary object code form, is governed by the Raima LICENSE which
8  * is fully described in the LICENSE.TXT file, included within this
9  * distribution of files.
10  * ----------------------------------------------------------------------------
11  */
12 
17 #if !defined(RDMTFSAPI_H_INCLUDED_)
18 #define RDMTFSAPI_H_INCLUDED_
19 
20 #if defined(__cplusplus) && !defined(CPP_HEADER_INCLUDED)
21 #error rdmtfsapi.h is only for C applications. Do not include it directly in C++ applications. Use cpp-rdmtfsapi.h instead
22 #endif
23 
24 #include "rdmtfstypes.h"
25 #include "rdmtypes.h"
26 
59 #if !defined(RDM_NO_UNICODE)
60 #define rdm_tfsAllocEncrypt RDM_T_FUNC(rdm_tfsAllocEncrypt)
61 #define rdm_tfsDropDatabase RDM_T_FUNC(rdm_tfsDropDatabase)
62 #define rdm_tfsGetConnections RDM_T_FUNC(rdm_tfsGetConnections)
63 #define rdm_tfsGetOption RDM_T_FUNC(rdm_tfsGetOption)
64 #define rdm_tfsGetOptions RDM_T_FUNC(rdm_tfsGetOptions)
65 #define rdm_tfsKillAllRemoteConnections RDM_T_FUNC(rdm_tfsKillAllRemoteConnections)
66 #define rdm_tfsKillRemoteConnection RDM_T_FUNC(rdm_tfsKillRemoteConnection)
67 #define rdm_tfsPing RDM_T_FUNC(rdm_tfsPing)
68 #define rdm_tfsSetIniValue RDM_T_FUNC(rdm_tfsSetIniValue)
69 #define rdm_tfsSetOption RDM_T_FUNC(rdm_tfsSetOption)
70 #define rdm_tfsSetOptions RDM_T_FUNC(rdm_tfsSetOptions)
71 #endif
72 
89 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_tfsAllocDatabase (
90  RDM_TFS tfs,
91  RDM_DB *pDb
92  );
93 
154 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_tfsAllocEncrypt (
155  RDM_TFS hTFS,
156  const RDM_TCHAR_T *passcode,
157  RDM_ENCRYPT *pEnc
158  );
159 
160 
175 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_tfsDisableListener (
176  RDM_TFS hTFS)
177 ;
178 
204 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_tfsDropDatabase (
205  RDM_TFS tfs,
206  const RDM_TCHAR_T *dbNameSpec
208  );
209 
210 
225 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_tfsEnableListener (
226  RDM_TFS hTFS)
227 ;
228 
237 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_tfsFree (
238  RDM_TFS hTFS)
239 ;
240 
257 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_tfsGetMemUsage (
258  RDM_TFS tfs,
259  size_t *curr_usage,
260  size_t *max_usage)
261 ;
262 
276 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_tfsGetConnections (
277  RDM_TFS hTFS,
278  const RDM_TCHAR_T *uri,
279  const RDM_TCHAR_T *const **ppszUserIDs,
280  uint32_t *puUserCount)
281 ;
282 
283 
294 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_tfsGetEncrypt (
295  RDM_TFS hTFS,
296  RDM_ENCRYPT *pEncCtx)
297 ;
298 
321 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_tfsGetOption (
322  RDM_TFS tfs,
323  const RDM_TCHAR_T *keyword,
324  RDM_TCHAR_T *optValue,
325  size_t bytesIn,
326  size_t *bytesOut)
327 ;
328 
351 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_tfsGetOptions (
352  RDM_TFS tfs,
353  RDM_TCHAR_T *optString,
354  size_t bytesIn,
355  size_t *bytesOut)
356 ;
357 
358 
370 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_tfsGetVersion (
371  RDM_TFS hTFS,
372  uint16_t *pMajorV,
373  uint16_t *pMinorV,
374  TFS_TYPE *pTfsType)
375 ;
376 
389 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_tfsKillAllRemoteConnections (
390  RDM_TFS tfs,
391  const RDM_TCHAR_T *uri)
392 ;
393 
403 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_tfsKillRemoteConnection (
404  RDM_TFS hTFS,
405  const RDM_TCHAR_T *uri,
406  const RDM_TCHAR_T *dbUserID)
407 ;
408 
421 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_tfsPing (
422  RDM_TFS hTFS,
423  const RDM_TCHAR_T *uri)
424 ;
425 
444 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_tfsSetOption (
445  RDM_TFS tfs,
446  const RDM_TCHAR_T *keyword,
447  const RDM_TCHAR_T *strValue)
448 ;
449 
468 RDM_EXPORT RDM_RETCODE EXTERNAL_FCN rdm_tfsSetOptions (
469  RDM_TFS tfs,
470  const RDM_TCHAR_T *optString)
471 ;
472 
473 #endif /* RDMTFSAPI_H_INCLUDED_ */
474 
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.
RDM_RETCODE rdm_tfsGetMemUsage(RDM_TFS tfs, size_t *curr_usage, size_t *max_usage)
Get memory usage associated with the TFS.
Header for the native RDM Runtime types.
RDM_RETCODE rdm_tfsEnableListener(RDM_TFS hTFS)
Starts the listener process for the TFS.
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.
RDM_RETCODE rdm_tfsDropDatabase(RDM_TFS tfs, const RDM_TCHAR_T *dbNameSpec)
Drop the specified database.
struct RDM_TFS_S * RDM_TFS
RDM TFS Handle.
Definition: rdmtfstypes.h:21
RDM_RETCODE rdm_tfsFree(RDM_TFS hTFS)
Terminate a TFS service.
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.
RDM_RETCODE
RDM status and error return codes.
RDM_RETCODE rdm_tfsSetOptions(RDM_TFS tfs, const RDM_TCHAR_T *optString)
Set TFS options.
RDM_RETCODE rdm_tfsKillAllRemoteConnections(RDM_TFS tfs, const RDM_TCHAR_T *uri)
Kill all the TFS connections.
RDM_RETCODE rdm_tfsPing(RDM_TFS hTFS, const RDM_TCHAR_T *uri)
Ping a remote TFS.
RDM_RETCODE rdm_tfsGetVersion(RDM_TFS hTFS, uint16_t *pMajorV, uint16_t *pMinorV, TFS_TYPE *pTfsType)
Get the TFS type and version.
RDM_RETCODE rdm_tfsGetEncrypt(RDM_TFS hTFS, RDM_ENCRYPT *pEncCtx)
Get the encryption context from a TFS.
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.
RDM_RETCODE rdm_tfsDisableListener(RDM_TFS hTFS)
Stop the listener process for the TFS.
struct RDM_DB_S * RDM_DB
Definition: rdmtypes.h:240
RDM_RETCODE rdm_tfsAllocEncrypt(RDM_TFS hTFS, const RDM_TCHAR_T *passcode, RDM_ENCRYPT *pEnc)
Allocate an encryption context.
TFS_TYPE
Definition: rdmtfstypes.h:24
RDM_RETCODE rdm_tfsAllocDatabase(RDM_TFS tfs, RDM_DB *pDb)
Allocate memory for a new RDM db.
Header for the Transactional File Server (TFS) types.
RDM_RETCODE rdm_tfsGetOptions(RDM_TFS tfs, RDM_TCHAR_T *optString, size_t bytesIn, size_t *bytesOut)
Get TFS options.
#define RDM_TCHAR_T
Definition: psptypes.h:134
struct RDM_ENCRYPT_S * RDM_ENCRYPT
Definition: psptypes.h:77