IMessagingModule.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Modules/ModuleInterface.h"
#include "Modules/ModuleManager.h"
#include "Templates/SharedPointer.h"
#include "Delegates/Delegate.h"
 
class IAuthorizeMessageRecipients;
class IMessageBridge;
class IMessageBus;
class IMessageTransport;
 
struct FMessageAddress;
 
DECLARE_LOG_CATEGORY_EXTERN(LogMessaging, Log, All);
 
class IMessagingModule
    : public IModuleInterface
{
    using FMessageBusWeakPtr = TWeakPtr<IMessageBus, ESPMode::ThreadSafe>;
 
public:
    DECLARE_MULTICAST_DELEGATE_OneParam(FOnMessageBusStartupOrShutdown, FMessageBusWeakPtr);
    
    virtual FOnMessageBusStartupOrShutdown& OnMessageBusStartup() = 0;
 
    virtual FOnMessageBusStartupOrShutdown& OnMessageBusShutdown() = 0;
 
    virtual TSharedPtr<IMessageBridge, ESPMode::ThreadSafe> CreateBridge(const FMessageAddress& Address, const TSharedRef<IMessageBus, ESPMode::ThreadSafe>& Bus, const TSharedRef<IMessageTransport, ESPMode::ThreadSafe>& Transport) = 0;
 
    virtual TSharedPtr<IMessageBus, ESPMode::ThreadSafe> CreateBus(const TSharedPtr<IAuthorizeMessageRecipients>& RecipientAuthorizer = nullptr) = 0;
 
    virtual TSharedPtr<IMessageBus, ESPMode::ThreadSafe> CreateBus(FString InName, const TSharedPtr<IAuthorizeMessageRecipients>& RecipientAuthorizer = nullptr) = 0;
 
    virtual TSharedPtr<IMessageBus, ESPMode::ThreadSafe> GetDefaultBus() const = 0;
 
    virtual TArray<TSharedRef<IMessageBus, ESPMode::ThreadSafe>> GetAllBuses() const = 0;
 
public:
 
    static IMessagingModule& Get()
    {
#if PLATFORM_IOS
        static IMessagingModule& MessageModule = FModuleManager::LoadModuleChecked<IMessagingModule>("Messaging");
        return MessageModule;
#else
        return FModuleManager::LoadModuleChecked<IMessagingModule>("Messaging");
#endif
    }
 
public:
 
    virtual ~IMessagingModule() { }
};