1. Epic GamesDeveloper
  3. FSourceControlFileStatusMonitor

FSourceControlFileStatusMonitor

Periodically monitors the source controlled status of a collection of files and notifies the latest status, including potential warnings such as 'out of date', 'locked by other', etc.

API > API/Developer > API/Developer/SourceControl

Inheritance Hierarchy

References

   
Module SourceControl
Header /Engine/Source/Developer/SourceControl/Public/SourceControlFileStatusMonitor.h
Include #include "SourceControlFileStatusMonitor.h"

Syntax

class FSourceControlFileStatusMonitor : public TSharedFromThis< FSourceControlFileStatusMonitor >

Remarks

Periodically monitors the source controlled status of a collection of files and notifies the latest status, including potential warnings such as 'out of date', 'locked by other', etc. This service is meant to throttle and batch non-time sensitive FUpdateStatus requests to the source control provider because those requests are expensive and can add an undesired load on the provider server.

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Const int32  
Public function TSet< FString >

GetMonitoredFiles ( uintptr_t OwnerId
)

 Returns the set of files being monitored by the specifed owner.
Public function Const FTimespan  
Public function Const TOptional< FTimespan >

GetStatusAge ( const FString& AbsPathname
)

 Returns the file status age, i.e. (now - last_status_update) if the file is monitored.
Public function Const FTimespan  
Public function void

SetMaxFilePerRequestPolicy ( int32 MaxNum
)

 Sets the maximum number of files to batch into a single request.
Public function void

SetMonitoringFiles ( uintptr_t OwnerId,
TSet< FString >&& AbsPathnames,
FOnSourceControlFileStatus OnSourceControlledFileStatus
)

 Starts monitoring files that weren't monitored yet by the specified owner, stops monitoring those that were monitored by the owner but are not in the updated list and keep monitoring files that were monitored before and still in the updated list.
Public function void

SetNewRequestProbationPeriodPolicy ( const FTimespan& InPropbationPeriod
)

 Set the times waited before a newly added file status request is sent to the source control provider.
Public function void

SetSuspendMonitoringPolicy ( TFunction< bool()> IsMonitoringSuspended
)

 Sets a function invoked to detect if the monitor should suspend its activities, for example, if no user is currently interacting with the application, it may not worth checking the file status periodically.
Public function void

SetUpdateStatusPeriodPolicy ( const FTimespan& InRefreshPeriod
)

 Set the status refresh period.
Public function void

StartMonitoringFile ( uintptr_t OwnerId,
const FString& AbsPathname,
FOnSourceControlFileStatus OnSourceControlledFileStatus
)

 Starts monitoring the source control status of the specified file.
Public function void

StartMonitoringFiles ( uintptr_t OwnerId,
const TArray< FString >& AbsPathnames,
FOnSourceControlFileStatus OnSourceControlledFileStatus
)

  
Public function void

StartMonitoringFiles ( uintptr_t OwnerId,
const TSet< FString >& AbsPathnames,
FOnSourceControlFileStatus OnSourceControlledFileStatus
)

  
Public function void

StopMonitoringFile ( uintptr_t OwnerId,
const FString& AbsPathname
)

 Stops monitoring the source control status of the specified file.
Public function void

StopMonitoringFiles ( uintptr_t OwnerId
)

 Stops monitoring all the files that were registered by the specified owner Id.
Public function void

StopMonitoringFiles ( uintptr_t OwnerId,
const TArray< FString >& AbsPathnames
)

 Stops monitoring the source control status of the specified file.
Public function void

StopMonitoringFiles ( uintptr_t OwnerId,
const TSet< FString >& AbsPathnames
)

 Stops monitoring the source control status of the specified file.

Typedefs

Name Description
FOnSourceControlFileStatus Invoked when the status of a source controlled files is updated.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page