Navigation
API > API/Runtime > API/Runtime/Messaging
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.
| Name | INetworkMessagingExtension |
| Type | class |
| Header File | /Engine/Source/Runtime/Messaging/Public/INetworkMessagingExtension.h |
| Include Path | #include "INetworkMessagingExtension.h" |
Syntax
class INetworkMessagingExtension : public IModularFeature
Derived Classes
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| ModularFeatureName | FName | The modular feature name to get the messaging extension. | INetworkMessagingExtension.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddEndpoint
(
const FString& InEndpoint |
Add an endpoint to the running configuration of this messaging service This change is transient and does not modified saved configuration. | INetworkMessagingExtension.h | |
bool CanProvideNetworkStatistics() |
Indicates if this network messaging interface can return network statistics. | INetworkMessagingExtension.h | |
TArray< FString > GetKnownEndpoints () |
Returns the list of internet addresses known by the transport. | INetworkMessagingExtension.h | |
FMessageTransportStatistics GetLatestNetworkStatistics
(
FGuid NodeId |
Return the current network counters for the given Node endpoint | INetworkMessagingExtension.h | |
| The list of network addresses that we are currently listening on. | INetworkMessagingExtension.h | ||
FName GetName() |
Get the name of this messaging extension. | INetworkMessagingExtension.h | |
FGuid GetNodeIdFromAddress
(
const FMessageAddress& MessageAddress |
Return the node ID corresponding to MessageAddress | INetworkMessagingExtension.h | |
bool IsSupportEnabled() |
Indicate if support is available for this extension | INetworkMessagingExtension.h | |
FOnInboundTransferDataUpdated & OnInboundTransferUpdatedFromThread () |
Delegate invoked when any transmission statistics are update for inbound (received). | INetworkMessagingExtension.h | |
FOnOutboundTransferDataUpdated & OnOutboundTransferUpdatedFromThread () |
Delegate invoked when any transmission statistics are updated for outbound nodes (sent). | INetworkMessagingExtension.h | |
void RemoveEndpoint
(
const FString& InEndpoint |
Remove a static endpoint from the running configuration of the UDP messaging service This change is transient and does not modified saved configuration. | INetworkMessagingExtension.h | |
void RestartServices () |
Start or restart this messaging extension service for MessageBus using its current running configuration which might include modifications to endpoints | INetworkMessagingExtension.h | |
void ShutdownServices () |
Shutdown this messaging extension services for MessageBus and remove any configuration modification. | INetworkMessagingExtension.h |