costransactions_resource(3erl) [linux man page]
CosTransactions_Resource(3erl) Erlang Module Definition CosTransactions_Resource(3erl) NAME
CosTransactions_Resource - This module implements the OMG CosTransactions::Resource interface. DESCRIPTION
To get access to the record definitions for the structures use: -include_lib("cosTransactions/include/CosTransactions.hrl"). EXPORTS
commit(Resource) -> Return Types Resource = #objref Return = ok | {'EXCEPTION', E} E = #'CosTransactions_NotPrepared'{} | #'CosTransactions_HeuristicRollback'{} | #'CosTransactions_HeuristicMixed'{} | #'Cos- Transactions_HeuristicHazard'{} This operation instructs the Resource to commit all changes made as a part of the transaction. The Resource can raise: * 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 forget operation is performed. commit_one_phase(Resource) -> Return Types Resource = #objref Return = ok | {'EXCEPTION', E} E = #'CosTransactions_HeuristicHazard'{} | #'CosTransactions_TransactionRolledBack'{} 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. forget(Resource) -> Return Types Resource = #objref Return = ok This operation informs the Resource that it is safe to forget any Heuristic decisions and the knowledge of the transaction. prepare(Resource) -> Return Types Resource = #objref Return = Vote | {'EXCEPTION', E} Vote = 'VoteReadOnly' | 'VoteCommit' | 'VoteRollback' E = #'CosTransactions_HeuristicMixed'{} | #'CosTransactions_HeuristicHazard'{} This operation is invoked on the Resource to begin the two-phase commit protocol. The Resource can reply: * 'VoteReadOnly' - if no persistent data has been modified by the transaction. The Resource can forget all knowledge of the trans- action. * 'VoteCommit' - if the Resource has been prepared and is able to write all the data needed to commit the transaction to stable storage. * 'VoteRollback' - under any circumstances but must do so if none of the alternatives above are applicable. * 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 forget operation is performed. rollback(Resource) -> Return Types Resource = #objref Return = ok | {'EXCEPTION', E} E = #'CosTransactions_HeuristicCommit'{} | #'CosTransactions_HeuristicMixed'{} | #'CosTransactions_HeuristicHazard'{} This operation instructs the Resource to rollback all changes made as a part of the transaction. The Resource can raise: * 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 forget operation is performed. Ericsson AB cosTransactions 1.2.10 CosTransactions_Resource(3erl)
Check Out this Related Man Page
CosTransactions_Coordinator(3erl) Erlang Module Definition CosTransactions_Coordinator(3erl) NAME
CosTransactions_Coordinator - This module implements the OMG CosTransactions::Coordinator interface. DESCRIPTION
To get access to the record definitions for the structures use: -include_lib("cosTransactions/include/CosTransactions.hrl"). EXPORTS
create_subtransaction(Coordinator) -> Control Types Coordinator = #objref Control = #objref A new subtransaction is created whose parent is the Coordinator argument. Raises exception: * 'SubtransactionsUnavailable' - if nested transactions are not supported. * 'Inactive' - if target transaction has already been prepared. get_transaction_name(Coordinator) -> Name Types Coordinator = #objref Name = string() of type "oe_name@machine_type_timestamp" Returns a printable string, which describe the transaction. The main purpose is to support debugging. get_parent_status(Coordinator) -> Status Types Coordinator = #objref Status = atom() 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 get_status/1 operation. Possible Status replies: * 'StatusCommitted' * 'StatusCommitting' * 'StatusMarkedRollback' * 'StatusRollingBack' * 'StatusRolledBack' * 'StatusActive' * 'StatusPrepared' * 'StatusUnknown' * 'StatusNoTransaction' * 'StatusPreparing' get_status(Coordinator) -> Status Types Coordinator = #objref Status = atom() Returns the status of the transaction associated with the target object. get_top_level_status(Coordinator) -> Status Types Coordinator = #objref Status = atom() Returns the status of the top-level transaction associated with the target object. hash_top_level_tran(Coordinator) -> Return Types Coordinator = #objref Return = integer() Returns a hash code for the top-level transaction associated with the target object. Equals the operation hash_transaction/1 if the target object is a top-level transaction. hash_transaction(Coordinator) -> Return Types Coordinator = #objref Return = integer() Returns a hash code for the transaction associated with the target object. is_descendant_transaction(Coordinator, OtherCoordinator) -> Return Types Coordinator = #objref OtherCoordinator = #objref Return = Boolean Returns true if the transaction associated with the target object is a descendant of the transaction associated with the parameter object. is_same_transaction(Coordinator, OtherCoordinator) -> Return Types Coordinator = #objref OtherCoordinator = #objref Return = Boolean Returns true if the transaction associated with the target object is related to the transaction associated with the parameter object. is_top_level_transaction(Coordinator) -> Return Types Coordinator = #objref Return = Boolean Returns true if the transaction associated with the target object is a top-level transaction. register_resource(Coordinator, Resource) -> RecoveryCoordinator Types Coordinator = #objref Resource = #objref RecoveryCoordinator = #objref This operation registers the parameter Resource object as a participant in the transaction associated with the target object. The RecoveryCoordinator returned by this operation can be used by this Resource during recovery. Note: The Resources will be called in FIFO-order when preparing or committing. Hence, be sure to register the Resources in the correct order. Raises exception: * 'Inactive' - if target transaction has already been prepared. register_subtran_aware(Coordinator, SubtransactionAwareResource) -> Return Types Coordinator = #objref Return = ok This operation registers the parameter SubtransactionAwareResource object such that it will be notified when the transaction, asso- ciated wit the target object, has committed or rolled back. Note: The Resources will be called in FIFO-order. Hence, be sure to register the Resources in the correct order. rollback_only(Coordinator) -> Return Types Coordinator = #objref Return = ok The transaction associated with the target object is modified so the only possible outcome is to rollback the transaction. Ericsson AB cosTransactions 1.2.10 CosTransactions_Coordinator(3erl)