1. Epic GamesDeveloper
  3. FNetworkProfiler

FNetworkProfiler

Network profiler, using serialized token emission like e.g. script and malloc profiler.

API > API/Runtime > API/Runtime/Engine

Network profiler, using serialized token emission like e.g. script and malloc profiler.

   
Name FNetworkProfiler
Type class
Header File /Engine/Source/Runtime/Engine/Public/Net/NetworkProfiler.h
Include Path #include "Net/NetworkProfiler.h"

Syntax

class FNetworkProfiler

Constructors

Name Remarks Include Path Unreal Specifiers

FNetworkProfiler()

 Constructor, initializing members.Constructor, initializing member variables. Net/NetworkProfiler.h  

Structs

Name Remarks
FQueuedRPCInfo Data required to write queued RPCs to the profiler stream
FSendBunchInfo All the data required for writing sent bunches to the profiler stream

Constants

Name Type Remarks Include Path
bIsComparisonTrackingEnabled bool Whether or not want to track granular information about comparisons. This can be very expensive. Net/NetworkProfiler.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AddressTableIndexMap TMap< FString, int32 > Mapping from address to index in address array. Net/NetworkProfiler.h  
AutoStopTimerHandle FTimerHandle   Net/NetworkProfiler.h  
bHasNoticeableNetworkTrafficOccured bool Whether noticeable network traffic has occured in this session. Used to discard it. Net/NetworkProfiler.h  
bIsTrackingEnabled bool Whether tracking is enabled. Set after a session change. Net/NetworkProfiler.h  
bShouldTrackingBeEnabled bool Whether tracking should be enabled. Net/NetworkProfiler.h  
CriticalSection FTransactionallySafeCriticalSection Critical section to sequence tracking. Net/NetworkProfiler.h  
CurrentHeader FNetworkProfilerHeader Header for the current session. Net/NetworkProfiler.h  
ExportedObjects TSet< FString > Set of names that correspond to Object's whose top level property names have been exported. Net/NetworkProfiler.h  
FileWriter FArchive * File writer used to serialize data. Net/NetworkProfiler.h  
IgnorePropertyCount uint32 Used with FScopedIgnoreReplicateProperties. Net/NetworkProfiler.h  
LastAddress TSharedPtr< const FInternetAddr > Last known address Net/NetworkProfiler.h  
NameArray TArray< FString > Array of unique names. Net/NetworkProfiler.h  
NameToNameTableIndexMap TMap< FString, int32 > Mapping from name to index in name array. Net/NetworkProfiler.h  
NextFileName FString The filename to use next time a file writer is opened. Net/NetworkProfiler.h  
OnNetworkProfileFinishedDelegate FOnNetworkProfileFinished Delegate that's fired when tracking stops on the current network profile Net/NetworkProfiler.h  
OnNetworkProfileStartedDelegate FOnNetworkProfileStarted Delegate that's fired when tracking starts on the current network profile Net/NetworkProfiler.h  
OutgoingBunches TMap< UNetConnection *, TArray< FSendBunchInfo > > Stack outgoing bunches per connection, the top bunch for a connection may be popped if it gets merged with a new bunch. Net/NetworkProfiler.h  
QueuedRPCs TArray< FQueuedRPCInfo >   Net/NetworkProfiler.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void EnableTracking ( bool bShouldEnableTracking
)

 Enables/ disables tracking. Emits a session changes if disabled. Net/NetworkProfiler.h  

bool Exec ( UWorld* InWorld,
const TCHAR* Cmd,
FOutputDevice& Ar
)

 Processes any network profiler specific exec commands Net/NetworkProfiler.h  

void FlushOutgoingBunches ( UNetConnection* Connection
)

 Writes all the outgoing bunches for a connection in the stack to the profiler data stream. Net/NetworkProfiler.h  

void FlushQueuedRPCs ( UNetConnection* Connection,
UObject* TargetObject
)

 Writes all queued RPCs for the connection to the profiler stream Net/NetworkProfiler.h  

bool IsComparisonTrackingEnabled()

   Net/NetworkProfiler.h  

bool IsTrackingEnabled()

   Net/NetworkProfiler.h  

FOnNetworkProfileFinished & OnNetworkProfileFinished()

 Return the network profile finished delegate Net/NetworkProfiler.h  

FOnNetworkProfileStarted & OnNetworkProfileStarted()

 Return the network profile started delegate Net/NetworkProfiler.h  

void PopSendBunch ( UNetConnection* Connection
)

 Pops the latest bunch for a connection, since it is going to be merged with the next bunch. Net/NetworkProfiler.h  

void PushSendBunch ( UNetConnection* Connection,
FOutBunch* OutBunch,
uint16 NumHeaderBits,
uint16 NumPayloadBits
)

 Add a sent bunch to the stack. Net/NetworkProfiler.h  

