OodleNetworkHandlerComponent

[PacketHandler](API\Runtime\PacketHandler\PacketHandler) component for implementing Oodle support.

Windows
MacOS
Linux

Inheritance Hierarchy

HandlerComponent

OodleNetworkHandlerComponent

References

Module

OodleNetworkHandlerComponent

Header

/Engine/Plugins/Compression/OodleNetwork/Source/Public/OodleNetworkHandlerComponent.h

Include

#include "OodleNetworkHandlerComponent.h"

Syntax

class OodleNetworkHandlerComponent : public HandlerComponent

Remarks

PacketHandler component for implementing Oodle support.

Implementation uses trained/dictionary-based UDP compression.

Variables

Name Description

Protected variable

bool

 

bCaptureMode

Whether or not packet capturing is currently enabled (outputs uncompressed packets to file)

Protected variable

bool

 

bEnableOodle

Whether or not Oodle, and its additions to the packet protocol, are enabled

Public variable

bool

 

bInitializedDictionaries

Whether or not InitializeDictionaries was ever called

Protected variable

bool

 

bOodleNetworkAnalytics

Whether or not Oodle analytics is enabled - cached from NetAnalyticsData, for fast checking

Protected variable

bool

 

bUseDictionaryIfPresent

Search for dictionary files and use them if present - switching mode to Release in process - don't use in shipping

Public variable

TSharedPtr< FOo...

 

ClientDictionary

Client (Incoming - relative to server) dictionary data

Protected variable

EOodleEnableMod...

 

ClientEnableMode

When to enable compression on the client

Protected variable

FPacketCaptureA...

 

InPacketLog

File to log input packets to

Protected variable

TNetAnalyticsDa...

 

NetAnalyticsData

The net analytics aggregator data, which will take the above locally tracked variables, once they are complete

Protected variable

uint32

 

OodleReservedPacketBits

Cached reserved packet bits for Oodle

Protected variable

FPacketCaptureA...

 

OutPacketLog

File to log output packets to

Public variable

TSharedPtr< FOo...

 

ServerDictionary

Server (Outgoing) dictionary data

Protected variable

EOodleEnableMod...

 

ServerEnableMode

When to enable compression on the server

Constructors

Name Description

Public function

OodleNetworkHandlerComponent()

Initializes default data

Destructors

Name Description

Public function

~OodleNetworkHandlerComponent()

Default Destructor

Functions

Name Description

Public function

bool

 

FindFallbackDictionaries

(
    FString& OutServerDictionary,
    FString& OutClientDictionary,
    bool bTestOnly
)

Searches the game directory for alternate/fallback dictionary files, using the *.udic file extension.

Public function

void

 

FreeDictionary

(
    TSharedPtr< FOodleNetworkDictionary...
)

Frees the local reference to FOodleNetworkDictionary data, and removes it from memory if it was the last reference

Public function

void

 

FreePacketLogs()

Frees the packet capture archives

Public function

bool

 

GetDictionaryPaths

(
    FString& OutServerDictionary,
    FString& OutClientDictionary,
    bool bFailFatal
)

Resolves and returns the default dictionary file paths.

Public function Static

void

 

InitFirstRunConfig()

Initializes first-run config settings

Public function

void

 

InitializeDictionaries()

Initializes all required dictionaries

Public function

void

 

InitializeDictionary

(
    FString FilePath,
    TSharedPtr< FOodleNetworkDictionary...
)

Initializes FOodleNetworkDictionary data, from the specified dictionary file

Public function

void

 

InitializePacketLogs()

Initializes the packet capture archives

Public function Const

bool

 

IsCompressionActive()

Check if component is currently compressing packets

Public function

void

 

RemoteInitializeDictionaries()

Lazy dictionary initialization, triggered by receiving a compressed packet from the remote connection

Overridden from HandlerComponent

Name Description

Public function Virtual Const

void

 

CountBytes

(
    FArchive& Ar
)

Public function Virtual Const

int32

 

GetReservedPacketBits()

Returns the amount of reserved packet/protocol bits expected from this component.

Public function Virtual

void

 

Incoming

(
    FBitReader& Packet
)

Handles incoming packets

Public function Virtual

void

 

Initialize()

Initialization functionality should be placed here

Public function Virtual Const

bool

 

IsValid()

Return whether this handler is valid

Public function Virtual

void

 

NotifyAnalyticsProvider()

Notification that the analytics provider has been updated

Public function Virtual

void

 

Outgoing

(
    FBitWriter& Packet,
    FOutPacketTraits& Traits
)

Handles any outgoing packets
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss