Symbols ![]()
loading...
Files ![]()
loading...
ot::Utils::PingSender class
Implements sending ICMPv6 Echo Request messages and processing ICMPv6 Echo Reply messages.
Syntax
class PingSender : public InstanceLocator,
private NonCopyable
{
public:
typedef otPingSenderReply Reply;
struct Statistics : public otPingSenderStatistics
{
Statistics(void) { Clear(); }
void Clear(void)
{
mSentCount = 0;
mReceivedCount = 0;
mTotalRoundTripTime = 0;
mMinRoundTripTime = NumericLimits<uint16_t>::kMax;
mMaxRoundTripTime = NumericLimits<uint16_t>::kMin;
mIsMulticast = false;
}
};
class Config : public otPingSenderConfig
{
friend class PingSender;
public:
Ip6::Address &GetSource(void) { return AsCoreType(&mSource); }
const Ip6::Address &GetSource(void) const { return AsCoreType(&mSource); }
Ip6::Address &GetDestination(void) { return AsCoreType(&mDestination); }
const Ip6::Address &GetDestination(void) const { return AsCoreType(&mDestination); }
private:
static constexpr uint16_t kDefaultSize = OPENTHREAD_CONFIG_PING_SENDER_DEFAULT_SIZE;
static constexpr uint16_t kDefaultCount = OPENTHREAD_CONFIG_PING_SENDER_DEFAULT_COUNT;
static constexpr uint32_t kDefaultInterval = OPENTHREAD_CONFIG_PING_SENDER_DEFAULT_INTERVAL;
static constexpr uint32_t kDefaultTimeout = OPENTHREAD_CONFIG_PING_SENDER_DEFAULT_TIMEOUT;
void SetUnspecifiedToDefault(void);
void InvokeReplyCallback(const Reply &aReply) const;
void InvokeStatisticsCallback(const Statistics &aStatistics) const;
};
explicit PingSender(Instance &aInstance);
Error Ping(const Config &aConfig);
void Stop(void);
private:
void SendPing(void);
void HandleTimer(void);
static void HandleIcmpReceive(void *aContext,
otMessage *aMessage,
const otMessageInfo *aMessageInfo,
const otIcmp6Header *aIcmpHeader);
void HandleIcmpReceive(const Message &aMessage,
const Ip6::MessageInfo &aMessageInfo,
const Ip6::Icmp::Header &aIcmpHeader);
using PingTimer = TimerMilliIn<PingSender, &PingSender::HandleTimer>;
Config mConfig;
Statistics mStatistics;
uint16_t mIdentifier;
uint16_t mTargetEchoSequence;
PingTimer mTimer;
Ip6::Icmp::Handler mIcmpHandler;
};