Navigation
API > API/Runtime > API/Runtime/DownlinkBandwidthManager
| Name | FDownlinkBandwidthManager |
| Type | class |
| Header File | /Engine/Source/Runtime/Online/Experimental/DownlinkBandwidthManager/Public/DownlinkBandwidthManager.h |
| Include Path | #include "DownlinkBandwidthManager.h" |
Syntax
class FDownlinkBandwidthManager
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| DownlinkBandwidthManager.h | |||
| DownlinkBandwidthManager.h | |||
| Member Functions. | DownlinkBandwidthManager.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FDownlinkBandwidthManager() |
DownlinkBandwidthManager.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| Instance | TUniquePtr< FDownlinkBandwidthManager > | Singleton instance pointer. | DownlinkBandwidthManager.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bTelemetryMeasurementCompleted | bool | DownlinkBandwidthManager.h | ||
| bTelemetryMeasurementSuccess | bool | DownlinkBandwidthManager.h | ||
| CapKbps | int32 | The hard cap used for determining bandwidth distribution. | DownlinkBandwidthManager.h | |
| CurrentGameplayPriorityState | UE::BandwidthManager::EBandwidthDistributionPriorityState | The Managers perceived state of gameplay to consider for distribution. | DownlinkBandwidthManager.h | |
| CVarSubscriptionDelegate | UE::BandwidthManager::FOnCVarSetSubscription | Delegate to be triggered when rollout CVars are set. | DownlinkBandwidthManager.h | |
| Mutex | FTransactionallySafeCriticalSection | DownlinkBandwidthManager.h | ||
| NextServiceId | int32 | Incrementing Handle value for external services to track their FManagedService data within the manager. | DownlinkBandwidthManager.h | |
| PreviousAllocations | TMap< UE::BandwidthManager::FServiceHandleID, int32 > | Previous per-service bandwidth allocations (in Kbps), used to detect reallocations between ticks for telemetry. | DownlinkBandwidthManager.h | |
| PriorityBucketMapping | TMap< UE::BandwidthManager::EBandwidthPriority, UE::BandwidthManager::FPriorityBucket > | Mapping of expected priorities to their calculated allotment of bandwidth. | DownlinkBandwidthManager.h | |
| ReservedGameplayBandwidthKbps | int32 | The amount of bandwidth to reserve during gameplay. | DownlinkBandwidthManager.h | |
| RolloutPercentage | float | Randomized chance roll at initialization to determine if the manager should rollout for this client's launch. | DownlinkBandwidthManager.h | |
| TelemetryAllocatorErrors | int32 | DownlinkBandwidthManager.h | ||
| TelemetryDecisionCount | int32 | Telemetry counters (accumulated between analytics flushes) | DownlinkBandwidthManager.h | |
| TelemetryReallocationCount | int32 | DownlinkBandwidthManager.h | ||
| TickHandle | FTSTicker::FDelegateHandle | Handle for the polling tick. | DownlinkBandwidthManager.h | |
| TrackedServices | TMap< UE::BandwidthManager::FServiceHandleID, FManagedService > | Service Data Mapping. | DownlinkBandwidthManager.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FDelegateHandle BindToCVarSubscription
(
TFunction< void()> CallBack |
Binds for Subscription when CVar values get set/changed. | DownlinkBandwidthManager.h | |
void ChangeServicePriority
(
const UE::BandwidthManager::FServiceHandleID& ServiceID, |
Changes the associated Services Priority according to the priority state. | DownlinkBandwidthManager.h | |
int32 GetNumRegisteredServices() |
Returns the number of registered services (for telemetry A/B population flags) | DownlinkBandwidthManager.h | |
FBandwidthAllocatorTelemetry GetTelemetrySnapshot() |
Returns a snapshot of telemetry state for analytics reporting. | DownlinkBandwidthManager.h | |
void Initialize() |
Lifecycle (called by module) | DownlinkBandwidthManager.h | |
void Log
(
bool bPrint |
Allows for logging output of FDownlinkBandwidthManager, enabled via CVarDLBWEnableBandwidthLogging. | DownlinkBandwidthManager.h | |
UE::BandwidthManager::FServiceHandleID RegisterMonitoredService
(
const FString& ServiceName, |
Service Initialization and registration with Distribution Manager, FOnBandwidthUpdate will report back in Kbps. | DownlinkBandwidthManager.h | |
void ResetTelemetryCounters() |
Resets accumulated telemetry counters (called after analytics flush) | DownlinkBandwidthManager.h | |
void SetActivationForService
(
const UE::BandwidthManager::FServiceHandleID& ServiceID, |
Determines if service should be considered for distribution. | DownlinkBandwidthManager.h | |
void SetDistributionGameplayState
(
UE::BandwidthManager::EBandwidthDistributionPriorityState State |
Ways for the game to communicate back or check to see what priority distribution pattern the manager is in. | DownlinkBandwidthManager.h | |
void SetGameplayBandwidthCap
(
int32 InKbps |
Sets the Gameplay bandwidth for the Manager to reserve during the gameplay state. | DownlinkBandwidthManager.h | |
void SetIncomingBandwidthCap
(
int32 InKbps |
Sets the bandwidth Cap for the Manager to distribute across all services. | DownlinkBandwidthManager.h | |
void Shutdown() |
DownlinkBandwidthManager.h | ||
void UnbindToCVarSubscription
(
FDelegateHandle& Handle |
Removes Delegate Callback for CVarSubscriptionDelegate. | DownlinkBandwidthManager.h | |
void UnregisterMonitoredService
(
UE::BandwidthManager::FServiceHandleID& ServiceID |
Removes service from manager considerations and invalidates ServiceID after. | DownlinkBandwidthManager.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FDownlinkBandwidthManager & Get () |
Singleton access | DownlinkBandwidthManager.h | |
static bool HasLocalUserPassedRolloutCheck() |
Check to see if the probability check for roll out has passed/failed. | DownlinkBandwidthManager.h | |
static bool HasValueEnforcementPassed() |
Check to see if the probability check for roll out has passed/failed and Enforcement is enabled. | DownlinkBandwidthManager.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| DownlinkBandwidthManager.h | |||
FDownlinkBandwidthManager & operator=
(
const FDownlinkBandwidthManager& |
DownlinkBandwidthManager.h |