FDMXProtocolModule

Implements the Protocol Module, that enables specific Protocol implementations.

Choose your operating system:

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.

For use in Engine, see comments in DMXPortManager.h For protocol development, see comments in IDMXProtocol.h

Functions

Name Description

Public function Static

FDMXProtocol...

 

Get()

Get the instance of this module.

Public function Static

FDMXOnReques...

 

GetOnRequestProtocolBlocklist()

Public function Static

FDMXOnReques...

 

GetOnRequestProtocolRegistration()

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

 

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.

Classes

Name

Description

Public class

FDMXOnRequestProtocolBlocklistEvent

Event broadcast so other Plugins can block specific protocols from registering.

Public class

FDMXOnRequestProtocolRegistrationEvent

Event Broadcast when protocols need to register with the Protocol Module.

Constants

Deprecated Functions

Name Description

Public function

void

 

RegisterProtocol

(
    const FName& ProtocolName,
    IDMXProtocolFactory* Factory
)

Please use the OnRequestProtocolRegistration event instead.