The data for the Ping method.
More...
#include <client.h>
|
| PingData () |
| Class contructor.
|
|
uint32_t | txHops () const |
| Get the number of hops for trasmission. [IN/OUT].
|
|
void | setTxHops (uint32_t value) |
| Set the number of hops for trasmission. [IN/OUT].
|
|
uint32_t | rxHops () const |
| Get the number of hops for reception. [OUT].
|
|
void | setRxHops (uint32_t value) |
| Set the number of hops for reception. [OUT].
|
|
uint32_t | time () const |
| Get the time difference between transmission and reception [ms]. [OUT].
|
|
void | setTime (uint32_t value) |
| Set the time difference between transmission and reception [ms]. [OUT].
|
|
void | setState (uint64_t senderId, ActivityStates state, uint64_t data=0) |
| Set the activity state.
|
|
void | setProgress (uint64_t senderId, int32_t min, int32_t max, int32_t cur) |
| Set the activity progress.
|
|
| ErrorData () |
| Class contructor.
|
|
void | setErrorFromMessage (Message *src) |
| Set error information from a source message.
|
|
void | clearError () |
| Clear the error information.
|
|
void | setError (Message::ErrCodes errCode) |
| Set the error information.
|
|
void | setError (Message::ErrCodes errCode, uint16_t errExtra) |
| Set the error information.
|
|
Message::ErrCodes | nackErrCode () const |
| Get the received NACK error code : if the value equals Message::errCodesNoError then no NACK message was received.
|
|
uint16_t | nackErrExtra () const |
| Get the optional error extra data of the last NACK message received from the remote device.
|
|
The data for the Ping method.
- See also
- Client.ping()
◆ PingData()
◆ rxHops()
uint32_t rxHops |
( |
| ) |
const |
Get the number of hops for reception. [OUT].
- Returns
- The parameter value
◆ setRxHops()
void setRxHops |
( |
uint32_t | value | ) |
|
Set the number of hops for reception. [OUT].
- Parameters
-
◆ setTime()
void setTime |
( |
uint32_t | value | ) |
|
Set the time difference between transmission and reception [ms]. [OUT].
- Parameters
-
◆ setTxHops()
void setTxHops |
( |
uint32_t | value | ) |
|
Set the number of hops for trasmission. [IN/OUT].
- Parameters
-
◆ time()
Get the time difference between transmission and reception [ms]. [OUT].
- Returns
- The parameter value
◆ txHops()
uint32_t txHops |
( |
| ) |
const |
Get the number of hops for trasmission. [IN/OUT].
- Returns
- The parameter value