IMessageTransport Class Reference

#include <IMessageTransport.h>

Public Member Functions
virtual FName	GetDebugName () const =0
virtual bool	StartTransport (IMessageTransportHandler &Handler)=0
virtual void	StopTransport ()=0
virtual bool	TransportMessage (const TSharedRef< IMessageContext, ESPMode::ThreadSafe > &Context, const TArray< FGuid > &Recipients)=0

Protected Member Functions
virtual	~IMessageTransport ()

Detailed Description

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.

Constructor & Destructor Documentation

~IMessageTransport()

virtual IMessageTransport::~IMessageTransport ( )

inlineprotectedvirtual

Virtual destructor.

Member Function Documentation

GetDebugName()

virtual FName IMessageTransport::GetDebugName ( ) const

pure virtual

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

Returns

The debug name.

StartTransport()

virtual bool IMessageTransport::StartTransport ( IMessageTransportHandler &  Handler )

pure virtual

Starts up the message transport.

Parameters

Handler

The handler of inbound transport messages and events.

Returns

Whether the transport was started successfully.

See also

StopTransport

StopTransport()

virtual void IMessageTransport::StopTransport ( )

pure virtual

Shuts down the message transport.

See also

StartTransport

TransportMessage()

virtual bool IMessageTransport::TransportMessage ( const TSharedRef< IMessageContext, ESPMode::ThreadSafe > &  Context, const TArray< FGuid > &  Recipients  )

pure virtual

Transports the given message data to the specified network nodes.

Parameters

Context	The context of the message to transport.
Recipients	The transport nodes to send the message to.

Returns

true if the message is being transported, false otherwise.

---

The documentation for this class was generated from the following file:

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