1. Epic GamesDeveloper
  3. FConcertSyncSessionDatabase

FConcertSyncSessionDatabase

Database of activities that have happened in a Concert Sync Session.

API > API/Plugins > API/Plugins/ConcertSyncCore

Database of activities that have happened in a Concert Sync Session. Stores the activity index and their associated data.

   
Name FConcertSyncSessionDatabase
Type class
Header File /Engine/Plugins/Developer/Concert/ConcertSync/ConcertSyncCore/Source/ConcertSyncCore/Public/ConcertSyncSessionDatabase.h
Include Path #include "ConcertSyncSessionDatabase.h"

Syntax

class FConcertSyncSessionDatabase

Constructors

Name Remarks Include Path Unreal Specifiers
Defined here where TUniquePtr can see the definition of FConcertFileCache and FConcertSyncSessionDatabaseStatements as the TUniquePtr constructor/destructor cannot work with a forward declared type ConcertSyncSessionDatabase.h  
  ConcertSyncSessionDatabase.h  
  ConcertSyncSessionDatabase.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FConcertSyncSessionDatabase()

   ConcertSyncSessionDatabase.h  

Typedefs

Name Type Remarks Include Path
FProcessPackageRequest TFunctionRef< bool(const FConcertPackageInfo &PackageInfo, const FString &DataFilename)>   ConcertSyncSessionDatabase.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ActivityProducedEvent FOnActivityProduced Called when an activity is produced ConcertSyncSessionDatabase.h  
Database TUniquePtr< FSQLiteDatabase > Internal SQLite database ConcertSyncSessionDatabase.h  
DeferredLargePackageIOPtr TPimplPtr< struct FDeferredLargePackageIOImpl >   ConcertSyncSessionDatabase.h  
PackageFileCache TUniquePtr< FConcertFileCache > In-memory cache of on-disk package files ConcertSyncSessionDatabase.h  
SessionPath FString Root path to store all session data under ConcertSyncSessionDatabase.h  
Statements TUniquePtr< FConcertSyncSessionDatabaseStatements > Prepared statements for the currently open database ConcertSyncSessionDatabase.h  
TransactionFileCache TUniquePtr< FConcertFileCache > In-memory cache of on-disk transaction files ConcertSyncSessionDatabase.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool AddConnectionActivity ( const FConcertSyncConnectionActivity& InConnectionActivity,
int64& OutActivityId,
int64& OutConnectionEventId
)

 Add a new connection activity to this database, assigning it both an activity and connection event ID. ConcertSyncSessionDatabase.h  

bool AddDummyPackageEvent ( const FName InPackageName,
int64& OutPackageEventId
)

 Add a new dummy package event to this database, assigning it a package event ID. ConcertSyncSessionDatabase.h  

bool AddLockActivity ( const FConcertSyncLockActivity& InLockActivity,
int64& OutActivityId,
int64& OutLockEventId
)

 Add a new lock activity to this database, assigning it both an activity and lock event ID. ConcertSyncSessionDatabase.h  

bool AddPackageActivity ( const FConcertSyncActivity& InPackageActivity,
const FConcertPackageInfo& InPackageInfo,
FConcertPackageDataStream& InPackageDataStream,
int64& OutActivityId,
int64& OutPackageEventId
)

 Add a new package activity to this database, assigning it both an activity and package event ID. ConcertSyncSessionDatabase.h  

bool AddPersistEventForHeadRevision ( FName InPackageName,
int64& OutPersistEventId
)

 Add a package event ID for the head revision to the persist events in this database, if not already existing. ConcertSyncSessionDatabase.h  

bool AddReplicationActivity ( const FConcertSyncReplicationActivity& InReplicationActivity,
int64& OutActivityId,
int64& OutReplicationEventId
)

 Add a new replication activity to this database, assigning it both an activity and lock event ID. ConcertSyncSessionDatabase.h  

bool AddTransactionActivity ( const FConcertSyncTransactionActivity& InTransactionActivity,
int64& OutActivityId,
int64& OutTransactionEventId
)

 Add a new transaction activity to this database, assigning it both an activity and transaction event ID. ConcertSyncSessionDatabase.h  

bool Close ( const bool InDeleteDatabase
)

 Close an open database file. ConcertSyncSessionDatabase.h  

bool EnumerateActivities ( FIterateActivityFunc InCallback
) const

 Enumerate the generic part of the activities in this database. ConcertSyncSessionDatabase.h  

bool EnumerateActivitiesForEventType ( const EConcertSyncActivityEventType InEventType,
FIterateActivityFunc InCallback
) const

 Enumerate all the activities in this database of the given type. ConcertSyncSessionDatabase.h  

