arm4::util::ArmCorrelatorUser Class Reference
Represents a correlation token generated by the user. More...
Inheritance diagram for arm4::util::ArmCorrelatorUser:
Public Member Functions | |
| ArmCorrelatorUser (const arm_uint8_t corr_format=MYARM_CORR_USER_FORMAT) | |
| constructs an empty correlator | |
| bool | append (const void *data, const size_t len) |
| Append a buffer of the specified length. | |
| bool | append (const std::string &str) |
| Append the given string. | |
| bool | append (const uint8_t value) |
| Append a value. | |
| bool | append (const int8_t value) |
| Append a value. | |
| bool | append (const uint16_t value) |
| Append a value. | |
| bool | append (const int16_t value) |
| Append a value. | |
| bool | append (const uint32_t value) |
| Append a value. | |
| bool | append (const int32_t value) |
| Append a value. | |
| bool | append (const uint64_t value) |
| Append a value. | |
| bool | append (const int64_t value) |
| Append a value. | |
Detailed Description
Represents a correlation token generated by the user.
The correlation token may be used to establish a calling hierarchy across processes and systems. An user correlator is used when the application knows that application data uniquely represents the current measurement thus avoiding the need to send an extra ARM correlator to the children.
Member Function Documentation
| bool arm4::util::ArmCorrelatorUser::append | ( | const void * | data, | |
| const size_t | len | |||
| ) |
Append a buffer of the specified length.
- Parameters:
-
data Pointer to the buffer len Length of the buffer
| bool arm4::util::ArmCorrelatorUser::append | ( | const int64_t | value | ) |
Append a value.
- Parameters:
-
value The value to append
| bool arm4::util::ArmCorrelatorUser::append | ( | const uint64_t | value | ) |
Append a value.
- Parameters:
-
value The value to append
| bool arm4::util::ArmCorrelatorUser::append | ( | const int32_t | value | ) |
Append a value.
- Parameters:
-
value The value to append
| bool arm4::util::ArmCorrelatorUser::append | ( | const uint32_t | value | ) |
Append a value.
- Parameters:
-
value The value to append
| bool arm4::util::ArmCorrelatorUser::append | ( | const int16_t | value | ) |
Append a value.
- Parameters:
-
value The value to append
| bool arm4::util::ArmCorrelatorUser::append | ( | const uint16_t | value | ) |
Append a value.
- Parameters:
-
value The value to append
| bool arm4::util::ArmCorrelatorUser::append | ( | const int8_t | value | ) |
Append a value.
- Parameters:
-
value The value to append
| bool arm4::util::ArmCorrelatorUser::append | ( | const uint8_t | value | ) |
Append a value.
- Parameters:
-
value The value to append
| bool arm4::util::ArmCorrelatorUser::append | ( | const std::string & | str | ) |
Append the given string.
- Parameters:
-
str String to append
The documentation for this class was generated from the following file:
- Arm4/Util/ArmCorrelatorUser
Documentation generated on Thu May 24 2018 22:24:17. © 2018 by MyARM GmbH