\r\n

51Degrees Pipeline .NET  4.4

51Degrees Pipeline for .NET

Search

Documentation

• FiftyOne
• Pipeline
• Engines
• Services
• IDataUpdateService

FiftyOne.Pipeline.Engines.Services.IDataUpdateService Interface Reference

Detailed Description

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

See the Specification

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

Public Member Functions

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...

Member Function Documentation

◆ CheckForUpdate()

AutoUpdateStatus FiftyOne.Pipeline.Engines.Services.IDataUpdateService.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.

Implemented in FiftyOne.Pipeline.Engines.Services.DataUpdateService.

◆ RegisterDataFile()

void FiftyOne.Pipeline.Engines.Services.IDataUpdateService.RegisterDataFile

(

AspectEngineDataFile

dataFile

)

Register an data file for automatic updates.

Parameters

dataFile - The details of the data file to register.

Implemented in FiftyOne.Pipeline.Engines.Services.DataUpdateService.

◆ UnRegisterDataFile()

void FiftyOne.Pipeline.Engines.Services.IDataUpdateService.UnRegisterDataFile

(

AspectEngineDataFile

dataFile

)

Unregister a data file.

Parameters

dataFile - The data file to unregister

Implemented in FiftyOne.Pipeline.Engines.Services.DataUpdateService.

◆ UpdateFromMemory()

AutoUpdateStatus FiftyOne.Pipeline.Engines.Services.IDataUpdateService.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.

Implemented in FiftyOne.Pipeline.Engines.Services.DataUpdateService.

Event Documentation

◆ CheckForUpdateComplete

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

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

◆ CheckForUpdateStarted

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

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

On This Page

• Public Member Functions
• Events
• List of all members

Generated by doxygen 1.8.15