FIcmp Class Reference

#include <Icmp.h>

Static Public Member Functions
static ICMP_API void	IcmpEcho (const FString &TargetAddress, float Timeout, FIcmpEchoResultCallback HandleResult)
static void	IcmpEcho (const FString &TargetAddress, float Timeout, FIcmpEchoResultDelegate ResultDelegate)

Member Function Documentation

IcmpEcho() [1/2]

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

static

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

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

IcmpEcho() [2/2]

static void FIcmp::IcmpEcho ( const FString &  TargetAddress, float  Timeout, FIcmpEchoResultDelegate  ResultDelegate  )

inlinestatic

Send an ICMP echo packet and wait for a reply.

This is a wrapper around the above function, taking a delegate instead of a function argument.

Parameters

TargetAddress	the target address to ping
Timeout	max time to wait for a reply
ResultDelegate	a delegate that will be called when the result is ready

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Online/ICMP/Public/Icmp.h
• Engine/Source/Runtime/Online/ICMP/Private/Icmp.cpp