bool EnumerateActivitiesInRange ( const int64 InFirstActivityId,
const int64 InMaxNumActivities,
FIterateActivityFunc InCallback
) const

 Enumerate all the activities in this database in the given range. ConcertSyncSessionDatabase.h  

bool EnumerateActivityIdsAndEventTypes ( TFunctionRef< bool(int64, EConcertSyncActivityEventType)> InCallback
) const

 Enumerate the IDs and event types of all the activities in this database. ConcertSyncSessionDatabase.h  

bool EnumerateActivityIdsAndEventTypesInRange ( const int64 InFirstActivityId,
const int64 InMaxNumActivities,
TFunctionRef< bool(int64, EConcertSyncActivityEventType)> InCallback
) const

 Enumerate the IDs and event types of the activities in this database in the given range. ConcertSyncSessionDatabase.h  

bool EnumerateActivityIdsWithEventTypesAndFlagsInRange ( const int64 InFirstActivityId,
const int64 InMaxNumActivities,
TFunctionRef< bool(int64, EConcertSyncActivityEventType, EConcertSyncActivityFlags)> InCallback
) const

 Enumerate the IDs, event types and flags of the activities in this database in the given range. ConcertSyncSessionDatabase.h  

bool EnumerateConnectionActivities ( TFunctionRef< bool(FConcertSyncConnectionActivity&&)> InCallback
) const

 Enumerate all the connection activities in this database. ConcertSyncSessionDatabase.h  

bool EnumerateEndpointIds ( TFunctionRef< bool(FGuid)> InCallback
) const

 Enumerate all the endpoint IDs in this database. ConcertSyncSessionDatabase.h  

bool EnumerateEndpoints ( TFunctionRef< bool(FConcertSyncEndpointIdAndData&&)> InCallback
) const

 Enumerate all the endpoints in this database. ConcertSyncSessionDatabase.h  

bool EnumerateHeadRevisionPackageData ( TFunctionRef< bool(const FConcertPackageInfo&, FConcertPackageDataStream&)> InCallback
) const

 Enumerate the head revision package data for all packages in this database. ConcertSyncSessionDatabase.h  

bool EnumerateLiveTransactionEventIdsForPackage ( const FName InPackageName,
TFunctionRef< bool(int64)> InCallback
) const

 Enumerate the IDs of any live transaction events for the given package name. ConcertSyncSessionDatabase.h  

bool EnumerateLockActivities ( TFunctionRef< bool(FConcertSyncLockActivity&&)> InCallback
) const

 Enumerate all the lock activities in this database. ConcertSyncSessionDatabase.h  

bool EnumeratePackageActivities ( FIteratePackageActivityFunc InCallback
) const

 Enumerate all the package activities in this database. ConcertSyncSessionDatabase.h  

bool EnumeratePackageNamesWithHeadRevision ( TFunctionRef< bool(FName)> InCallback,
bool IgnorePersisted
) const

 Enumerate package names for packages with a head revision (at least one package event) ConcertSyncSessionDatabase.h  

bool EnumeratePackageNamesWithLiveTransactions ( TFunctionRef< bool(FName)> InCallback
) const

 Enumerate the names of of any packages that have live transaction events. ConcertSyncSessionDatabase.h  

bool EnumerateReplicationActivities ( TFunctionRef< bool(FConcertSyncReplicationActivity&&)> InCallback
) const

 Enumerate all the replication activities in this database. ConcertSyncSessionDatabase.h  

bool EnumerateTransactionActivities ( TFunctionRef< bool(FConcertSyncTransactionActivity&&)> InCallback
) const

 Enumerate all the transaction activities in this database. ConcertSyncSessionDatabase.h  

void FlushAsynchronousTasks()

 Flush any ongoing asynchronous tasks. ConcertSyncSessionDatabase.h  

bool GetActivity ( const int64 InActivityId,
FConcertSyncActivity& OutActivity
) const

 Get the generic part of an activity from this database. ConcertSyncSessionDatabase.h  

bool GetActivityEventType ( const int64 InActivityId,
EConcertSyncActivityEventType& OutEventType
) const

 Get the type of an activity in this database. ConcertSyncSessionDatabase.h  

bool GetActivityForEvent ( const int64 InEventId,
const EConcertSyncActivityEventType InEventType,
FConcertSyncActivity& OutActivity
) const

 Get the generic part of an activity for an event in this database. ConcertSyncSessionDatabase.h  

bool GetActivityMaxId ( int64& OutActivityId
) const

 Get the maximum ID of the activities in this database. ConcertSyncSessionDatabase.h  

bool GetConnectionActivity ( const int64 InActivityId,
FConcertSyncConnectionActivity& OutConnectionActivity
) const

 Get a connection activity from this database. ConcertSyncSessionDatabase.h  

