TFS Instantiation
Collaboration diagram for TFS Instantiation:
|
Functions | |
| RDM_RETCODE | rdm_rdmAllocTFS (RDM_TFS *phTFS) |
| Allocate a TFS handle. More... | |
| RDM_RETCODE | rdm_rdmAllocTFSWithMemBuf (void *pMemBuf, size_t memSize, RDM_TFS *phTFS) |
| Allocate a TFS handle with an associated memory buffer. More... | |
Detailed Description
The TFS instantiation API. The functions here are located in Transactional File Server Interface Library. Linker option:
-lrdmtfsFunction Documentation
◆ rdm_rdmAllocTFS()
| RDM_RETCODE rdm_rdmAllocTFS | ( | RDM_TFS * | phTFS | ) |
#include <rdmrdmapi.h>
Allocate a TFS handle.
Allocate the TFS handle and use the of malloc for memory requests.
- Return values
-
sOKAY Normal, successful return. eNOMEMORY Out of memory.
- See also
- rdm_rdmAllocTFSWithMemBuf
- rdm_tfsEnableListener
- rdm_tfsPing
- rdm_tfsAllocEncrypt
- rdm_tfsSetOptions
- rdm_tfsAllocDatabase
- rdm_tfsDropDatabase
- rdm_tfsKillAllRemoteConnections
- rdm_tfsGetMemUsage
- rdm_tfsFree
- Parameters
-
[out] phTFS TFS handle
- Examples
- c-core/01_helloworld_c/core01Example_main.c, c-core/12_core/core12Example_main.c, c-core/14_core/core14Example_main.c, c-core/15_core/core15Example_main.c, c-core/16_core/core16Example_main.c, c-core/17_core/core17Example_main.c, c-core/18_core/core18Example_main.c, c-core/19_core/core19Example_main.c, c-core/31_core/core31Example_main.c, c-core/32_core/core32Example_main.c, c-core/33_core/core33Example_main.c, c-core/34_core/core34Example_main.c, c-odbc/01_helloworld_odbc/odbc01Example_main.c, tfs/rdmAllocTFS.c, tfsrdbc/rdbcTfsAlloc.c, and tfsrdbc/rdbcTfsAllocDefault.c.
◆ rdm_rdmAllocTFSWithMemBuf()
| RDM_RETCODE rdm_rdmAllocTFSWithMemBuf | ( | void * | pMemBuf, |
| size_t | memSize, | ||
| RDM_TFS * | phTFS | ||
| ) |
#include <rdmrdmapi.h>
Allocate a TFS handle with an associated memory buffer.
Allocate the TFS handle and use the associated memory buffer instead of malloc for memory requests. If no memory buffer is specified and memSize is greater than 0 memSize will serve as the memory limit for the TFS, but memory will be obtained via calls to malloc.
- Note
- Until further notice the buffer provided and the size requested will be used for all TFS handles. This function should only be used once for allocating the first TFS handle. This semantic is subject to change.
- Return values
-
sOKAY Normal, successful return. eNOMEMORY Out of memory.
- See also
- rdm_rdmAllocTFS
- rdm_tfsGetMemUsage
- Parameters
-
[in] pMemBuf The memory buffer to use instead of getting memory from malloc [in] memSize The memory size limit (size of pMemBuf if pMemBuf is not NULL) [out] phTFS TFS handle