1. Epic GamesDeveloper
  3. FConcertSyncSessionDatabase

FConcertSyncSessionDatabase

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

Unreal Engine C++ API Reference > Plugins > ConcertSyncCore

References

   
Module ConcertSyncCore
Header /Engine/Plugins/Developer/Concert/ConcertSync/ConcertSyncCore/Source/ConcertSyncCore/Public/ConcertSyncSessionDatabase.h
Include #include "ConcertSyncSessionDatabase.h"

Syntax

class FConcertSyncSessionDatabase

Remarks

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

Constructors

  Type Name Description
Public function   Defined here where TUniquePtr can see the definition of FConcertFileCache and FConcertSyncSessionDatabaseStatements as the TUniquePtr constructor/destructor cannot work with a forward declared type
Public function    
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function 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.
Public function bool

AddDummyPackageEvent ( const FName InPackageName,
int64& OutPackageEventId
)

 Add a new dummy package event to this database, assigning it a package event ID.
Public function 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.
Public function 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.
Public function 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.
Public function 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.
Public function bool

Close ( const bool InDeleteDatabase
)

 Close an open database file.
Public function Const bool Enumerate the generic part of the activities in this database.
Public function Const bool Enumerate all the activities in this database of the given type.
Public function Const bool

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

 Enumerate all the activities in this database in the given range.
Public function Const bool Enumerate the IDs and event types of all the activities in this database.
Public function Const bool

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

 Enumerate the IDs and event types of the activities in this database in the given range.
Public function Const bool

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

 Enumerate the IDs, event types and flags of the activities in this database in the given range.
Public function Const bool Enumerate all the connection activities in this database.
Public function Const bool

EnumerateEndpointIds ( TFunctionRef< bool(FGuid)> InCallback
)

 Enumerate all the endpoint IDs in this database.
Public function Const bool Enumerate all the endpoints in this database.
Public function Const bool Enumerate the head revision package data for all packages in this database.
Public function Const bool

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

 Enumerate the IDs of any live transaction events for the given package name.
Public function Const bool Enumerate all the lock activities in this database.
Public function Const bool Enumerate all the package activities in this database.
Public function Const bool

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

 Enumerate package names for packages with a head revision (at least one package event)
Public function Const bool Enumerate the names of of any packages that have live transaction events.
Public function Const bool Enumerate all the transaction activities in this database.
Public function void Flush any ongoing asynchronous tasks.
Public function Const bool

GetActivity ( const int64 InActivityId,
FConcertSyncActivity& OutActivity
)

 Get the generic part of an activity from this database.
Public function Const bool

GetActivityEventType ( const int64 InActivityId,
EConcertSyncActivityEventType& OutEventType
)

 Get the type of an activity in this database.
Public function Const bool

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

 Get the generic part of an activity for an event in this database.
Public function Const bool

GetActivityMaxId ( int64& OutActivityId
)

 Get the maximum ID of the activities in this database.
Public function Const bool

GetConnectionActivity ( const int64 InActivityId,
FConcertSyncConnectionActivity& OutConnectionActivity
)

 Get a connection activity from this database.
Public function Const bool

GetConnectionActivityForEvent ( const int64 InConnectionEventId,
FConcertSyncConnectionActivity& OutConnectionActivity
)

 Get a connection activity for an event in this database.
Public function Const bool

GetConnectionEvent ( const int64 InConnectionEventId,
FConcertSyncConnectionEvent& OutConnectionEvent
)

 Get a connection event from this database.
Public function Const bool

GetEndpoint ( const FGuid& InEndpointId,
FConcertSyncEndpointData& OutEndpointData
)

 Get an endpoint from this database.
Public function Const FString Get the filename of the currently open database, or an empty string.
Public function Const FString Get the last error reported by this database.
Public function Const bool

GetLiveTransactionEventIds ( TArray< int64 >& OutTransactionEventIds
)

 Get the IDs of any live transaction events.
Public function Const bool

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

 Get the IDs of any live transaction events for the given package name.
Public function Const bool

GetLockActivity ( const int64 InActivityId,
FConcertSyncLockActivity& OutLockActivity
)

 Get a lock activity from this database.
Public function Const bool

