INetworkMessagingExtension Class Reference

#include <INetworkMessagingExtension.h>

Inheritance diagram for INetworkMessagingExtension:

Public Member Functions
virtual FName	GetName () const =0
virtual bool	IsSupportEnabled () const =0
virtual void	RestartServices ()=0
virtual TArray< FString >	GetListeningAddresses () const =0
virtual bool	CanProvideNetworkStatistics () const =0
virtual FMessageTransportStatistics	GetLatestNetworkStatistics (FGuid NodeId) const =0
virtual FGuid	GetNodeIdFromAddress (const FMessageAddress &MessageAddress) const =0
virtual FOnOutboundTransferDataUpdated &	OnOutboundTransferUpdatedFromThread ()=0
virtual FOnInboundTransferDataUpdated &	OnInboundTransferUpdatedFromThread ()=0
virtual void	ShutdownServices ()=0
virtual TArray< FString >	GetKnownEndpoints () const =0
virtual void	AddEndpoint (const FString &InEndpoint)=0
virtual void	RemoveEndpoint (const FString &InEndpoint)=0

Static Public Attributes
static MESSAGING_API FName	ModularFeatureName

Detailed Description

Interface for the messaging module network extension Plugins or modules implementing messaging transport for MessageBus can implement this modular feature to provide control on the service it provides.

Member Function Documentation

AddEndpoint()

virtual void INetworkMessagingExtension::AddEndpoint ( const FString &  InEndpoint )

pure virtual

Add an endpoint to the running configuration of this messaging service This change is transient and does not modified saved configuration.

Parameters

InEndpoint

the endpoint string to add to the running service, should be in the form <ipv4:port>.

CanProvideNetworkStatistics()

virtual bool INetworkMessagingExtension::CanProvideNetworkStatistics ( ) const

pure virtual

Indicates if this network messaging interface can return network statistics.

GetKnownEndpoints()

virtual TArray< FString > INetworkMessagingExtension::GetKnownEndpoints ( ) const

pure virtual

Returns the list of internet addresses known by the transport. The addresses are in the form of <address:port>

GetLatestNetworkStatistics()

virtual FMessageTransportStatistics INetworkMessagingExtension::GetLatestNetworkStatistics ( FGuid  NodeId ) const

pure virtual

Return the current network counters for the given Node endpoint

GetListeningAddresses()

virtual TArray< FString > INetworkMessagingExtension::GetListeningAddresses ( ) const

pure virtual

The list of network addresses that we are currently listening on. The string must be in the form of <address:port>

GetName()

virtual FName INetworkMessagingExtension::GetName ( ) const

pure virtual

Get the name of this messaging extension.

GetNodeIdFromAddress()

virtual FGuid INetworkMessagingExtension::GetNodeIdFromAddress ( const FMessageAddress &  MessageAddress ) const

pure virtual

Return the node ID corresponding to MessageAddress

IsSupportEnabled()

virtual bool INetworkMessagingExtension::IsSupportEnabled ( ) const

pure virtual

Indicate if support is available for this extension

Returns

true if the service can be successfully started.

OnInboundTransferUpdatedFromThread()

virtual FOnInboundTransferDataUpdated & INetworkMessagingExtension::OnInboundTransferUpdatedFromThread ( )

pure virtual

Delegate invoked when any transmission statistics are update for inbound (received). This delegate may get called from another thread. Please consider thread safety when receiving this delegate.

OnOutboundTransferUpdatedFromThread()

virtual FOnOutboundTransferDataUpdated & INetworkMessagingExtension::OnOutboundTransferUpdatedFromThread ( )

pure virtual

Delegate invoked when any transmission statistics are updated for outbound nodes (sent). This delegate may get called from another thread. Please consider thread safety when receiving this delegate.

RemoveEndpoint()

virtual void INetworkMessagingExtension::RemoveEndpoint ( const FString &  InEndpoint )

pure virtual

Remove a static endpoint from the running configuration of the UDP messaging service This change is transient and does not modified saved configuration.

Parameters

InEndpoint

the endpoint to remove from the running service, should be in the form <ipv4:port>.

RestartServices()

virtual void INetworkMessagingExtension::RestartServices ( )

pure virtual

Start or restart this messaging extension service for MessageBus using its current running configuration which might include modifications to endpoints

See also

AddEndpoint, RemoveEndpoint

ShutdownServices()

virtual void INetworkMessagingExtension::ShutdownServices ( )

pure virtual

Shutdown this messaging extension services for MessageBus and remove any configuration modification. Using RestartServices after ShutdownServices will start the service with an unaltered configuration

See also

RestartServices

Member Data Documentation

ModularFeatureName

FName INetworkMessagingExtension::ModularFeatureName

static

The modular feature name to get the messaging extension.

---

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

• Engine/Source/Runtime/Messaging/Public/INetworkMessagingExtension.h
• Engine/Source/Runtime/Messaging/Private/MessagingModule.cpp