org.opengroup.arm40.transaction.ArmCorrelator Interface Reference
Represents a correlation token passed from a calling transaction to a called transaction. More...
Public Member Functions | |
| boolean | isAgentTrace () |
| indicates whether the "agent trace" flag is on in the correlator. | |
| boolean | isApplicationTrace () |
| indicates whether the "application trace" flag is on in the correlator. | |
| boolean | isAsynchronous () |
| indicates whether the "asynchronous" flag is on in the correlator. | |
| boolean | isIndependentTran () |
| indicates whether the "independent transaction" flag is on in the correlator. | |
| int | setAsynchronous (boolean b) |
| causes the "asynchronous" flag to be set to the specified boolean value. | |
| int | setIndependentTran (boolean b) |
| causes the "independent transaction" flag to be set to the specified boolean value. | |
Detailed Description
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. See Appendix B of the ARM 4.0 Java Binding Specification for more information about correlator formats. A correlation token is a maximum of ArmConstants#CORR_MAX_LENGTH bytes, including the header.
ArmCorrelator is created in one of three ways:
- The ArmTransactionFactory#newArmCorrelator method takes as input a byte array in network byte order, such as would be received from a caller.
- The ArmTransaction#getCorrelator method creates a correlator object for the currently or most recently executed transaction.
- The org.opengroup.arm40.tranreport.ArmTranReport#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 ArmToken, ArmCorrelator's parent interface.
Implementations of this interface should also override equals() and hashCode() from java.lang.Object.
Member Function Documentation
| boolean org.opengroup.arm40.transaction.ArmCorrelator.isAgentTrace | ( | ) |
indicates whether the "agent trace" flag is on in the correlator.
- Returns:
- the status of the agent trace flag.
| boolean org.opengroup.arm40.transaction.ArmCorrelator.isApplicationTrace | ( | ) |
indicates whether the "application trace" flag is on in the correlator.
- Returns:
- the status of the application trace flag.
| boolean org.opengroup.arm40.transaction.ArmCorrelator.isAsynchronous | ( | ) |
indicates whether the "asynchronous" flag is on in the correlator.
- Returns:
- the status of the asynchronous flag.
- Since:
- ARM 4.1
| boolean org.opengroup.arm40.transaction.ArmCorrelator.isIndependentTran | ( | ) |
indicates whether the "independent transaction" flag is on in the correlator.
- Returns:
- the status of the independent flag.
- Since:
- ARM 4.1
| int org.opengroup.arm40.transaction.ArmCorrelator.setAsynchronous | ( | boolean | b | ) |
causes the "asynchronous" flag to be set to the specified boolean value.
- Parameters:
-
b the new status of the asynchronous flag.
- Returns:
- 0 on success; otherwise, a non-zero error code is returned (as specified in org.opengroup.arm40.transaction.ArmInterface).
- Since:
- ARM 4.1
| int org.opengroup.arm40.transaction.ArmCorrelator.setIndependentTran | ( | boolean | b | ) |
causes the "independent transaction" flag to be set to the specified boolean value.
- Parameters:
-
b the new status of the independent flag.
- Returns:
- 0 on success; otherwise, a non-zero error code is returned (as specified in org.opengroup.arm40.transaction.ArmInterface).
- Since:
- ARM 4.1
The documentation for this interface was generated from the following file:
- org/opengroup/arm40/transaction/ArmCorrelator.java
Documentation generated on Thu May 24 2018 22:24:15. © 2018 by MyARM GmbH