INetworkMessagingExtension.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Features/IModularFeature.h"
#include "Delegates/Delegate.h"
#include "Misc/Guid.h"
#include "Misc/Timespan.h"
 
struct FMessageAddress;
 
struct FMessageTransportStatistics
{
    uint64 TotalBytesSent = 0;
 
    uint64 TotalBytesLost = 0;
 
    uint64 TotalBytesReceived = 0;
    
    uint64 BytesInflight = 0;
 
    uint64 PacketsSent = 0;
 
    uint64 PacketsLost = 0;
 
    uint64 PacketsAcked = 0;
 
    uint64 PacketsReceived = 0;
 
    uint64 PacketsInFlight = 0;
 
    uint32 WindowSize = 0;
 
    FTimespan AverageRTT{0};
 
    FString IPv4AsString;
};
 
struct FOutboundTransferStatistics
{
    FGuid  DestinationId;
 
    int32  MessageId;
 
    uint64 BytesToSend;
 
    uint64 BytesSent;
 
    uint64 BytesAcknowledged;
 
    bool bIsReliable;
 
    bool bTraced;
    
    bool bComplete;
};
 
struct FInboundTransferStatistics
{
    FGuid  OriginId;
 
    int32  MessageId;
    
    uint64 BytesToReceive;
 
    int32 BytesReceived;
 
    bool bWasReliablySent;
 
    bool bTraced;
    
    bool bComplete;
};
 
 
DECLARE_TS_MULTICAST_DELEGATE_OneParam(FOnOutboundTransferDataUpdated, FOutboundTransferStatistics);
DECLARE_TS_MULTICAST_DELEGATE_OneParam(FOnInboundTransferDataUpdated, FInboundTransferStatistics);
 
class INetworkMessagingExtension : public IModularFeature
{
public:
    static MESSAGING_API FName ModularFeatureName;
 
    virtual FName GetName() const = 0;
 
    virtual bool IsSupportEnabled() const = 0;
 
    virtual void RestartServices() = 0;
 
    virtual TArray<FString> GetListeningAddresses() const = 0;
 
    virtual bool CanProvideNetworkStatistics() const = 0;
 
    virtual FMessageTransportStatistics GetLatestNetworkStatistics(FGuid NodeId) const = 0;
 
    virtual FGuid GetNodeIdFromAddress(const FMessageAddress& MessageAddress) const = 0;
 
    virtual FOnOutboundTransferDataUpdated& OnOutboundTransferUpdatedFromThread() = 0;
 
    virtual FOnInboundTransferDataUpdated& OnInboundTransferUpdatedFromThread() = 0;
 
    virtual void ShutdownServices() = 0;
 
    virtual TArray<FString> GetKnownEndpoints() const = 0;
 
    virtual void AddEndpoint(const FString& InEndpoint) = 0;
 
    virtual void RemoveEndpoint(const FString& InEndpoint) = 0;
};