Engine/Source/Programs/Unsync/Private/UnsyncCmdSync.h

// Copyright Epic Games, Inc. All Rights Reserved.

#pragma once

#include "UnsyncCommon.h"
#include "UnsyncCore.h"
#include "UnsyncRemote.h"

namespace unsync {

struct FAuthDesc;

struct FCmdSyncOptions
{
	FAlgorithmOptions Algorithm;

	FPath Source;
	FPath Target;
	FPath SourceManifestOverride;
	FPath ScavengeRoot;
	uint32 ScavengeDepth = 5;
	uint64 BackgroundTaskMemoryBudget = 2_GB;

	std::vector<FPath> Overlays;

	FRemoteDesc Remote;
	FAuthDesc*	AuthDesc = nullptr;

	bool bFullDifference = false;
	bool bFullSourceScan = false;
	bool bCleanup		 = false;

	bool bCheckAvailableSpace = true;

	bool bValidateTargetFiles = true;  // WARNING: turning this off is intended only for testing/profiling

	FSyncFilter* Filter = nullptr;
};

int32 CmdSync(const FCmdSyncOptions& Options);

}  // namespace unsync
Import Unsync into the main source tree This is a binary patching and incremental downloading tool, similar to rsync or zsync. It aims to improve the large binary download processes that previously were served by robocopy (i.e. full packages produced by the build farm). The original code can be found in `//depot/usr/yuriy.odonnell/unsync`. This commit is a branch from the original location to preserve history. While the codebase is designed to be self-contained and does not depend on any engine libraries, it mostly follows the UE coding guidelines and can be built with UBT. Currently only Windows is supported, however the tool is expected to also work on Mac and Linux in the future. #rb Martin.Ridgers #preflight skip [CL 18993571 by Yuriy ODonnell in ue5-main branch] 2022-02-15 04:30:27 -05:00			`// Copyright Epic Games, Inc. All Rights Reserved.`

			`#pragma once`

			`#include "UnsyncCommon.h"`
			`#include "UnsyncCore.h"`
			`#include "UnsyncRemote.h"`

			`namespace unsync {`

unsync - Split OpenID config out of FAuthDesc into a separate structure and use auth desc to generate token cache key instead of just server address * Avoids unnecessary login steps when using different proxy servers that share auth config [CL 29877767 by yuriy odonnell in ue5-main branch] 2023-11-21 18:25:48 -05:00			`struct FAuthDesc;`

Import Unsync into the main source tree This is a binary patching and incremental downloading tool, similar to rsync or zsync. It aims to improve the large binary download processes that previously were served by robocopy (i.e. full packages produced by the build farm). The original code can be found in `//depot/usr/yuriy.odonnell/unsync`. This commit is a branch from the original location to preserve history. While the codebase is designed to be self-contained and does not depend on any engine libraries, it mostly follows the UE coding guidelines and can be built with UBT. Currently only Windows is supported, however the tool is expected to also work on Mac and Linux in the future. #rb Martin.Ridgers #preflight skip [CL 18993571 by Yuriy ODonnell in ue5-main branch] 2022-02-15 04:30:27 -05:00			`struct FCmdSyncOptions`
			`{`
			`FAlgorithmOptions Algorithm;`

unsync - Remove std::filesystem namespace alias and add wrappers for various filesystem functions #rb none #preflight skip [CL 19301694 by Yuriy ODonnell in ue5-main branch] 2022-03-08 08:17:08 -05:00			`FPath Source;`
			`FPath Target;`
			`FPath SourceManifestOverride;`
unsync - Initial implementation of the "scavenge" mode which aims to reduce download times by reusing data outside of the final sync directory This is useful for people who want to download each data set into a uniquely named directory, instead of always patching the last downloaded version. Current implementation is highly experimental and should only be used for testing purposes. #jira UE-178864 #rb none #preflight skip [CL 25190443 by Yuriy ODonnell in ue5-main branch] 2023-04-25 17:41:49 -04:00			`FPath ScavengeRoot;`
			`uint32 ScavengeDepth = 5;`
unsync - Increase default memory budget for background sync tasks and add option to set it explicitly [CL 29704425 by yuriy odonnell in ue5-main branch] 2023-11-13 20:57:57 -05:00			`uint64 BackgroundTaskMemoryBudget = 2_GB;`
Import Unsync into the main source tree This is a binary patching and incremental downloading tool, similar to rsync or zsync. It aims to improve the large binary download processes that previously were served by robocopy (i.e. full packages produced by the build farm). The original code can be found in `//depot/usr/yuriy.odonnell/unsync`. This commit is a branch from the original location to preserve history. While the codebase is designed to be self-contained and does not depend on any engine libraries, it mostly follows the UE coding guidelines and can be built with UBT. Currently only Windows is supported, however the tool is expected to also work on Mac and Linux in the future. #rb Martin.Ridgers #preflight skip [CL 18993571 by Yuriy ODonnell in ue5-main branch] 2022-02-15 04:30:27 -05:00
unsync - Add --overlay option to sync command to copy files from multiple sources into a single merged target, bump version to 1.0.43 #preflight skip #rb none [CL 20997805 by Yuriy ODonnell in ue5-main branch] 2022-07-07 22:20:00 -04:00			`std::vector<FPath> Overlays;`

