A Transaction object that hold information and context for a single Transaction
More...
|
| T | Parent [get] |
| | Provides access to the parent that owns this transaction instance. More...
|
| |
| IAttachments | Attachments [get] |
| | Access the attachments instance that allows callers to attach state data to an transaction instance. More...
|
| |
| object | LinkedResource [get, set] |
| | Allows the endpoint to have some user defined resource linked to it which can be used to store application state data or other associated object instances with this transaction. More...
|
| |
| TransactionState | State [get] |
| | Returns the current transaction state that reflect where in its lifetime this transaction instance is. More...
|
| |
| DischargeState | DischargeState [get] |
| | For a Transaction that has either been requested to discharge or has successfully discharged the discharge state reflects whether the transaction was to be committed or rolled back. Prior to a discharge being attempted there is no state value and this method returns a discharge state of none. More...
|
| |
| IProtonBuffer | TxnId [get] |
| | Returns the transaction Id that is associated with the declared transaction. Prior to a transaction manager completing a transaction declaration this method will return null to indicate that the transaction has not been declared yet. More...
|
| |
| bool | IsDeclared [get] |
| | Checks if the transaction has been marked as declared by the transaction manager. More...
|
| |
| bool | IsDischarged [get] |
| | Checks if the transaction has been marked as discharged by the transaction manager. More...
|
| |
| bool | IsFailed [get] |
| | The parent resource will mark the Transaction as failed is any of the operations performed on it cannot be successfully completed such as a declare operation failing to write due to an IO error. More...
|
| |
| ErrorCondition | Error [get] |
| | If the declare or discharge of the transaction caused its state to become failed this method returns the error condition object that the remote used to describe the reason for the failure. More...
|
| |
A Transaction object that hold information and context for a single Transaction
◆ Attachments
Access the attachments instance that allows callers to attach state data to an transaction instance.
◆ DischargeState
For a Transaction that has either been requested to discharge or has successfully discharged the discharge state reflects whether the transaction was to be committed or rolled back. Prior to a discharge being attempted there is no state value and this method returns a discharge state of none.
◆ Error
If the declare or discharge of the transaction caused its state to become failed this method returns the error condition object that the remote used to describe the reason for the failure.
◆ IsDeclared
Checks if the transaction has been marked as declared by the transaction manager.
◆ IsDischarged
Checks if the transaction has been marked as discharged by the transaction manager.
◆ IsFailed
The parent resource will mark the Transaction as failed is any of the operations performed on it cannot be successfully completed such as a declare operation failing to write due to an IO error.
◆ LinkedResource
Allows the endpoint to have some user defined resource linked to it which can be used to store application state data or other associated object instances with this transaction.
◆ Parent
Provides access to the parent that owns this transaction instance.
◆ State
Returns the current transaction state that reflect where in its lifetime this transaction instance is.
◆ TxnId
Returns the transaction Id that is associated with the declared transaction. Prior to a transaction manager completing a transaction declaration this method will return null to indicate that the transaction has not been declared yet.
The documentation for this interface was generated from the following file:
- src/Proton/Engine/ITransaction.cs
