UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Icmp.h File Reference
#include "Containers/Array.h"
#include "Containers/UnrealString.h"
#include "CoreMinimal.h"
#include "Delegates/Delegate.h"
#include "HAL/Platform.h"
#include "Templates/Function.h"

Go to the source code of this file.

Classes

struct  FIcmpEchoResult
 
struct  FIcmpTarget
 
struct  FIcmpEchoManyResult
 
struct  FIcmpEchoManyCompleteResult
 
class  FIcmp
 
class  FUDPPing
 

Macros

#define EnumCase(Name)   case EIcmpResponseStatus::Name : return TEXT(#Name)
 

Typedefs

typedef TFunction< void(FIcmpEchoResult)> FIcmpEchoResultCallback
 
typedef TFunction< void(FIcmpEchoManyCompleteResult)> FIcmpEchoManyCompleteCallback
 

Enumerations

enum class  EIcmpResponseStatus {
  Success , Timeout , Unreachable , Unresolvable ,
  InternalError , NotImplemented
}
 
enum class  EIcmpEchoManyStatus : uint8 { Invalid , Success , Failure , Canceled }
 

Functions

const TCHARLexToString (EIcmpResponseStatus ResponseStatus)
 
 DECLARE_DELEGATE_OneParam (FIcmpEchoResultDelegate, FIcmpEchoResult)
 
 DECLARE_DELEGATE_OneParam (FIcmpEchoManyCompleteDelegate, FIcmpEchoManyCompleteResult)
 

Macro Definition Documentation

◆ EnumCase

#define EnumCase (   Name)    case EIcmpResponseStatus::Name : return TEXT(#Name)

Typedef Documentation

◆ FIcmpEchoManyCompleteCallback

◆ FIcmpEchoResultCallback

Enumeration Type Documentation

◆ EIcmpEchoManyStatus

enum class EIcmpEchoManyStatus : uint8
strong
Enumerator
Invalid 
Success 
Failure 
Canceled 

◆ EIcmpResponseStatus

enum class EIcmpResponseStatus
strong
Enumerator
Success 

We did receive a valid Echo reply back from the target host

Timeout 

We did not receive any results within the time limit

Unreachable 

We got an unreachable error from another node on the way

Unresolvable 

We could not resolve the target address to a valid IP address

InternalError 

Some internal error happened during setting up or sending the ping packet

NotImplemented 

not implemented - used to indicate we haven't implemented ICMP ping on this platform

Function Documentation

◆ DECLARE_DELEGATE_OneParam() [1/2]

DECLARE_DELEGATE_OneParam ( FIcmpEchoManyCompleteDelegate  ,
FIcmpEchoManyCompleteResult   
)

◆ DECLARE_DELEGATE_OneParam() [2/2]

DECLARE_DELEGATE_OneParam ( FIcmpEchoResultDelegate  ,
FIcmpEchoResult   
)

◆ LexToString()

const TCHAR * LexToString ( EIcmpResponseStatus  ResponseStatus)
inline