IMessageTransport

Interface for message transport technologies.

Choose your operating system:

Windows

macOS

Linux

References

Module

Messaging

Header

/Engine/Source/Runtime/Messaging/Public/IMessageTransport.h

Include

#include "IMessageTransport.h"

Syntax

class IMessageTransport

Remarks

Interface for message transport technologies.

Licensees can implement this interface to add support for custom message transport technologies that are not supported out of the box, i.e. custom network protocols or APIs.

Destructors

Name Description

Protected function Virtual

~IMessageTransport()

Virtual destructor.

Functions

Name Description

Public function Const

FName

 

GetDebugName()

Gets the name of this transport (for debugging purposes).

Public function

bool

 

StartTransport

(
    IMessageTransportHandler& Handler
)

Starts up the message transport.

Public function

void

 

StopTransport()

Shuts down the message transport.

Public function

bool

 

TransportMessage

(
    const TSharedRef< IMessageContext, ...,
    const TArray< FGuid >& Recipients
)

Transports the given message data to the specified network nodes.