org.opengroup.arm40.transaction.ArmBlockCause Interface Reference
[ARM 4.1]
Describes the cause of a blocking condition. More...
Inheritance diagram for org.opengroup.arm40.transaction.ArmBlockCause:
Public Member Functions | |
| String | getDescription () |
| int | getExtendedCause () |
| int | getCause () |
| int | setDescription (String desc) |
| sets the description string for the block cause. | |
| int | setExtendedCause (int extendedCauseID) |
| sets the extended cause id for the block cause. | |
| int | setCause (int causeID) |
| sets the block cause | |
Detailed Description
Describes the cause of a blocking condition.
Its use is optional. When used, it is passed on ArmTransaction's blocked().
The Cause ID must be one of the following values. All other values are reserved.
No Extended Cause ID values are currently defined. The range of possible values are partitioned as follows:
- non-negative values are reserved by the standard.
- All negative values are not defined by the standard. There are no restrictions on who uses these values or what they mean.
The Description is a String with a maximum of 127 characters.
- Since:
- ARM 4.1
Member Function Documentation
| int org.opengroup.arm40.transaction.ArmBlockCause.getCause | ( | ) |
- Returns:
- the block cause.
- See also:
- ArmConstants.BLOCK_CAUSE_SYNCHRONOUS_EVENT ArmConstants.BLOCK_* constants.
- Since:
- ARM 4.1
| String org.opengroup.arm40.transaction.ArmBlockCause.getDescription | ( | ) |
- Returns:
- the description of the block cause.
- Since:
- ARM 4.1
| int org.opengroup.arm40.transaction.ArmBlockCause.getExtendedCause | ( | ) |
- Returns:
- the extended block cause.
- Since:
- ARM 4.1
| int org.opengroup.arm40.transaction.ArmBlockCause.setCause | ( | int | causeID | ) |
sets the block cause
- Parameters:
-
causeID cause ID to set.
- Returns:
- 0 on success; otherwise, a non-zero error code is returned (as specified in org.opengroup.arm40.transaction.ArmInterface).
- See also:
- ArmConstants.BLOCK_CAUSE_SYNCHRONOUS_EVENT ArmConstants.BLOCK_* constants.
- Since:
- ARM 4.1
| int org.opengroup.arm40.transaction.ArmBlockCause.setDescription | ( | String | desc | ) |
sets the description string for the block cause.
- Parameters:
-
desc description string to set.
- 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.ArmBlockCause.setExtendedCause | ( | int | extendedCauseID | ) |
sets the extended cause id for the block cause.
- Parameters:
-
extendedCauseID extended cause to set.
- 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/ArmBlockCause.java
Documentation generated on Thu May 24 2018 22:24:15. © 2018 by MyARM GmbH