GetLockActivityForEvent ( const int64 InLockEventId,
FConcertSyncLockActivity& OutLockActivity
)

 Get a lock activity for an event in this database.
Public function Const bool

GetLockEvent ( const int64 InLockEventId,
FConcertSyncLockEvent& OutLockEvent
)

 Get a lock event from this database.
Public function Const bool

GetPackageActivity ( const int64 InActivityId,
FConsumePackageActivityFunc PackageActivityFn
)

 Get a package activity from this database.
Public function Const bool

GetPackageActivityForEvent ( const int64 InPackageEventId,
FIteratePackageActivityFunc PackageActivityFn
)

 Get a package activity for an event in this database.
Public function Const bool

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

 Get the data from this database for the given package name for the given revision.
Public function Const bool

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

 Get a package event from this database.
Public function Const bool

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

 Get a package event meta data (omitting the package data itself) from this database.
Public function 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.
Public function Const bool

GetPackageHeadRevision ( const FName InPackageName,
int64& OutRevision
)

 Get the head revision in this database for the given package name.
Public function Const bool

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

 Get the data from this database for the given package name for the given revision.
Public function Const TOptional< int64 >

GetPackageSizeForRevision ( const FName InPackageName,
const int64* InPackageRevision
)

 Gets the package size in bytes of a package
Public function Const bool

GetTransactionActivity ( const int64 InActivityId,
FConcertSyncTransactionActivity& OutTransactionActivity
)

 Get a transaction activity from this database.
Public function Const bool

GetTransactionActivityForEvent ( const int64 InTransactionEventId,
FConcertSyncTransactionActivity& OutTransactionActivity
)

 Get a transaction activity for an event in this database.
Public function Const bool

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

 Get a transaction event from this database.
Public function Const bool

GetTransactionMaxEventId ( int64& OutTransactionEventId
)

 Get the maximum ID of the transaction events in this database.
Public function Const bool Has all asynchronous package tasks completed.
Public function Const bool

IsHeadRevisionPackageEvent ( const int64 InPackageEventId,
bool& OutIsHeadRevision
)

 Check whether the given package event ID is currently for the head revision of the package in the event.
Public function Const bool

IsLiveTransactionEvent ( const int64 InTransactionEventId,
bool& OutIsLive
)

 Check whether the given transaction event ID is currently for a live transaction event.
Public function Const bool

IsValid ()

 Is this a valid database? (ie, has been successfully opened).
Public function FOnActivityProduced &  
Public function bool

Open ( const FString& InSessionPath,
const ESQLiteDatabaseOpenMode InOpenMode
)

 Open (or create) a database file.
Public function bool

Open ( const FString& InSessionPath
)

 Open (or create) a database file.
Public function Const bool

PackageHasLiveTransactions ( const FName InPackageName,
bool& OutHasLiveTransaction
)

 Get if a Package has any live transactions
Public function bool

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

 Iterates the given range, calls UpdateCallback on each element, and commits the update.
Public function bool

SetConnectionActivity ( const FConcertSyncConnectionActivity& InConnectionActivity
)

 Set a connection activity in this database, creating or replacing it.
Public function bool

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

 Set an endpoint in this database, creating or replacing it.
Public function bool

SetLockActivity ( const FConcertSyncLockActivity& InLockActivity
)

 Set a lock activity in this database, creating or replacing it.
Public function bool

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

 Set a package activity in this database, creating or replacing it.
Public function bool

SetTransactionActivity ( const FConcertSyncTransactionActivity& InTransactionActivity,
const bool bMetaDataOnly
)

 Set a transaction activity in this database, creating or replacing it.
Public function void Check Asynchronous Tasks Status
Public function bool

UpdatePackageEvent ( const int64 InPackageEventId,
FConcertSyncPackageEventData& PackageEvent
)

 Update the specified package event.
Public function bool

UpdateTransactionEvent ( const int64 InTransactionEventId,
const FConcertSyncTransactionEvent& InTransactionEvent
)

 Update the specified transaction event.

Operators

  Type Name Description
Public function FConcertSyncSessionDatabase &  
Public function FConcertSyncSessionDatabase &  

Typedefs

Name Description
FProcessPackageRequest  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page