FIcmp::IcmpEcho

Send an ICMP echo packet and wait for a reply.

Windows
MacOS
Linux

References

Module

Icmp

Header

/Engine/Source/Runtime/Online/ICMP/Public/Icmp.h

Include

#include "Icmp.h"

Source

/Engine/Source/Runtime/Online/ICMP/Private/Icmp.cpp

Syntax

static void IcmpEcho
(
    const FString & TargetAddress,
    float Timeout,
    FIcmpEchoResultCallback HandleResult
)

Remarks

Send an ICMP echo packet and wait for a reply.

The name resolution and ping send/receive will happen on a separate thread. The third argument is a callback function that will be invoked on the game thread after the a reply has been received from the target address, the timeout has expired, or if there was an error resolving the address or delivering the ICMP message to it.

Multiple pings can be issued concurrently and this function will ensure they're executed in turn in order not to mix ping replies from different nodes.

Parameters

Parameter

Description

TargetAddress

the target address to ping

Timeout

max time to wait for a reply

HandleResult

a callback function that will be called when the result is ready

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss