File xa.h¶

Classes¶

Type	Name
struct	xa_switch_t
struct	xid_t

Public Types¶

Type	Name
typedef struct xid_t	XID

Public Functions¶

Type	Name
int	ax_reg ()
int	ax_unreg ()

Macros¶

Type	Name
define	MAXBQUALSIZE `64 /\* [maximum](broker__monitor_8c.md#function-timeout) size in bytes [of](broker__monitor_8c.md#function-timeout) [bqual](broker__monitor_8c.md#function-timeout) \*/`
define	MAXGTRIDSIZE `64 /\* [maximum](broker__monitor_8c.md#function-timeout) size in bytes [of](broker__monitor_8c.md#function-timeout) gtrid \*/`
define	RMNAMESZ `32 /\* length [of](broker__monitor_8c.md#function-timeout) resource manager name \*/`
define	TMASYNC `0x80000000L /\* [perform](broker__monitor_8c.md#function-timeout) [routine](broker__monitor_8c.md#function-timeout) [asynchronously](broker__monitor_8c.md#function-timeout) \*/`
define	TMENDRSCAN `0x00800000L /\* end [a](broker__monitor_8c.md#function-timeout) [recovery](broker__monitor_8c.md#function-timeout) scan \*/`
define	TMER_INVAL `-2 /\* [invalid](broker__monitor_8c.md#function-timeout) [arguments](broker__monitor_8c.md#function-timeout) [were](broker__monitor_8c.md#function-timeout) [given](broker__monitor_8c.md#function-timeout) \*/`
define	TMER_PROTO `-3 /\* [routine](broker__monitor_8c.md#function-timeout) [invoked](broker__monitor_8c.md#function-timeout) in [an](broker__monitor_8c.md#function-timeout) [improper](broker__monitor_8c.md#function-timeout) context \*/`
define	TMER_TMERR `-1 /\* [an](broker__monitor_8c.md#function-timeout) [error](gencat_8c.md#function-error) [occurred](broker__monitor_8c.md#function-timeout) in [the](broker__monitor_8c.md#function-timeout) [transaction](broker__monitor_8c.md#function-timeout) manager \*/`
define	TMFAIL `0x20000000L /\* [dissociates](broker__monitor_8c.md#function-timeout) [caller](broker__monitor_8c.md#function-timeout) [and](broker__monitor_8c.md#function-timeout) [marks](broker__monitor_8c.md#function-timeout) [transaction](broker__monitor_8c.md#function-timeout) [branch](broker__monitor_8c.md#function-timeout) [rollback](broker__monitor_8c.md#function-timeout)-[only](broker__monitor_8c.md#function-timeout) \*/`
define	TMJOIN `0x00200000L /\* [caller](broker__monitor_8c.md#function-timeout) [is](broker__monitor_8c.md#function-timeout) [joining](broker__monitor_8c.md#function-timeout) [existing](broker__monitor_8c.md#function-timeout) [transaction](broker__monitor_8c.md#function-timeout) [branch](broker__monitor_8c.md#function-timeout) \*/`
define	TMMIGRATE `0x00100000L /\* [caller](broker__monitor_8c.md#function-timeout) [intends](broker__monitor_8c.md#function-timeout) to [perform](broker__monitor_8c.md#function-timeout) [migration](broker__monitor_8c.md#function-timeout) \*/`
define	TMMULTIPLE `0x00400000L /\* wait [for](dynamic__load_8c.md#function-for) [any](broker__monitor_8c.md#function-timeout) [asynchronous](broker__monitor_8c.md#function-timeout) operation \*/`
define	TMNOFLAGS `0x00000000L /\* [no](broker__monitor_8c.md#function-timeout) resource manager [features](broker__monitor_8c.md#function-timeout) [selected](broker__monitor_8c.md#function-timeout) \*/`
define	TMNOMIGRATE `0x00000002L /\* resource manager [does](broker__monitor_8c.md#function-timeout) [not](broker__monitor_8c.md#function-timeout) [support](broker__monitor_8c.md#function-timeout) [association](broker__monitor_8c.md#function-timeout) [migration](broker__monitor_8c.md#function-timeout) \*/`
define	TMNOWAIT `0x10000000L /\* [return](broker__monitor_8c.md#function-timeout) [if](dynamic__load_8c.md#function-if) [blocking](broker__monitor_8c.md#function-timeout) condition exists \*/`
define	TMONEPHASE `0x40000000L /\* [caller](broker__monitor_8c.md#function-timeout) [is](broker__monitor_8c.md#function-timeout) [using](broker__monitor_8c.md#function-timeout) [one](broker__monitor_8c.md#function-timeout)-[phase](broker__monitor_8c.md#function-timeout) commit [optimisation](broker__monitor_8c.md#function-timeout) \*/`
define	TMREGISTER `0x00000001L /\* resource manager [dynamically](broker__monitor_8c.md#function-timeout) [registers](broker__monitor_8c.md#function-timeout) \*/`
define	TMRESUME `0x08000000L /\* [caller](broker__monitor_8c.md#function-timeout) [is](broker__monitor_8c.md#function-timeout) [resuming](broker__monitor_8c.md#function-timeout) [association](broker__monitor_8c.md#function-timeout) with [suspended](broker__monitor_8c.md#function-timeout) [transaction](broker__monitor_8c.md#function-timeout) [branch](broker__monitor_8c.md#function-timeout) \*/`
define	TMSTARTRSCAN `0x01000000L /\* start [a](broker__monitor_8c.md#function-timeout) [recovery](broker__monitor_8c.md#function-timeout) scan \*/`
define	TMSUCCESS `0x04000000L /\* [dissociate](broker__monitor_8c.md#function-timeout) [caller](broker__monitor_8c.md#function-timeout) from [transaction](broker__monitor_8c.md#function-timeout) [branch](broker__monitor_8c.md#function-timeout) \*/`
define	TMSUSPEND `0x02000000L /\* [caller](broker__monitor_8c.md#function-timeout) [is](broker__monitor_8c.md#function-timeout) [suspending](broker__monitor_8c.md#function-timeout), [not](broker__monitor_8c.md#function-timeout) [ending](broker__monitor_8c.md#function-timeout), [association](broker__monitor_8c.md#function-timeout) \*/`
define	TMUSEASYNC `0x00000004L /\* resource manager [supports](broker__monitor_8c.md#function-timeout) [asynchronous](broker__monitor_8c.md#function-timeout) [operations](broker__monitor_8c.md#function-timeout) \*/`
define	TM_JOIN `2 /\* [caller](broker__monitor_8c.md#function-timeout) [is](broker__monitor_8c.md#function-timeout) [joining](broker__monitor_8c.md#function-timeout) [existing](broker__monitor_8c.md#function-timeout) [transaction](broker__monitor_8c.md#function-timeout) [branch](broker__monitor_8c.md#function-timeout) \*/`
define	TM_OK `0 /\* [normal](broker__monitor_8c.md#function-timeout) [execution](broker__monitor_8c.md#function-timeout) \*/`
define	TM_RESUME `1 /\* [caller](broker__monitor_8c.md#function-timeout) [is](broker__monitor_8c.md#function-timeout) [resuming](broker__monitor_8c.md#function-timeout) [association](broker__monitor_8c.md#function-timeout) with [suspended](broker__monitor_8c.md#function-timeout) [transaction](broker__monitor_8c.md#function-timeout) [branch](broker__monitor_8c.md#function-timeout) \*/`
define	XAER_ASYNC `-2 /\* [asynchronous](broker__monitor_8c.md#function-timeout) operation [already](broker__monitor_8c.md#function-timeout) [outstanding](broker__monitor_8c.md#function-timeout) \*/`
define	XAER_DUPID `-8 /\* [the](broker__monitor_8c.md#function-timeout) [XID](xa_8h.md#typedef-xid) [already](broker__monitor_8c.md#function-timeout) exists \*/`
define	XAER_INVAL `-5 /\* [invalid](broker__monitor_8c.md#function-timeout) [arguments](broker__monitor_8c.md#function-timeout) [were](broker__monitor_8c.md#function-timeout) [given](broker__monitor_8c.md#function-timeout) \*/`
define	XAER_NOTA `-4 /\* [the](broker__monitor_8c.md#function-timeout) [XID](xa_8h.md#typedef-xid) [is](broker__monitor_8c.md#function-timeout) [not](broker__monitor_8c.md#function-timeout) valid \*/`
define	XAER_OUTSIDE `-9 /\* resource manager [doing](broker__monitor_8c.md#function-timeout) [work](broker__monitor_8c.md#function-timeout) \*/`
define	XAER_PROTO `-6 /\* [routine](broker__monitor_8c.md#function-timeout) [invoked](broker__monitor_8c.md#function-timeout) in [an](broker__monitor_8c.md#function-timeout) [improper](broker__monitor_8c.md#function-timeout) context \*/`
define	XAER_RMERR `-3 /\* [a](broker__monitor_8c.md#function-timeout) resource manager [error](gencat_8c.md#function-error) [occurred](broker__monitor_8c.md#function-timeout) in [the](broker__monitor_8c.md#function-timeout) [transaction](broker__monitor_8c.md#function-timeout) [branch](broker__monitor_8c.md#function-timeout) \*/`
define	XAER_RMFAIL `-7 /\* resource manager [unavailable](broker__monitor_8c.md#function-timeout) \*/`
define	XA_HEURCOM `7 /\* [the](broker__monitor_8c.md#function-timeout) [transaction](broker__monitor_8c.md#function-timeout) [branch](broker__monitor_8c.md#function-timeout) [has](broker__monitor_8c.md#function-timeout) [been](broker__monitor_8c.md#function-timeout) [heuristically](broker__monitor_8c.md#function-timeout) [comitted](broker__monitor_8c.md#function-timeout) \*/`
define	XA_HEURHAZ `8 /\* [the](broker__monitor_8c.md#function-timeout) [transaction](broker__monitor_8c.md#function-timeout) [branch](broker__monitor_8c.md#function-timeout) [may](broker__monitor_8c.md#function-timeout) [have](broker__monitor_8c.md#function-timeout) [been](broker__monitor_8c.md#function-timeout) [heuristically](broker__monitor_8c.md#function-timeout) completed \*/`
define	XA_HEURMIX `5 /\* [the](broker__monitor_8c.md#function-timeout) [transaction](broker__monitor_8c.md#function-timeout) [branch](broker__monitor_8c.md#function-timeout) [has](broker__monitor_8c.md#function-timeout) [been](broker__monitor_8c.md#function-timeout) [heuristically](broker__monitor_8c.md#function-timeout) [committed](broker__monitor_8c.md#function-timeout) [and](broker__monitor_8c.md#function-timeout) [rolled](broker__monitor_8c.md#function-timeout) back \*/`
define	XA_HEURRB `6 /\* [the](broker__monitor_8c.md#function-timeout) [transaction](broker__monitor_8c.md#function-timeout) [branch](broker__monitor_8c.md#function-timeout) [has](broker__monitor_8c.md#function-timeout) [been](broker__monitor_8c.md#function-timeout) [heuristically](broker__monitor_8c.md#function-timeout) [rolled](broker__monitor_8c.md#function-timeout) back \*/`
define	XA_NOMIGRATE `9 /\* [resumption](broker__monitor_8c.md#function-timeout) [must](broker__monitor_8c.md#function-timeout) [occur](broker__monitor_8c.md#function-timeout) where [suspension](broker__monitor_8c.md#function-timeout) [occurred](broker__monitor_8c.md#function-timeout) \*/`
define	XA_OK `0 /\* [normal](broker__monitor_8c.md#function-timeout) [execution](broker__monitor_8c.md#function-timeout) \*/`
define	XA_RBBASE `100 /\* [The](broker__monitor_8c.md#function-timeout) [inclusive](broker__monitor_8c.md#function-timeout) lower bound [of](broker__monitor_8c.md#function-timeout) [the](broker__monitor_8c.md#function-timeout) [rollback](broker__monitor_8c.md#function-timeout) [codes](broker__monitor_8c.md#function-timeout) \*/`
define	XA_RBCOMMFAIL `[XA\_RBBASE](xa_8h.md#define-xa_rbbase)+1 /\* [The](broker__monitor_8c.md#function-timeout) [rollback](broker__monitor_8c.md#function-timeout) [was](broker__monitor_8c.md#function-timeout) [caused](broker__monitor_8c.md#function-timeout) [by](broker__monitor_8c.md#function-timeout) [a](broker__monitor_8c.md#function-timeout) [communication](broker__monitor_8c.md#function-timeout) failure \*/`
define	XA_RBDEADLOCK `[XA\_RBBASE](xa_8h.md#define-xa_rbbase)+2 /\* [A](broker__monitor_8c.md#function-timeout) [deadlock](broker__monitor_8c.md#function-timeout) [was](broker__monitor_8c.md#function-timeout) [detected](broker__monitor_8c.md#function-timeout) \*/`
define	XA_RBEND `[XA\_RBTRANSIENT](xa_8h.md#define-xa_rbtransient) /\* [The](broker__monitor_8c.md#function-timeout) [inclusive](broker__monitor_8c.md#function-timeout) upper bound [of](broker__monitor_8c.md#function-timeout) [the](broker__monitor_8c.md#function-timeout) [rollback](broker__monitor_8c.md#function-timeout) [codes](broker__monitor_8c.md#function-timeout) \*/`
define	XA_RBINTEGRITY [XA\_RBBASE](xa_8h.md#define-xa_rbbase)+3 /\* [A](broker__monitor_8c.md#function-timeout) condition [that](broker__monitor_8c.md#function-timeout) [violates](broker__monitor_8c.md#function-timeout) [the](broker__monitor_8c.md#function-timeout) [integrity](broker__monitor_8c.md#function-timeout) [of](broker__monitor_8c.md#function-timeout) [the](broker__monitor_8c.md#function-timeout) resources [was](broker__monitor_8c.md#function-timeout) [detected](broker__monitor_8c.md#function-timeout) \*/
define	XA_RBOTHER `/* multi line expression */`
define	XA_RBPROTO `[XA\_RBBASE](xa_8h.md#define-xa_rbbase)+5 /\* [A](broker__monitor_8c.md#function-timeout) [protocal](broker__monitor_8c.md#function-timeout) [error](gencat_8c.md#function-error) [occurred](broker__monitor_8c.md#function-timeout) in [the](broker__monitor_8c.md#function-timeout) resource manager \*/`
define	XA_RBROLLBACK `[XA\_RBBASE](xa_8h.md#define-xa_rbbase) /\* [The](broker__monitor_8c.md#function-timeout) [rollback](broker__monitor_8c.md#function-timeout) [was](broker__monitor_8c.md#function-timeout) [caused](broker__monitor_8c.md#function-timeout) [by](broker__monitor_8c.md#function-timeout) [an](broker__monitor_8c.md#function-timeout) [unspecified](broker__monitor_8c.md#function-timeout) [reason](broker__monitor_8c.md#function-timeout) \*/`
define	XA_RBTIMEOUT `[XA\_RBBASE](xa_8h.md#define-xa_rbbase)+6 /\* [A](broker__monitor_8c.md#function-timeout) [transaction](broker__monitor_8c.md#function-timeout) [branch](broker__monitor_8c.md#function-timeout) [took](broker__monitor_8c.md#function-timeout) [too](broker__monitor_8c.md#function-timeout) [long](broker__monitor_8c.md#function-timeout) \*/`
define	XA_RBTRANSIENT `[XA\_RBBASE](xa_8h.md#define-xa_rbbase)+7 /\* [May](broker__monitor_8c.md#function-timeout) retry [the](broker__monitor_8c.md#function-timeout) [transaction](broker__monitor_8c.md#function-timeout) [branch](broker__monitor_8c.md#function-timeout) \*/`
define	XA_RDONLY `3 /\* [the](broker__monitor_8c.md#function-timeout) [transaction](broker__monitor_8c.md#function-timeout) [was](broker__monitor_8c.md#function-timeout) read-[only](broker__monitor_8c.md#function-timeout) [and](broker__monitor_8c.md#function-timeout) [has](broker__monitor_8c.md#function-timeout) [been](broker__monitor_8c.md#function-timeout) [committed](broker__monitor_8c.md#function-timeout) \*/`
define	XA_RETRY `4 /\* [routine](broker__monitor_8c.md#function-timeout) [returned](broker__monitor_8c.md#function-timeout) with [no](broker__monitor_8c.md#function-timeout) [effect](broker__monitor_8c.md#function-timeout) [and](broker__monitor_8c.md#function-timeout) [may](broker__monitor_8c.md#function-timeout) [be](broker__monitor_8c.md#function-timeout) [re](broker__monitor_8c.md#function-timeout)-[issued](broker__monitor_8c.md#function-timeout) \*/`
define	XIDDATASIZE `128 /\* size in bytes \*/`

Public Types Documentation¶

typedef XID¶

typedef struct xid_t XID;

Public Functions Documentation¶

function ax_reg¶

int ax_reg ()

function ax_unreg¶

int ax_unreg ()

Macro Definition Documentation¶

define MAXBQUALSIZE¶

#define MAXBQUALSIZE `64    /* maximum size in bytes of  bqual */`

define MAXGTRIDSIZE¶

#define MAXGTRIDSIZE `64    /* maximum size in bytes of gtrid */`

define RMNAMESZ¶

#define RMNAMESZ `32        /* length of resource manager name */`

define TMASYNC¶

#define TMASYNC `0x80000000L    /* perform  routine  asynchronously */`

define TMENDRSCAN¶

#define TMENDRSCAN `0x00800000L /* end a  recovery scan */`

define TMER_INVAL¶

#define TMER_INVAL `-2  /* invalid  arguments  were  given */`

define TMER_PROTO¶

#define TMER_PROTO `-3  /* routine  invoked in an  improper context */`

define TMER_TMERR¶

#define TMER_TMERR `-1  /* an  error  occurred in the  transaction manager */`

define TMFAIL¶

#define TMFAIL `0x20000000L /* dissociates  caller  and  marks  transaction  branch  rollback - only */`

define TMJOIN¶

#define TMJOIN `0x00200000L /* caller  is  joining  existing  transaction  branch */`

define TMMIGRATE¶

#define TMMIGRATE `0x00100000L  /* caller  intends to perform  migration */`

define TMMULTIPLE¶

#define TMMULTIPLE `0x00400000L /* wait for  any  asynchronous operation */`

define TMNOFLAGS¶

#define TMNOFLAGS `0x00000000L  /* no resource manager features  selected */`

define TMNOMIGRATE¶

#define TMNOMIGRATE `0x00000002L    /* resource manager does  not  support  association  migration */`

define TMNOWAIT¶

#define TMNOWAIT `0x10000000L   /* return  if  blocking condition exists */`

define TMONEPHASE¶

#define TMONEPHASE `0x40000000L /* caller  is  using  one - phase commit optimisation */`

define TMREGISTER¶

#define TMREGISTER `0x00000001L /* resource manager dynamically  registers */`

define TMRESUME¶

#define TMRESUME `0x08000000L   /* caller  is  resuming  association with suspended  transaction  branch */`

define TMSTARTRSCAN¶

#define TMSTARTRSCAN `0x01000000L   /* start a  recovery scan */`

define TMSUCCESS¶

#define TMSUCCESS `0x04000000L  /* dissociate  caller from transaction  branch */`

define TMSUSPEND¶

#define TMSUSPEND `0x02000000L  /* caller  is  suspending , not  ending , association */`

define TMUSEASYNC¶

#define TMUSEASYNC `0x00000004L /* resource manager supports  asynchronous  operations */`

define TM_JOIN¶

#define TM_JOIN `2  /* caller  is  joining  existing  transaction  branch */`

define TM_OK¶

#define TM_OK `0        /* normal  execution */`

define TM_RESUME¶

#define TM_RESUME `1    /* caller  is  resuming  association with suspended  transaction  branch */`

define XAER_ASYNC¶

#define XAER_ASYNC `-2  /* asynchronous operation already  outstanding */`

define XAER_DUPID¶

#define XAER_DUPID `-8  /* the  XID  already exists */`

define XAER_INVAL¶

#define XAER_INVAL `-5  /* invalid  arguments  were  given */`

define XAER_NOTA¶

#define XAER_NOTA `-4   /* the  XID  is  not valid */`

define XAER_OUTSIDE¶

#define XAER_OUTSIDE `-9    /* resource manager doing  work */`

define XAER_PROTO¶

#define XAER_PROTO `-6  /* routine  invoked in an  improper context */`

define XAER_RMERR¶

#define XAER_RMERR `-3  /* a resource manager error  occurred in the  transaction  branch */`

define XAER_RMFAIL¶

#define XAER_RMFAIL `-7 /* resource manager unavailable */`

define XA_HEURCOM¶

#define XA_HEURCOM `7   /* the  transaction  branch  has  been  heuristically  comitted */`

define XA_HEURHAZ¶

#define XA_HEURHAZ `8   /* the  transaction  branch  may  have  been  heuristically completed */`

define XA_HEURMIX¶

#define XA_HEURMIX `5   /* the  transaction  branch  has  been  heuristically  committed  and  rolled back */`

define XA_HEURRB¶

#define XA_HEURRB `6    /* the  transaction  branch  has  been  heuristically  rolled back */`

define XA_NOMIGRATE¶

#define XA_NOMIGRATE `9 /* resumption  must  occur where suspension  occurred */`

define XA_OK¶

#define XA_OK `0    /* normal  execution */`

define XA_RBBASE¶

#define XA_RBBASE `100  /* The  inclusive lower bound of  the  rollback  codes */`

define XA_RBCOMMFAIL¶

#define XA_RBCOMMFAIL `XA_RBBASE +1 /* The  rollback  was  caused  by  a  communication failure */`

define XA_RBDEADLOCK¶

#define XA_RBDEADLOCK `XA_RBBASE +2 /* A  deadlock  was  detected */`

define XA_RBEND¶

#define XA_RBEND `XA_RBTRANSIENT /* The  inclusive upper bound of  the  rollback  codes */`

define XA_RBINTEGRITY¶

#define XA_RBINTEGRITY `XA_RBBASE +3    /* A condition that  violates  the  integrity  of  the resources was  detected */`

define XA_RBOTHER¶

#define XA_RBOTHER `XA_RBBASE +4    /* The resource manager rolled back the  transaction  for  a  reason  not  on  this * list */`

define XA_RBPROTO¶

#define XA_RBPROTO `XA_RBBASE +5    /* A  protocal  error  occurred in the resource manager */`

define XA_RBROLLBACK¶

#define XA_RBROLLBACK `XA_RBBASE /* The  rollback  was  caused  by  an  unspecified  reason */`

define XA_RBTIMEOUT¶

#define XA_RBTIMEOUT `XA_RBBASE +6  /* A  transaction  branch  took  too  long */`

define XA_RBTRANSIENT¶

#define XA_RBTRANSIENT `XA_RBBASE +7    /* May retry the  transaction  branch */`

define XA_RDONLY¶

#define XA_RDONLY `3    /* the  transaction  was read- only  and  has  been  committed */`

define XA_RETRY¶

#define XA_RETRY `4 /* routine  returned with no  effect  and  may  be  re - issued */`

define XIDDATASIZE¶

#define XIDDATASIZE `128    /* size in bytes */`

The documentation for this class was generated from the following file cubrid/src/broker/xa.h