File: CosTransactions_RecoveryCoordinator.html

package info (click to toggle)
erlang-doc-html 1%3A10.b.1a-1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 22,488 kB
  • ctags: 9,933
  • sloc: erlang: 505; ansic: 323; perl: 61; sh: 45; makefile: 39
file content (156 lines) | stat: -rw-r--r-- 3,233 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- This document was generated using DocBuilder 3.3.2 -->
<HTML>
<HEAD>
  <TITLE>CosTransactions_RecoveryCoordinator</TITLE>
  <SCRIPT type="text/javascript" src="../../../../doc/erlresolvelinks.js">
</SCRIPT>
  <STYLE TYPE="text/css">
<!--
    .REFBODY     { margin-left: 13mm }
    .REFTYPES    { margin-left: 8mm }
-->
  </STYLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#FF00FF"
      ALINK="#FF0000">
<!-- refpage -->
<CENTER>
<A HREF="http://www.erlang.se">
  <IMG BORDER=0 ALT="[Ericsson AB]" SRC="min_head.gif">
</A>
<H1>CosTransactions_RecoveryCoordinator</H1>
</CENTER>

<H3>MODULE</H3>
<DIV CLASS=REFBODY>
CosTransactions_RecoveryCoordinator
</DIV>

<H3>MODULE SUMMARY</H3>
<DIV CLASS=REFBODY>
This module implements the OMG CosTransactions::RecoveryCoordinator interface.
</DIV>

<H3>DESCRIPTION</H3>
<DIV CLASS=REFBODY>

<P> To get access to the record definitions for the structures use:<BR>

<CODE>-include_lib(&#34;cosTransactions/include/CosTransactions.hrl&#34;).</CODE>

</DIV>

<H3>EXPORTS</H3>

<P><A NAME="replay_completion/3"><STRONG><CODE>replay_completion(RecoveryCoordinator, Timeout, Resource) -&#62; Return</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>RecoveryCoordinator = #objref</CODE></STRONG><BR>
<STRONG><CODE>Timeout = integer(), milliseconds | 'inifinity'</CODE></STRONG><BR>
<STRONG><CODE>Resource = #objref</CODE></STRONG><BR>
<STRONG><CODE>Return = Status | {'EXCEPTION', E}</CODE></STRONG><BR>
<STRONG><CODE>E = #'CosTransactions_NotPrepared'{}</CODE></STRONG><BR>
<STRONG><CODE>Status = atom()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> The <CODE>RecoveryCoordinator</CODE> object is returned by the operation
<CODE>CosTransactions_Coordinator:register_resource/3</CODE>. The <CODE>replay_completion/2</CODE>
may only be used by the registered Resource and returns the current status
of the transaction. The operation is used when recovering after a failure.

<P> Possible Status replies:

<P>
<UL>

<LI>
'StatusCommitted'
</LI>


<LI>
'StatusCommitting'
</LI>


<LI>
'StatusMarkedRollback'
</LI>


<LI>
'StatusRollingBack'
</LI>


<LI>
'StatusRolledBack'
</LI>


<LI>
'StatusActive'
</LI>


<LI>
'StatusPrepared'
</LI>


<LI>
'StatusUnknown'
</LI>


<LI>
'StatusNoTransaction'
</LI>


<LI>
'StatusPreparing'
</LI>


</UL>

<P>
<TABLE CELLPADDING=4>
  <TR>
    <TD VALIGN=TOP><IMG ALT="Warning!" SRC="warning.gif"></TD>
    <TD>

<P> <STRONG>replay_completion/3</STRONG> is blocking and may cause dead-lock if a child
calls this function at the same time as its parent invokes an operation
on the child. Dead-lock will not occur if the timeout has any value except 'infinity'.

<P> If the call is external incoming (intra-ORB) the timeout will not be activated.
Hence, similar action must be taken if the Resource resides on another vendors ORB.
    </TD>
  </TR>
</TABLE>

</DIV>

<H3>AUTHORS</H3>
<DIV CLASS=REFBODY>
support - support@erlang.ericsson.se<BR>

</DIV>
<CENTER>
<HR>
<SMALL>cosTransactions 1.2<BR>
Copyright &copy; 1991-2004
<A HREF="http://www.erlang.se">Ericsson AB</A><BR>
</SMALL>
</CENTER>
</BODY>
</HTML>