OpenGroup::arm40::Provisional::transaction::IArmCorrelator Interface Reference
ArmCorrelator represents a correlation token passed from a calling transaction to a called transaction. More...
Public Member Functions | |
| bool | isAgentTrace () |
| indicates whether the "agent trace" flag is on in the correlator. | |
| bool | isApplicationTrace () |
| indicates whether the "application trace" flag is on in the correlator. | |
| bool | isAsynchronous () |
| indicates whether the "asynchronous" flag is on in the correlator. | |
| bool | isIndependentTran () |
| indicates whether the "independent transaction" flag is on in the correlator. | |
| int | setAsynchronous (bool b) |
| causes the "asynchronous" flag to be set to the specified boolean value. | |
| int | setIndependentTran (bool b) |
| causes the "independent transaction" flag to be set to the specified boolean value. | |
Detailed Description
The correlation token may be used to establish a calling hierarchy across processes and systems.
ArmCorrelator is created using one of these methods:
- The newArmCorrelator() method of ArmTransactionFactory
- The getCorrelator() method of ArmTransaction
- The generateCorrelator() method of ArmTranReport
Represents a correlation token passed from a calling transaction to a called transaction. The correlation token may be used to establish a calling hierarchy across processes and systems. A correlator contains a two-byte length field, a one-byte format ID, a one-byte flag field, plus it may contain other data that is used to uniquely identify an instance of a transaction. Applications do not need to understand correlator internals. A correlation token is a maximum of ArmConstants.CORR_MAX_LENGTH bytes, including the header.
IArmCorrelator is created in one of three ways:
- The IArmTransactionFactory.newArmCorrelator(byte []) method takes as input a byte array in network byte order, such as would be received from a caller.
- The IArmTransaction.getCorrelator method creates a correlator object for the currently or most recently executed transaction.
- The OpenGroup.arm40.Provisional.tranreport.IArmTranReport.generateCorrelator method creates a correlator object for what is presumed to be the next transaction to be executed.
An application may extract the byte array in network byte order, which is the format needed to send to a called transaction, using the copyBytes() or getBytes() methods of IArmToken, IArmCorrelators parent interface.
Implementations of this interface should also override Equals() and GetHashCode() from System.Object.
Member Function Documentation
| bool OpenGroup::arm40::Provisional::transaction::IArmCorrelator::isAgentTrace | ( | ) |
- Returns:
- the status of the agent trace flag.
| bool OpenGroup::arm40::Provisional::transaction::IArmCorrelator::isApplicationTrace | ( | ) |
- Returns:
- the status of the application trace flag.
| bool OpenGroup::arm40::Provisional::transaction::IArmCorrelator::isAsynchronous | ( | ) |
- Returns:
- the status of the asynchronous flag.
- Since:
- ARM 4.1
| bool OpenGroup::arm40::Provisional::transaction::IArmCorrelator::isIndependentTran | ( | ) |
- Returns:
- the status of the independent flag.
- Since:
- ARM 4.1
| int OpenGroup::arm40::Provisional::transaction::IArmCorrelator::setAsynchronous | ( | bool | b | ) |
- Parameters:
-
b the new status of the asynchronous flag.
- Returns:
- 0 on success; otherwise, a non-zero error code is returned (as specified in OpenGroup.arm40.Provisional.transaction.IArmInterface
- Since:
- ARM 4.1
| int OpenGroup::arm40::Provisional::transaction::IArmCorrelator::setIndependentTran | ( | bool | b | ) |
- Parameters:
-
b the new status of the independent flag.
- Returns:
- 0 on success; otherwise, a non-zero error code is returned (as specified in OpenGroup.arm40.Provisional.transaction.IArmInterface
- Since:
- ARM 4.1
The documentation for this interface was generated from the following file:
- opengroup/arm40/provisional/transaction/IArmCorrelator.cs
Documentation generated on Thu May 24 2018 22:24:16. © 2018 by MyARM GmbH