Apache.Qpid.Proton.Engine.ITransaction< T > Interface Template Reference

A Transaction object that hold information and context for a single Transaction. More...

Inheritance diagram for Apache.Qpid.Proton.Engine.ITransaction< T >:

Properties
T	Parent [get]
	Provides access to the parent that owns this transaction instance.
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.
TransactionState	State [get]
	Returns the current transaction state that reflect where in its lifetime this transaction instance is.
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.
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.
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.
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.

Detailed Description

A Transaction object that hold information and context for a single Transaction.

Type Constraints

T

:

IEndpoint<T>

Property Documentation

Attachments

IAttachments Apache.Qpid.Proton.Engine.ITransaction< T >.Attachments

get

Access the attachments instance that allows callers to attach state data to an transaction instance.

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonTransaction< T >.

DischargeState

DischargeState Apache.Qpid.Proton.Engine.ITransaction< T >.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.

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonTransaction< T >.

Error

ErrorCondition Apache.Qpid.Proton.Engine.ITransaction< T >.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.

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonTransaction< T >.

IsDeclared

bool Apache.Qpid.Proton.Engine.ITransaction< T >.IsDeclared

get

Checks if the transaction has been marked as declared by the transaction manager.

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonTransaction< T >.

IsDischarged

bool Apache.Qpid.Proton.Engine.ITransaction< T >.IsDischarged

get

Checks if the transaction has been marked as discharged by the transaction manager.

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonTransaction< T >.

IsFailed

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

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonTransaction< T >.

LinkedResource

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

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonTransaction< T >.

Parent

T Apache.Qpid.Proton.Engine.ITransaction< T >.Parent

get

Provides access to the parent that owns this transaction instance.

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonTransaction< T >.

State

TransactionState Apache.Qpid.Proton.Engine.ITransaction< T >.State

get

Returns the current transaction state that reflect where in its lifetime this transaction instance is.

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonTransaction< T >.

TxnId

IProtonBuffer Apache.Qpid.Proton.Engine.ITransaction< T >.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.

Implemented in Apache.Qpid.Proton.Engine.Implementation.ProtonTransaction< T >.

---

The documentation for this interface was generated from the following file:

• src/Proton/Engine/ITransaction.cs