FDMXProtocolModule

Implements the Protocol Module, that enables specific Protocol implementations

Windows
MacOS
Linux

Inheritance Hierarchy

IModuleInterface

FDMXProtocolModule

References

Module

DMXProtocol

Header

/Engine/Plugins/VirtualProduction/DMX/DMXProtocol/Source/DMXProtocol/Public/DMXProtocolModule.h

Include

#include "DMXProtocolModule.h"

Syntax

class FDMXProtocolModule : public IModuleInterface

Remarks

Implements the Protocol Module, that enables specific Protocol implementations

Functions

Name Description

Public function Static

FDMXProtocol...

 

Get()

Get the instance of this module.

Public function Virtual

IDMXProtocol...

 

GetProtocol

(
    const FName InProtocolName
)

If protocol exists return the pointer otherwise it create a new protocol first and then return the pointer.

Public function Const

const TMap< ...

 

GetProtocolFactories()

Get the reference to all protocol factories map

Public function Const

const TMap< ...

 

GetProtocols()

Get the reference to all protocols map

Public function

void

 

RegisterProtocol

(
    const FName& ProtocolName,
    IDMXProtocolFactory* Factory
)

Public function

void

 

UnregisterProtocol

(
    const FName& ProtocolName
)

Overridden from IModuleInterface

Name Description

Public function Virtual

void

 

ShutdownModule()

Called before the module is unloaded, right before the module object is destroyed.

Public function Virtual

void

 

StartupModule()

Called right after the module DLL has been loaded and the module object has been created Load dependent modules here, and they will be guaranteed to be available during ShutdownModule.

Constants

Name

Description

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