bool GetConnectionActivityForEvent ( const int64 InConnectionEventId,
FConcertSyncConnectionActivity& OutConnectionActivity
) const

 Get a connection activity for an event in this database. ConcertSyncSessionDatabase.h  

bool GetConnectionEvent ( const int64 InConnectionEventId,
FConcertSyncConnectionEvent& OutConnectionEvent
) const

 Get a connection event from this database. ConcertSyncSessionDatabase.h  

bool GetEndpoint ( const FGuid& InEndpointId,
FConcertSyncEndpointData& OutEndpointData
) const

 Get an endpoint from this database. ConcertSyncSessionDatabase.h  
Get the filename of the currently open database, or an empty string. ConcertSyncSessionDatabase.h  

FString GetLastError()

 Get the last error reported by this database. ConcertSyncSessionDatabase.h  

bool GetLiveTransactionEventIds ( TArray< int64 >& OutTransactionEventIds
) const

 Get the IDs of any live transaction events. ConcertSyncSessionDatabase.h  

bool GetLiveTransactionEventIdsForPackage ( const FName InPackageName,
TArray< int64 >& OutTransactionEventIds
) const

 Get the IDs of any live transaction events for the given package name. ConcertSyncSessionDatabase.h  

bool GetLockActivity ( const int64 InActivityId,
FConcertSyncLockActivity& OutLockActivity
) const

 Get a lock activity from this database. ConcertSyncSessionDatabase.h  

bool GetLockActivityForEvent ( const int64 InLockEventId,
FConcertSyncLockActivity& OutLockActivity
) const

 Get a lock activity for an event in this database. ConcertSyncSessionDatabase.h  

bool GetLockEvent ( const int64 InLockEventId,
FConcertSyncLockEvent& OutLockEvent
) const

 Get a lock event from this database. ConcertSyncSessionDatabase.h  

bool GetPackageActivity ( const int64 InActivityId,
FConsumePackageActivityFunc PackageActivityFn
) const

 Get a package activity from this database. ConcertSyncSessionDatabase.h  

bool GetPackageActivityForEvent ( const int64 InPackageEventId,
FIteratePackageActivityFunc PackageActivityFn
) const

 Get a package activity for an event in this database. ConcertSyncSessionDatabase.h  

bool GetPackageDataForRevision ( const FName InPackageName,
const TFunctionRef< void(const FConcertPackageInfo&, FConcertPackageDataStream&)>& InCallback,
const int64* InPackageRevision
) const

 Get the data from this database for the given package name for the given revision. ConcertSyncSessionDatabase.h  

bool GetPackageEvent ( const int64 InPackageEventId,
const TFunctionRef< void(FConcertSyncPackageEventData&)>& PackageEventFn
) const

 Get a package event from this database. ConcertSyncSessionDatabase.h  

bool GetPackageEventMetaData ( const int64 InPackageEventId,
int64& OuptPackageRevision,
FConcertPackageInfo& OutPackageInfo
) const

 Get a package event meta data (omitting the package data itself) from this database. ConcertSyncSessionDatabase.h  

bool GetPackageHeadEventFromName ( const FName InPackageName,
int64& OutPackageEventId
)

 Get Package Event Id from Package Name. The event id will be from the head revision of the package. ConcertSyncSessionDatabase.h  

bool GetPackageHeadRevision ( const FName InPackageName,
int64& OutRevision
) const

 Get the head revision in this database for the given package name. ConcertSyncSessionDatabase.h  

bool GetPackageInfoForRevision ( const FName InPackageName,
FConcertPackageInfo& OutPackageInfo,
const int64* InPackageRevision
) const

 Get the data from this database for the given package name for the given revision. ConcertSyncSessionDatabase.h  

TOptional< int64 > GetPackageSizeForRevision ( const FName InPackageName,
const int64* InPackageRevision
) const

 Gets the package size in bytes of a package ConcertSyncSessionDatabase.h  

bool GetReplicationActivity ( const int64 InActivityId,
FConcertSyncReplicationActivity& OutReplicationActivity
) const

 Get a replication activity from this database. ConcertSyncSessionDatabase.h  

bool GetReplicationActivityForEvent ( const int64 InEventId,
FConcertSyncReplicationActivity& OutReplicationActivity
) const

 Get a replication activity from this database by its event ID ConcertSyncSessionDatabase.h  

bool GetReplicationEvent ( const int64 InReplicationEventId,
FConcertSyncReplicationEvent& OutReplicationEvent
) const

 Get a replication event from this database. ConcertSyncSessionDatabase.h  

