Files
UnrealEngineUWP/Engine/Source/Runtime/Online/BackgroundHTTP/Public/BackgroundHttpModule.h
ryan durand 0f0464a30e Updating copyright for Engine Runtime.
#rnx
#rb none


#ROBOMERGE-OWNER: ryan.durand
#ROBOMERGE-AUTHOR: ryan.durand
#ROBOMERGE-SOURCE: CL 10869210 via CL 10869511 via CL 10869900
#ROBOMERGE-BOT: (v613-10869866)

[CL 10870549 by ryan durand in Main branch]
2019-12-26 14:45:42 -05:00

60 lines
1.6 KiB
C++

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
#include "CoreMinimal.h"
#include "Misc/CoreMisc.h"
#include "Interfaces/IBackgroundHttpRequest.h"
#include "Interfaces/IBackgroundHttpManager.h"
#include "Modules/ModuleInterface.h"
/**
* Module for Http Background request implementations
*/
class FBackgroundHttpModule :
public IModuleInterface
{
public:
/**
* Singleton-like access to this module's interface. This is just for convenience!
* Beware of calling this during the shutdown phase, though. Your module might have been unloaded already.
*
* @return Returns singleton instance, loading the module on demand if needed
*/
BACKGROUNDHTTP_API static FBackgroundHttpModule& Get();
/**
* Creates a BackgroundRequest through the appropriate platform-layer.
*
* @return SharedRef to the new BackgroundRequest.
*/
BACKGROUNDHTTP_API static FBackgroundHttpRequestPtr CreateBackgroundRequest();
/**
* Gets the current BackgroundHttpManager from the appropriate platform layer.
*
* @return SharedPtr to the BackgroundHttpManager.
*/
BACKGROUNDHTTP_API FBackgroundHttpManagerPtr GetBackgroundHttpManager();
public:
// IModuleInterface
/**
* Called when Background Http module is loaded
*/
virtual void StartupModule() override;
/**
* Called when Background Http module is unloaded
*/
virtual void ShutdownModule() override;
private:
/** Keeps track of Background Http requests while they are being processed */
FBackgroundHttpManagerPtr BackgroundHttpManager;
/** singleton for the module while loaded and available */
static FBackgroundHttpModule* Singleton;
};