xa.h

Go to the documentation of this file.

/*
 * This header is NOT original but it's a derivative work of this public
 * documentation:
 *
 * X/Open CAE Specification
 * Distributed Transaction Processing:
 * The XA Specification
 * ISBN: 1 872630 24 3
 * X/Open Document Number: XO/CAE/91/300
 */

/*
 * Start of xa.h header
 *
 * Define a symbol to prevent multiple inclusions of this header file
 */
#ifndef XA_H
# define XA_H

/*
 * Transaction branch identification: XID and NULLXID:
 */
#define XIDDATASIZE 128 /* size in bytes */
#define MAXGTRIDSIZE 64 /* maximum size in bytes of gtrid */
#define MAXBQUALSIZE 64 /* maximum size in bytes of bqual */
#ifndef XID_T_TYPE
# define XID_T_TYPE
struct xid_t
{
    long formatID; /* format identifier */
    long gtrid_length; /* value from 1 through 64 */
    long bqual_length; /* value from 1 through 64 */
    char data[XIDDATASIZE];
};
typedef struct xid_t XID;
#endif /* XID_T_TYPE */
/*
 * A value of -1 in formatID means that the XID is null.
 */
#ifndef NULLXID
# define NULLXID -1
#endif


/*
 * Declarations of routines by which RMs call TMs:
 */
extern int ax_reg(int rmid, XID *xid, long flags);

extern int ax_unreg(int rmid, long flags);



#define RMNAMESZ 32

#define MAXINFOSIZE 256 


struct xa_switch_t
{
    char name[RMNAMESZ];
    long flags;
    long version;
    int (*xa_open_entry)(char *, int, long);
    int (*xa_close_entry)(char *, int, long);
    int (*xa_start_entry)(const XID *, int, long);
    int (*xa_end_entry)(const XID *, int, long); 
    int (*xa_rollback_entry)(const XID *, int, long);
    int (*xa_prepare_entry)(const XID *, int, long);
    int (*xa_commit_entry)(const XID *, int, long); 
    int (*xa_recover_entry)(XID *, long, int, long);
    int (*xa_forget_entry)(const XID *, int, long); 
    int (*xa_complete_entry)(int *, int *, int, long);
};



typedef struct xa_switch_t *(*lixa_get_xa_switch_f)(void);



/*
 * Flag definitions for the RM switch
 */
#define TMNOFLAGS 0x00000000L

#define TMREGISTER 0x00000001L

#define TMNOMIGRATE 0x00000002L

#define TMUSEASYNC 0x00000004L
/*
 * Flag definitions for xa_ and ax_ routines
 */
/* use TMNOFLAGS, defined above, when not specifying other flags */
#define TMASYNC 0x80000000L

#define TMONEPHASE 0x40000000L

#define TMFAIL 0x20000000L

#define TMNOWAIT 0x10000000L

#define TMRESUME 0x08000000L

#define TMSUCCESS 0x04000000L

#define TMSUSPEND 0x02000000L

#define TMSTARTRSCAN 0x01000000L

#define TMENDRSCAN 0x00800000L

#define TMMULTIPLE 0x00400000L

#define TMJOIN 0x00200000L

#define TMMIGRATE 0x00100000L
/*
 * NOTE: this is an extension implemented by LIXA but it's outside the XA
 *       standard
 * Flag definitions for xta_
 */
#define TMXTABRANCH   0x00008000L



/*
 * ax_() return codes (transaction manager reports to resource manager)
 */
#define TM_JOIN 2

#define TM_RESUME 1

#define TM_OK 0

#define TMER_TMERR -1

#define TMER_INVAL -2

#define TMER_PROTO -3



/*
 * xa_() return codes (resource manager reports to transaction manager)
 */
#define XA_RBBASE 100

#define XA_RBROLLBACK XA_RBBASE

#define XA_RBCOMMFAIL XA_RBBASE+1

#define XA_RBDEADLOCK XA_RBBASE+2

#define XA_RBINTEGRITY XA_RBBASE+3

#define XA_RBOTHER XA_RBBASE+4

#define XA_RBPROTO XA_RBBASE+5

#define XA_RBTIMEOUT XA_RBBASE+6

#define XA_RBTRANSIENT XA_RBBASE+7

#define XA_RBEND XA_RBTRANSIENT

#define XA_NOMIGRATE 9

#define XA_HEURHAZ 8

#define XA_HEURCOM 7

#define XA_HEURRB 6

#define XA_HEURMIX 5

#define XA_RETRY 4

#define XA_RDONLY 3

#define XA_OK 0

#define XAER_ASYNC -2

#define XAER_RMERR -3

#define XAER_NOTA -4

#define XAER_INVAL -5

#define XAER_PROTO -6

#define XAER_RMFAIL -7

#define XAER_DUPID -8

#define XAER_OUTSIDE -9

#define XAER_AFFINITY -10

#define LIXA_XAER_HAZARD   -20



#endif /* ifndef XA_H */
/*
 * End of xa.h header
 */