OpenGroup::arm40::Provisional::transaction::IArmBlockCause Interface Reference
[ARM 4.1]
Describes the cause of a blocking condition. More...
Inheritance diagram for OpenGroup::arm40::Provisional::transaction::IArmBlockCause:
Public Member Functions | |
string | getDescription () |
returns the description of the block cause. | |
int | getExtendedCause () |
returns the extended block cause. | |
int | getCause () |
returns the block cause. | |
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
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.
- OpenGroup.arm40.Provisional.transaction.ArmConstants.BLOCK_CAUSE_SYNCHRONOUS_EVENT
- OpenGroup.arm40.Provisional.transaction.ArmConstants.BLOCK_CAUSE_ASYNCHRONOUS_EVENT
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 OpenGroup::arm40::Provisional::transaction::IArmBlockCause::getCause | ( | ) |
- Returns:
- the block cause. OpenGroup.arm40.Provisional.transaction.ArmConstants.BLOCK_CAUSE_SYNCHRONOUS_EVENT and OpenGroup.arm40.Provisional.transaction.ArmConstants.BLOCK_CAUSE_ASYNCHRONOUS_EVENT constants.
- Since:
- ARM 4.1
string OpenGroup::arm40::Provisional::transaction::IArmBlockCause::getDescription | ( | ) |
- Returns:
- the description of the block cause.
- Since:
- ARM 4.1
int OpenGroup::arm40::Provisional::transaction::IArmBlockCause::getExtendedCause | ( | ) |
- Returns:
- the extended block cause.
- Since:
- ARM 4.1
int OpenGroup::arm40::Provisional::transaction::IArmBlockCause::setCause | ( | int | causeID | ) |
- Parameters:
-
causeID cause ID to set.
- Returns:
- 0 on sucess; 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::IArmBlockCause::setDescription | ( | string | desc | ) |
- Parameters:
-
desc description string to set.
- Returns:
- 0 on sucess; 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::IArmBlockCause::setExtendedCause | ( | int | extendedCauseID | ) |
- Parameters:
-
extendedCauseID extended cause to set.
- Returns:
- 0 on sucess; 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/IArmBlockCause.cs