Base class for ITransaction types in the Proton engine which provides the basic API implementation that all transactions will expose. More...
Properties | |
| TransactionState | State [get, set] |
| Returns the current transaction state that reflect where in its lifetime this transaction instance is. | |
| DischargeState | DischargeState [get, set] |
| 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. | |
| ErrorCondition | Error [get, set] |
| 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. | |
| IAttachments | Attachments [get] |
| Access the attachments instance that allows callers to attach state data to an transaction instance. | |
| 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. | |
| IProtonBuffer | TxnId [get, set] |
| 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. | |
| bool | IsDeclared [get] |
| Checks if the transaction has been marked as declared by the transaction manager. | |
| bool | IsDischarged [get] |
| Checks if the transaction has been marked as discharged by the transaction manager. | |
| 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. | |
| T | Parent [get] |
| Provides access to the parent that owns this transaction instance. | |
 Properties inherited from Apache.Qpid.Proton.Engine.ITransaction< T > | |
Detailed Description
Base class for ITransaction types in the Proton engine which provides the basic API implementation that all transactions will expose.
- Template Parameters
-
T
- Type Constraints
-
T : IEndpoint<T>
Property Documentation
◆ Attachments
|
get |
Access the attachments instance that allows callers to attach state data to an transaction instance.
Implements Apache.Qpid.Proton.Engine.ITransaction< T >.
◆ DischargeState
|
getset |
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.
Implements Apache.Qpid.Proton.Engine.ITransaction< T >.
◆ Error
|
getset |
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.
Implements Apache.Qpid.Proton.Engine.ITransaction< T >.
◆ IsDeclared
|
get |
Checks if the transaction has been marked as declared by the transaction manager.
Implements Apache.Qpid.Proton.Engine.ITransaction< T >.
◆ IsDischarged
|
get |
Checks if the transaction has been marked as discharged by the transaction manager.
Implements Apache.Qpid.Proton.Engine.ITransaction< T >.
◆ 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.
Implements Apache.Qpid.Proton.Engine.ITransaction< T >.
◆ LinkedResource
|
getset |
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.
Implements Apache.Qpid.Proton.Engine.ITransaction< T >.
◆ Parent
|
getabstract |
Provides access to the parent that owns this transaction instance.
Implements Apache.Qpid.Proton.Engine.ITransaction< T >.
◆ State
|
getset |
Returns the current transaction state that reflect where in its lifetime this transaction instance is.
Implements Apache.Qpid.Proton.Engine.ITransaction< T >.
◆ TxnId
|
getset |
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.
Implements Apache.Qpid.Proton.Engine.ITransaction< T >.
The documentation for this class was generated from the following file:
- src/Proton/Engine/Implementation/ProtonTransaction.cs
