FUDPPing::UDPEchoMany

Send multiple ICMP echo packets and wait for replies.

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/UDPPing.cpp

Syntax

static void UDPEchoMany
(
    const TArray< FIcmpTarget > & Targets,
    float Timeout,
    FIcmpEchoManyCompleteCallback CompletionCallback
)

Remarks

Send multiple ICMP echo packets and wait for replies.

Creates a new thread in which name resolution and ping send/receive are handled for all supplied target addresses. These are non-blocking requests, sent and received on a single network socket.

The third argument is a callback function that will be invoked on the game thread after all replies are received, timed out, or otherwise terminated (e.g. remote address could not be resolved, host unreachable, send failed, etc.). It passes a FIcmpEchoManyCompleteResult instance, containing the overall completion status, and the ping results obtained so far for all of the supplied targets.

Parameters

Parameter

Description

Targets

the target addresses to ping

Timeout

max time to wait for a replies

CompletionCallback

callback function that is invoked when the final results are 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