51Degrees Pipeline .NET  4.1

51Degrees Pipeline for .NET

FiftyOne.Pipeline.Engines.Services.DataUpdateService Class Reference

Detailed Description

Service that manages updates to data files that are used by IAspectEngine instances.

Inheritance diagram for FiftyOne.Pipeline.Engines.Services.DataUpdateService:

[legend]

Collaboration diagram for FiftyOne.Pipeline.Engines.Services.DataUpdateService:

[legend]

Public Member Functions

 DataUpdateService (ILogger< DataUpdateService > logger, HttpClient httpClient)
Constructor More...
void  RegisterDataFile (AspectEngineDataFile dataFile)
Register an data file for automatic updates. More...
void  UnRegisterDataFile (AspectEngineDataFile dataFile)
Unregister a data file. More...
AutoUpdateStatus  CheckForUpdate (IOnPremiseAspectEngine engine, string dataFileIdentifier=null)
Check if there are updates for the specified engine. More...
AutoUpdateStatus  UpdateFromMemory (AspectEngineDataFile dataFile, MemoryStream data)
Update the specified data file from a MemoryStream More...

Events

EventHandler< DataUpdateCompleteArgs >  CheckForUpdateComplete
The event handler fired when a call to CheckForUpdate is completed. More...
EventHandler< DataUpdateEventArgs >  CheckForUpdateStarted
The event handler fired when a call to CheckForUpdate is started. More...

Events inherited from FiftyOne.Pipeline.Engines.Services.IDataUpdateService

EventHandler< DataUpdateCompleteArgs >  CheckForUpdateComplete
The event handler fired when a call to CheckForUpdate is completed. More...
EventHandler< DataUpdateEventArgs >  CheckForUpdateStarted
The event handler fired when a call to CheckForUpdate is started. More...

Constructor & Destructor Documentation

Member Function Documentation

◆ CheckForUpdate()

AutoUpdateStatus FiftyOne.Pipeline.Engines.Services.DataUpdateService.CheckForUpdate ( IOnPremiseAspectEngine   engine,
string   dataFileIdentifier = null  
)

Check if there are updates for the specified engine.

Parameters
engine - The engine to check for
dataFileIdentifier - The identifier of the data file to check for. If the engine has only one data file then this parameter is ignored.
Returns
The result of the update check.
Exceptions
DataUpdateException - Thrown if some problem occurs during the update process.
ArgumentNullException - Thrown if the parameter is null

Implements FiftyOne.Pipeline.Engines.Services.IDataUpdateService.

◆ UpdateFromMemory()

AutoUpdateStatus FiftyOne.Pipeline.Engines.Services.DataUpdateService.UpdateFromMemory ( AspectEngineDataFile   dataFile,
MemoryStream   data  
)

Update the specified data file from a MemoryStream

Parameters
dataFile - The data file to update.
data - The data to update with.
Exceptions
DataUpdateException - Thrown if some problem occurs during the update process.
ArgumentNullException - Thrown if arguments are null.

Implements FiftyOne.Pipeline.Engines.Services.IDataUpdateService.

Event Documentation

◆ CheckForUpdateComplete

EventHandler<DataUpdateCompleteArgs> FiftyOne.Pipeline.Engines.Services.DataUpdateService.CheckForUpdateComplete

The event handler fired when a call to CheckForUpdate is completed.

◆ CheckForUpdateStarted

EventHandler<DataUpdateEventArgs> FiftyOne.Pipeline.Engines.Services.DataUpdateService.CheckForUpdateStarted

The event handler fired when a call to CheckForUpdate is started.