Import Unsync into the main source tree This is a binary patching and incremental downloading tool, similar to rsync or zsync. It aims to improve the large binary download processes that previously were served by robocopy (i.e. full packages produced by the build farm). The original code can be found in `//depot/usr/yuriy.odonnell/unsync`. This commit is a branch from the original location to preserve history. While the codebase is designed to be self-contained and does not depend on any engine libraries, it mostly follows the UE coding guidelines and can be built with UBT. Currently only Windows is supported, however the tool is expected to also work on Mac and Linux in the future. #rb Martin.Ridgers #preflight skip [CL 18993571 by Yuriy ODonnell in ue5-main branch] 2022-02-15 04:30:27 -05:00			`FRemoteDesc Remote;`
unsync - Split OpenID config out of FAuthDesc into a separate structure and use auth desc to generate token cache key instead of just server address * Avoids unnecessary login steps when using different proxy servers that share auth config [CL 29877767 by yuriy odonnell in ue5-main branch] 2023-11-21 18:25:48 -05:00			`FAuthDesc* AuthDesc = nullptr;`
Import Unsync into the main source tree This is a binary patching and incremental downloading tool, similar to rsync or zsync. It aims to improve the large binary download processes that previously were served by robocopy (i.e. full packages produced by the build farm). The original code can be found in `//depot/usr/yuriy.odonnell/unsync`. This commit is a branch from the original location to preserve history. While the codebase is designed to be self-contained and does not depend on any engine libraries, it mostly follows the UE coding guidelines and can be built with UBT. Currently only Windows is supported, however the tool is expected to also work on Mac and Linux in the future. #rb Martin.Ridgers #preflight skip [CL 18993571 by Yuriy ODonnell in ue5-main branch] 2022-02-15 04:30:27 -05:00
unsync - Enable quick sync mode by default, reduce log verbosity, fix file attribute cache lookup, bump version to 1.0.40 #rb none #preflight skip [CL 20351881 by Yuriy ODonnell in ue5-main branch] 2022-05-24 13:55:09 -04:00			`bool bFullDifference = false;`
			`bool bFullSourceScan = false;`
			`bool bCleanup = false;`
Import Unsync into the main source tree This is a binary patching and incremental downloading tool, similar to rsync or zsync. It aims to improve the large binary download processes that previously were served by robocopy (i.e. full packages produced by the build farm). The original code can be found in `//depot/usr/yuriy.odonnell/unsync`. This commit is a branch from the original location to preserve history. While the codebase is designed to be self-contained and does not depend on any engine libraries, it mostly follows the UE coding guidelines and can be built with UBT. Currently only Windows is supported, however the tool is expected to also work on Mac and Linux in the future. #rb Martin.Ridgers #preflight skip [CL 18993571 by Yuriy ODonnell in ue5-main branch] 2022-02-15 04:30:27 -05:00
unsync - Add available disk check before starting sync, add anonymized machine name to telemetry #rb none #preflight none [CL 22490002 by Yuriy ODonnell in ue5-main branch] 2022-10-12 20:45:24 -04:00			`bool bCheckAvailableSpace = true;`

Import Unsync into the main source tree This is a binary patching and incremental downloading tool, similar to rsync or zsync. It aims to improve the large binary download processes that previously were served by robocopy (i.e. full packages produced by the build farm). The original code can be found in `//depot/usr/yuriy.odonnell/unsync`. This commit is a branch from the original location to preserve history. While the codebase is designed to be self-contained and does not depend on any engine libraries, it mostly follows the UE coding guidelines and can be built with UBT. Currently only Windows is supported, however the tool is expected to also work on Mac and Linux in the future. #rb Martin.Ridgers #preflight skip [CL 18993571 by Yuriy ODonnell in ue5-main branch] 2022-02-15 04:30:27 -05:00			`bool bValidateTargetFiles = true; // WARNING: turning this off is intended only for testing/profiling`

			`FSyncFilter* Filter = nullptr;`
			`};`

			`int32 CmdSync(const FCmdSyncOptions& Options);`

			`} // namespace unsync`