void SetCurrentConnection ( UNetConnection* Connection
)

 Tracks when connection address changes Net/NetworkProfiler.h  

void SetNextFileName ( const FString& FileName
)

 Force the next profiling file to use the given filename. Net/NetworkProfiler.h  

void TrackBeginContentBlock ( UObject* Object,
uint16 NumBits,
UNetConnection* Connection
)

 Track actor content block headers Net/NetworkProfiler.h  

void TrackCompareProperties ( const UObject* Object,
uint32 Cycles,
TBitArray<>& PropertiesCompared,
TBitArray<>& PropertiesThatChanged,
const TArray< T >& PropertyNameContainers,
ProjectionType PropertyNameProjection
)

 Track time used to compare properties for a given object. Net/NetworkProfiler.h  

void TrackEndContentBlock ( UObject* Object,
uint16 NumBits,
UNetConnection* Connection
)

 Track actor content block headers Net/NetworkProfiler.h  

void TrackEvent ( const FString& EventName,
const FString& EventDescription,
UNetConnection* Connection
)

 Track event occuring, like e.g. client join/ leave Net/NetworkProfiler.h  

void TrackExportBunch ( uint16 NumBits,
UNetConnection* Connection
)

 Track NetGUID export bunches. Net/NetworkProfiler.h  

void TrackFrameBegin()

 Marks the beginning of a frame. Net/NetworkProfiler.h  

void TrackMustBeMappedGuids ( uint16 NumGuids,
uint16 NumBits,
UNetConnection* Connection
)

 Track "must be mapped" GUIDs Net/NetworkProfiler.h  

void TrackQueuedRPC ( UNetConnection* Connection,
UObject* TargetObject,
const AActor* Actor,
const UFunction* Function,
uint32 NumHeaderBits,
uint32 NumParameterBits,
uint32 NumFooterBits
)

 Tracks queued RPCs (unreliable multicast) being sent. Net/NetworkProfiler.h  

void TrackReplicateActor ( const AActor* Actor,
FReplicationFlags RepFlags,
uint32 Cycles,
UNetConnection* Connection
)

 Track actor being replicated. Net/NetworkProfiler.h  

void TrackReplicatePropertiesMetadata ( const UObject* Object,
TBitArray<>& InactiveProperties,
bool bSentAllProperties,
UNetConnection* Connection
)

 Track a set of metadata for a ReplicateProperties call. Net/NetworkProfiler.h  

void TrackReplicateProperty ( const FProperty* Property,
uint16 NumBits,
UNetConnection* Connection
)

 Track property being replicated. Net/NetworkProfiler.h  

void TrackSendAck ( uint16 NumBits,
UNetConnection* Connection
)

 Track sent acks. Net/NetworkProfiler.h  

void TrackSendBunch ( FOutBunch* OutBunch,
uint16 NumBits,
UNetConnection* Connection
)

 Mid level UChannel::SendBunch information.Mid level UChannel::SendBunch information. Net/NetworkProfiler.h  

void TrackSendRPC ( const AActor* Actor,
const UFunction* Function,
uint32 NumHeaderBits,
uint32 NumParameterBits,
uint32 NumFooterBits,
UNetConnection* Connection
)

 Tracks and RPC being sent.Tracks and RPC being sent. Net/NetworkProfiler.h  

void TrackSessionChange ( bool bShouldContinueTracking,
const FURL& InURL
)

 Called when the server first starts listening and on round changes or other similar game events. Net/NetworkProfiler.h  

void TrackSocketSend ( const FString& SocketDesc,
const void* Data,
uint16 BytesSent
)

 Low level FSocket::Send information. Net/NetworkProfiler.h  

void TrackSocketSendTo ( const FString& SocketDesc,
const void* Data,
uint16 BytesSent,
uint16 NumPacketIdBits,
uint16 NumBunchBits,
uint16 NumAckBits,
uint16 NumPaddingBits,
UNetConnection* Connection
)

 Low level FSocket::SendTo information.Low level FSocket::SendTo information. Net/NetworkProfiler.h  

void TrackSocketSendToCore ( const FString& SocketDesc,
const void* Data,
uint16 BytesSent,
uint16 NumPacketIdBits,
uint16 NumBunchBits,
uint16 NumAckBits,
uint16 NumPaddingBits,
UNetConnection* Connection
)

 Low level FSocket::SendTo information. Net/NetworkProfiler.h  

void TrackWritePropertyHandle ( uint16 NumBits,
UNetConnection* Connection
)

 Track property handles Net/NetworkProfiler.h  

void TrackWritePropertyHeader ( const FProperty* Property,
uint16 NumBits,
UNetConnection* Connection
)

 Track property header being written. Net/NetworkProfiler.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page