OpenClovis Logo

clCorTxnApi.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2002-2012 OpenClovis Solutions Inc. All Rights Reserved.
3  *
4  * This file is available under a commercial license from the
5  * copyright holder or the GNU General Public License Version 2.0.
6  *
7  * The source code for this program is not published or otherwise
8  * divested of its trade secrets, irrespective of what has been
9  * deposited with the U.S. Copyright office.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * General Public License for more details.
15  *
16  * For more information, see the file COPYING provided with this
17  * material.
18  */
19 /*******************************************************************************
20  * ModuleName : cor
21  * File : clCorTxnApi.h
22  *******************************************************************************/
23 
24 /*******************************************************************************
25  * Description :
26  *
27  * This file contains the transaction related APIs for COR.
28  *
29  *****************************************************************************/
30 
42 #ifndef _CL_COR_TXN_API_H_
43 #define _CL_COR_TXN_API_H_
44 
45 #ifdef __cplusplus
46 extern "C" {
47 #endif
48 
49 #include <clCommon.h>
50 #include <clTxnApi.h>
51 #include <clCorMetaData.h>
52 
53 /*********************************************************************************/
54 /******************************** COR APIs ***************************************/
55 /*********************************************************************************/
56 /* */
57 /* clCorTxnJobWalk */
58 /* clCorTxnSessionCommit */
59 /* clCorTxnSessionFinalize */
60 /* clCorTxnSessionCancel */
61 /* clCorTxnJobHandleToCorTxnIdGet */
62 /* clCorTxnIdTxnFree */
63 /* clCorTxnJobAttributeTypeGet */
64 /* clCorTxnJobSetParamsGet */
65 /* clCorTxnJobAttrPathGet */
66 /* clCorTxnJobOperationGet */
67 /* clCorTxnJobMoIdGet */
68 /* clCorTxnJobObjectHandleGet */
69 /* clCorTxnFirstJobGet */
70 /* clCorTxnLastJobGet */
71 /* clCorTxnNextJobGet */
72 /* clCorTxnPreviousJobGet */
73 /* clCorTxnFailedJobGet */
74 /* clCorTxnJobStatusSet */
75 /* clCorTxnJobStatusGet */
76 /* clCorTxnJobDefnHandleUpdate */
77 /* */
78 /*********************************************************************************/
79 
80 /******************************************************************************
81  * Constant and Macro Definitions
82  *****************************************************************************/
83 
84 #define COR_TXN_MAX_STATIONS 8
85 #define CL_COR_TXN_SERVICE_ID_READ 1
86 #define CL_COR_TXN_SERVICE_ID_WRITE 2
87 
88 
89 /******************************************************************************
90  * Data Types
91  *****************************************************************************/
92 
118 typedef ClRcT (*ClCorTxnFuncT)(ClCorTxnIdT trans,
119  ClCorTxnJobIdT jobId,
120  void *cookie);
121 
122 /*****************************************************************************
123  * Functions
124  *****************************************************************************/
125 
151 extern ClRcT clCorTxnJobWalk(CL_IN ClCorTxnIdT pThis,
152  CL_IN ClCorTxnFuncT funcPtr,
153  CL_IN void *cookie);
154 
184 extern ClRcT clCorTxnSessionCommit(CL_IN ClCorTxnSessionIdT txnSessionId);
185 
207 extern ClRcT clCorTxnSessionCancel(CL_IN ClCorTxnSessionIdT txnSessionId) CL_DEPRECATED;
208 
232 extern ClRcT clCorTxnSessionFinalize(CL_IN ClCorTxnSessionIdT txnSessionId);
233 
254 extern ClRcT clCorTxnJobHandleToCorTxnIdGet(
255  CL_IN ClTxnJobDefnHandleT jobDefn,
256  CL_IN ClSizeT size,
257  CL_OUT ClCorTxnIdT *pTxnId);
258 
259 
278 extern ClRcT clCorTxnIdTxnFree(
279  CL_IN ClCorTxnIdT corTxnId);
280 
309 extern ClRcT clCorTxnJobAttributeTypeGet(
310  CL_IN ClCorTxnIdT txnId,
311  CL_IN ClCorTxnJobIdT jobId,
312  CL_OUT ClCorAttrTypeT *pAttrType,
313  CL_OUT ClCorTypeT *pAttrDataType);
314 
315 
351 extern ClRcT clCorTxnJobSetParamsGet(
352  CL_IN ClCorTxnIdT txnId,
353  CL_IN ClCorTxnJobIdT jobId,
354  CL_OUT ClCorAttrIdT *pAttrId,
355  CL_OUT ClInt32T *pIndex,
356  CL_OUT void **pValue,
357  CL_OUT ClUint32T *pSize);
358 
385 extern ClRcT clCorTxnJobAttrPathGet(
386  CL_IN ClCorTxnIdT txnId,
387  CL_IN ClCorTxnJobIdT jobId,
388  CL_OUT ClCorAttrPathT **pAttrPath);
389 
390 
419 extern ClRcT clCorTxnJobOperationGet(
420  CL_IN ClCorTxnIdT txnId,
421  CL_IN ClCorTxnJobIdT jobId,
422  CL_OUT ClCorOpsT *op);
423 
424 
450 extern ClRcT clCorTxnJobMoIdGet(
451  CL_IN ClCorTxnIdT txnId,
452  CL_OUT ClCorMOIdT *pMOId);
453 
454 
480 extern ClRcT clCorTxnJobObjectHandleGet(
481  CL_IN ClCorTxnIdT txnId,
482  CL_OUT ClCorObjectHandleT *pObjHandle);
483 
484 
510 extern ClRcT clCorTxnFirstJobGet(
511  CL_IN ClCorTxnIdT txnId,
512  CL_OUT ClCorTxnJobIdT *pJobId);
513 
539 extern ClRcT clCorTxnLastJobGet(
540  CL_IN ClCorTxnIdT txnId,
541  CL_OUT ClCorTxnJobIdT *pJobId);
542 
570 extern ClRcT clCorTxnNextJobGet(
571  CL_IN ClCorTxnIdT txnId,
572  CL_IN ClCorTxnJobIdT currentJobHdl,
573  CL_OUT ClCorTxnJobIdT *pNextJobHdl);
574 
575 
603 extern ClRcT clCorTxnPreviousJobGet(
604  CL_IN ClCorTxnIdT txnId,
605  CL_IN ClCorTxnJobIdT currentJobId,
606  CL_OUT ClCorTxnJobIdT *pPrevJobId);
607 
646 extern ClRcT clCorTxnFailedJobGet(
647  ClCorTxnSessionIdT txnSessionId,
648  ClCorTxnInfoT *pPrevTxnInfo,
649  ClCorTxnInfoT *pNextTxnInfo);
650 
676 extern ClRcT clCorTxnJobStatusSet(
677  CL_IN ClCorTxnIdT txnId,
678  CL_IN ClCorTxnJobIdT jobId,
679  CL_IN ClUint32T jobStatus);
680 
706 extern ClRcT clCorTxnJobStatusGet(
707  CL_IN ClCorTxnIdT txnId,
708  CL_IN ClCorTxnJobIdT jobId,
709  CL_OUT ClUint32T* jobStatus);
710 
734 extern ClRcT clCorTxnJobDefnHandleUpdate(
735  CL_OUT ClTxnJobDefnHandleT jobDefnHandle,
736  CL_IN ClCorTxnIdT corTxnId);
737 
738 
739 extern ClRcT clCorTxnJobOmClassIdGet(CL_IN ClCorTxnIdT corTxnId,
740  CL_OUT ClCorClassTypeT * pOmClassId);
741 
742 #ifdef __cplusplus
743 }
744 #endif
745 
746 #endif /* _CL_COR_TXN_API_H_ */
747 
748 
749 
Generated on Tue Jan 10 10:29:15 PST 2012 for OpenClovis SDK using Doxygen