File: CosTransactions_Coordinator.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 (408 lines) | stat: -rw-r--r-- 8,925 bytes
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- This document was generated using DocBuilder 3.3.2 -->
<HTML>
<HEAD>
  <TITLE>CosTransactions_Coordinator</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_Coordinator</H1>
</CENTER>

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

<H3>MODULE SUMMARY</H3>
<DIV CLASS=REFBODY>
This module implements the OMG CosTransactions::Coordinator 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="create_subtransaction/1"><STRONG><CODE>create_subtransaction(Coordinator) -&#62; Control</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Coordinator = #objref</CODE></STRONG><BR>
<STRONG><CODE>Control = #objref</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> A new subtransaction is created whose parent is the Coordinator argument.

<P> Raises exception:

<P>
<UL>

<LI>
 'SubtransactionsUnavailable' - if nested transactions are not supported.

</LI>


<LI>
 'Inactive' - if target transaction has already been prepared.

</LI>


</UL>

</DIV>

<P><A NAME="get_transaction_name/1"><STRONG><CODE>get_transaction_name(Coordinator) -&#62; Name</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Coordinator = #objref</CODE></STRONG><BR>
<STRONG><CODE>Name = string() of type &#34;oe_name@machine_type_timestamp&#34;</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> Returns a printable string, which describe the transaction. The main purpose is to support debugging.

</DIV>

<P><A NAME="get_parent_status/1"><STRONG><CODE>get_parent_status(Coordinator) -&#62; Status</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Coordinator = #objref</CODE></STRONG><BR>
<STRONG><CODE>Status = atom()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> Returns the status of the parent transaction
associated with the target object. If the target object is a top-level
transaction this operation is equivalent to <CODE>get_status/1</CODE> operation. 

<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>

</DIV>

<P><A NAME="get_status/1"><STRONG><CODE>get_status(Coordinator) -&#62; Status</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Coordinator = #objref</CODE></STRONG><BR>
<STRONG><CODE>Status = atom()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> Returns the status of the transaction associated with the target object.

</DIV>

<P><A NAME="get_top_level_status/1"><STRONG><CODE>get_top_level_status(Coordinator) -&#62; Status</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Coordinator = #objref</CODE></STRONG><BR>
<STRONG><CODE>Status = atom()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> Returns the status of the top-level transaction associated with the target object.

</DIV>

<P><A NAME="hash_top_level_tran/1"><STRONG><CODE>hash_top_level_tran(Coordinator) -&#62; Return</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Coordinator = #objref</CODE></STRONG><BR>
<STRONG><CODE>Return = integer()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> Returns a hash code for the top-level transaction 
associated with the target object. Equals the operation
<CODE>hash_transaction/1</CODE> if the target object is a top-level transaction.

</DIV>

<P><A NAME="hash_transaction/1"><STRONG><CODE>hash_transaction(Coordinator) -&#62; Return</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Coordinator = #objref</CODE></STRONG><BR>
<STRONG><CODE>Return = integer()</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> Returns a hash code for the transaction associated with the target object.

</DIV>

<P><A NAME="is_descendant_transaction/2"><STRONG><CODE>is_descendant_transaction(Coordinator, OtherCoordinator) -&#62; Return</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Coordinator = #objref</CODE></STRONG><BR>
<STRONG><CODE>OtherCoordinator = #objref</CODE></STRONG><BR>
<STRONG><CODE>Return = Boolean</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> Returns true if the transction associated with the target object is a 
descendant of the transaction associated with the parameter object.

</DIV>

<P><A NAME="is_same_transaction/2"><STRONG><CODE>is_same_transaction(Coordinator, OtherCoordinator) -&#62; Return</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Coordinator = #objref</CODE></STRONG><BR>
<STRONG><CODE>OtherCoordinator = #objref</CODE></STRONG><BR>
<STRONG><CODE>Return = Boolean</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> Returns true if the transction associated with the target object is 
related to the transaction associated with the parameter object.

</DIV>

<P><A NAME="is_top_level_transaction/1"><STRONG><CODE>is_top_level_transaction(Coordinator) -&#62; Return</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Coordinator = #objref</CODE></STRONG><BR>
<STRONG><CODE>Return = Boolean</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> Returns true if the transction associated with the target object is 
a top-level transaction.

</DIV>

<P><A NAME="register_resource/2"><STRONG><CODE>register_resource(Coordinator, Resource) -&#62; RecoveryCoordinator</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Coordinator = #objref</CODE></STRONG><BR>
<STRONG><CODE>Resource = #objref</CODE></STRONG><BR>
<STRONG><CODE>RecoveryCoordinator = #objref</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> This operation registers the parameter <CODE>Resource</CODE> object as a participant in the
transaction associated with the target object. The <CODE>RecoveryCoordinator</CODE> returned
by this operation can be used by this Resource during recovery.

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

<P> 
The Resources will be called in FIFO-order when preparing or committing.
Hence, be sure to register the Resources in the correct order.
    </TD>
  </TR>
</TABLE>

<P> Raises exception:

<P>
<UL>

<LI>
'Inactive' - if target transaction has already been prepared.
</LI>


</UL>

</DIV>

<P><A NAME="register_subtran_aware/2"><STRONG><CODE>register_subtran_aware(Coordinator, SubtransactionAwareResource) -&#62; Return</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Coordinator = #objref</CODE></STRONG><BR>
<STRONG><CODE>Return = ok</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> This operation registers the parameter <CODE>SubtransactionAwareResource</CODE> object such that
it will be notified when the transaction, associated wit the target object, 
has committed or rolled back.

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

<P> The Resources will be called in FIFO-order.
Hence, be sure to register the Resources in the correct order.
    </TD>
  </TR>
</TABLE>

</DIV>

<P><A NAME="rollback_only/1"><STRONG><CODE>rollback_only(Coordinator) -&#62; Return</CODE></STRONG></A><BR>

<DIV CLASS=REFBODY><P>Types:
  <DIV CLASS=REFTYPES>
<P>
<STRONG><CODE>Coordinator = #objref</CODE></STRONG><BR>
<STRONG><CODE>Return = ok</CODE></STRONG><BR>

  </DIV>
</DIV>

<DIV CLASS=REFBODY>

<P> The transaction associated with the target object is modified so the only
possible outcome is to rollback the transaction.

</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>