IMessageTransportHandler Class Reference

#include <IMessageTransportHandler.h>

Inheritance diagram for IMessageTransportHandler:

Public Member Functions
virtual void	DiscoverTransportNode (const FGuid &NodeId)=0
virtual void	ForgetTransportNode (const FGuid &NodeId)=0
virtual void	ReceiveTransportMessage (const TSharedRef< IMessageContext, ESPMode::ThreadSafe > &Context, const FGuid &NodeId)=0
virtual	~IMessageTransportHandler ()

Detailed Description

Interface for message transport event handlers.

This interface is typically implemented by message bridges and other classes that manage a message transport and wish to receive messages from it. This interface also notifies implementors of discovered and lost transport nodes.

A transport node is the internal representation of a remote message endpoint that may exist in a different process or on a different computer. The actual implementation of these nodes depends on the transport layer. It may be a network socket connection, a named pipe, or some other communication technology.

Each transport node gets a globally unique identifier that can be used by a message bridge to translate local message addresses to remote message endpoints. When a message endpoint on the message bus sends a message to a specific message address that represents a remote endpoint, the message bridge maps the address to a transport identifier, which is then mapped again to the corresponding connection in the transport layer.

See also

IMessageBridge, IMessageBus, IMessageContext, IMessageTransport

Constructor & Destructor Documentation

~IMessageTransportHandler()

virtual IMessageTransportHandler::~IMessageTransportHandler ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

DiscoverTransportNode()

virtual void IMessageTransportHandler::DiscoverTransportNode ( const FGuid &  NodeId )

pure virtual

Called by message transports when a transport node has been discovered.

Parameters

NodeId

The identifier of the discovered transport node.

See also

ForgetTransportNode

Implemented in FMessageBridge.

ForgetTransportNode()

virtual void IMessageTransportHandler::ForgetTransportNode ( const FGuid &  NodeId )

pure virtual

Called by message transports when a transport node has been lost.

Parameters

NodeId

The identifier of the lost transport node.

See also

DiscoverTransportNode

Implemented in FMessageBridge.

ReceiveTransportMessage()

virtual void IMessageTransportHandler::ReceiveTransportMessage ( const TSharedRef< IMessageContext, ESPMode::ThreadSafe > &  Context, const FGuid &  NodeId  )

pure virtual

Called by message transports when a message was received.

Parameters

Context	The context of the received message.
NodeId	The identifier of the transport node that received the message.

Implemented in FMessageBridge.

---

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

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