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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- This document was generated using DocBuilder 3.3.3 -->
<HTML>
<HEAD>
<TITLE>CosTransactions_Resource</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_Resource</H1>
</CENTER>
<H3>MODULE</H3>
<DIV CLASS=REFBODY>
CosTransactions_Resource
</DIV>
<H3>MODULE SUMMARY</H3>
<DIV CLASS=REFBODY>
This module implements the OMG CosTransactions::Resource interface.
</DIV>
<H3>DESCRIPTION</H3>
<DIV CLASS=REFBODY>
<P> To get access to the record definitions for the structures use:<BR>
<CODE>-include_lib("cosTransactions/include/CosTransactions.hrl").</CODE>
</DIV>
<H3>EXPORTS</H3>
<P><A NAME="commit/1"><STRONG><CODE>commit(Resource) -> Return</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Resource = #objref</CODE></STRONG><BR>
<STRONG><CODE>Return = ok | {'EXCEPTION', E}</CODE></STRONG><BR>
<STRONG><CODE>E = #'CosTransactions_NotPrepared'{} | #'CosTransactions_HeuristicRollback'{} | #'CosTransactions_HeuristicMixed'{} | #'CosTransactions_HeuristicHazard'{}</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P> This operation instructs the Resource to commit all changes made as a part of the transaction.
<P> The Resource can raise:
<P>
<UL>
<LI>
Heuristic Exception - if a Heuristic decision is made which differ
from the true outcome of the transaction. The Resource must remember
the Heuristic outcome until the <CODE>forget</CODE> operation is performed.
</LI>
</UL>
</DIV>
<P><A NAME="commit_one_phase/1"><STRONG><CODE>commit_one_phase(Resource) -> Return</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Resource = #objref</CODE></STRONG><BR>
<STRONG><CODE>Return = ok | {'EXCEPTION', E}</CODE></STRONG><BR>
<STRONG><CODE>E = #'CosTransactions_HeuristicHazard'{} | #'CosTransactions_TransactionRolledBack'{}</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P> If possible, the Resource should commit all changes made as part of the transaction,
else it should raise the TRANSACTION_ROLLEDBACK exception.
This operation can only be used if the Resource is the only child of its parent.
</DIV>
<P><A NAME="forget/1"><STRONG><CODE>forget(Resource) -> Return</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Resource = #objref</CODE></STRONG><BR>
<STRONG><CODE>Return = ok</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P> This operation informs the Resource that it is safe to forget any Heuristic
decisions and the knowledge of the transaction.
</DIV>
<P><A NAME="prepare/1"><STRONG><CODE>prepare(Resource) -> Return</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Resource = #objref</CODE></STRONG><BR>
<STRONG><CODE>Return = Vote | {'EXCEPTION', E}</CODE></STRONG><BR>
<STRONG><CODE>Vote = 'VoteReadOnly' | 'VoteCommit' | 'VoteRollback'</CODE></STRONG><BR>
<STRONG><CODE>E = #'CosTransactions_HeuristicMixed'{} | #'CosTransactions_HeuristicHazard'{}</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P> This operation is invoked on the Resource to begin the two-phase commit protocol.
<P> The Resource can reply:
<P>
<UL>
<LI>
'VoteReadOnly' - if no persistent data has been modified by the transaction.
The Resource can forget all knowledge of the transaction.
</LI>
<LI>
'VoteCommit' - if the Resource has been prepared and is able to write all the
data needed to commit the transaction to stable storage.
</LI>
<LI>
'VoteRollback' - under any circumstanses but must do so if none of the alternatives above
are applicable.
</LI>
<LI>
Heuristic Exception - if a Heuristic decision is made which differ
from the true outcome of the transaction. The Resource must remember
the Heuristic outcome until the <CODE>forget</CODE> operation is performed.
</LI>
</UL>
</DIV>
<P><A NAME="rollback/1"><STRONG><CODE>rollback(Resource) -> Return</CODE></STRONG></A><BR>
<DIV CLASS=REFBODY><P>Types:
<DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Resource = #objref</CODE></STRONG><BR>
<STRONG><CODE>Return = ok | {'EXCEPTION', E}</CODE></STRONG><BR>
<STRONG><CODE>E = #'CosTransactions_HeuristicCommit'{} | #'CosTransactions_HeuristicMixed'{} | #'CosTransactions_HeuristicHazard'{}</CODE></STRONG><BR>
</DIV>
</DIV>
<DIV CLASS=REFBODY>
<P> This operation instructs the Resource to rollback all changes made as a part of the transaction.
<P> The Resource can raise:
<P>
<UL>
<LI>
Heuristic Exception - if a Heuristic decision is made which differ
from the true outcome of the transaction. The Resource must remember
the Heuristic outcome until the <CODE>forget</CODE> operation is performed.
</LI>
</UL>
</DIV>
<H3>AUTHORS</H3>
<DIV CLASS=REFBODY>
support - support@erlang.ericsson.se<BR>
</DIV>
<CENTER>
<HR>
<SMALL>cosTransactions 1.2<BR>
Copyright © 1991-2006
<A HREF="http://www.erlang.se">Ericsson AB</A><BR>
</SMALL>
</CENTER>
</BODY>
</HTML>
|