bool GetReplicationMaxEventIdByClientAndType ( const FGuid& EndpointId,
EConcertSyncReplicationActivityType ActivityType,
int64& OutReplicationEventId
) const

 Get the maximum ID of the replication events in this database that was triggered by EndpointId and had ActivityType. ConcertSyncSessionDatabase.h  

bool GetTransactionActivity ( const int64 InActivityId,
FConcertSyncTransactionActivity& OutTransactionActivity
) const

 Get a transaction activity from this database. ConcertSyncSessionDatabase.h  

bool GetTransactionActivityForEvent ( const int64 InTransactionEventId,
FConcertSyncTransactionActivity& OutTransactionActivity
) const

 Get a transaction activity for an event in this database. ConcertSyncSessionDatabase.h  

bool GetTransactionEvent ( const int64 InTransactionEventId,
FConcertSyncTransactionEvent& OutTransactionEvent,
const bool InMetaDataOnly
) const

 Get a transaction event from this database. ConcertSyncSessionDatabase.h  

bool GetTransactionMaxEventId ( int64& OutTransactionEventId
) const

 Get the maximum ID of the transaction events in this database. ConcertSyncSessionDatabase.h  

bool HasWritePackageTasksCompleted()

 Has all asynchronous package tasks completed. ConcertSyncSessionDatabase.h  

bool IsHeadRevisionPackageEvent ( const int64 InPackageEventId,
bool& OutIsHeadRevision
) const

 Check whether the given package event ID is currently for the head revision of the package in the event. ConcertSyncSessionDatabase.h  

bool IsLiveTransactionEvent ( const int64 InTransactionEventId,
bool& OutIsLive
) const

 Check whether the given transaction event ID is currently for a live transaction event. ConcertSyncSessionDatabase.h  

bool IsValid()

 Is this a valid database? (ie, has been successfully opened). ConcertSyncSessionDatabase.h  

FOnActivityProduced & OnActivityProduced()

   ConcertSyncSessionDatabase.h  

bool Open ( const FString& InSessionPath,
const ESQLiteDatabaseOpenMode InOpenMode
)

 Open (or create) a database file. ConcertSyncSessionDatabase.h  

bool Open ( const FString& InSessionPath
)

 Open (or create) a database file. ConcertSyncSessionDatabase.h  

bool PackageHasLiveTransactions ( const FName InPackageName,
bool& OutHasLiveTransaction
) const

 Get if a Package has any live transactions ConcertSyncSessionDatabase.h  

bool SetActivities ( const TSet< int64 >& ActivityIds,
TFunctionRef< void(FConcertSyncActivity&)> UpdateCallback
)

 Iterates the given range, calls UpdateCallback on each element, and commits the update. ConcertSyncSessionDatabase.h  

bool SetConnectionActivity ( const FConcertSyncConnectionActivity& InConnectionActivity
)

 Set a connection activity in this database, creating or replacing it. ConcertSyncSessionDatabase.h  

bool SetEndpoint ( const FGuid& InEndpointId,
const FConcertSyncEndpointData& InEndpointData
)

 Set an endpoint in this database, creating or replacing it. ConcertSyncSessionDatabase.h  

bool SetLockActivity ( const FConcertSyncLockActivity& InLockActivity
)

 Set a lock activity in this database, creating or replacing it. ConcertSyncSessionDatabase.h  

bool SetPackageActivity ( const FConcertSyncActivity& InPackageActivity,
FConcertSyncPackageEventData& InPackageActivityEvent,
const bool bMetaDataOnly
)

 Set a package activity in this database, creating or replacing it. ConcertSyncSessionDatabase.h  

bool SetReplicationActivity ( const FConcertSyncReplicationActivity& InReplicationActivity
)

 Set a replication activity in this database, creating or replacing it. ConcertSyncSessionDatabase.h  

bool SetTransactionActivity ( const FConcertSyncTransactionActivity& InTransactionActivity,
const bool bMetaDataOnly
)

 Set a transaction activity in this database, creating or replacing it. ConcertSyncSessionDatabase.h  

void UpdateAsynchronousTasks()

 Check Asynchronous Tasks Status ConcertSyncSessionDatabase.h  

bool UpdatePackageEvent ( const int64 InPackageEventId,
FConcertSyncPackageEventData& PackageEvent
)

 Update the specified package event. ConcertSyncSessionDatabase.h  

bool UpdateTransactionEvent ( const int64 InTransactionEventId,
const FConcertSyncTransactionEvent& InTransactionEvent
)

 Update the specified transaction event. ConcertSyncSessionDatabase.h  

Operators

Name Remarks Include Path Unreal Specifiers
  ConcertSyncSessionDatabase.h  
  ConcertSyncSessionDatabase.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page