\r\n

51Degrees Pipeline .NET  4.4

51Degrees Pipeline for .NET

Search

Documentation

• FiftyOne
• Pipeline
• Engines
• Services
• DataUpdateService

FiftyOne.Pipeline.Engines.Services.DataUpdateService Class Reference

Detailed Description

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

See the Specification

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

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

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

Properties

bool	DebugLoggingEnabled [get, set] Enables logging debug information (intermediate states and results). 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...
Action	OnTimeredCheckForUpdateEntered Called when CheckForUpdate(object) starts More...
Action	OnTimeredCheckForUpdateWillExit Called when CheckForUpdate(object) will exit More...
Action	OnDataFileUpdatedEntered Called when DataFileUpdated(object, FileSystemEventArgs) starts More...
Action	OnDataFileUpdatedWillExit Called when DataFileUpdated(object, FileSystemEventArgs) will exit 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

◆ DataUpdateService()

FiftyOne.Pipeline.Engines.Services.DataUpdateService.DataUpdateService	(	ILogger< DataUpdateService >	logger,
		HttpClient	httpClient
	)

Constructor

Parameters

logger - The logger to use

httpClient - The HttpClient to use when requesting an update from a URL. Note that only one HttpClient instance should be used throughout the application, as described in the documentation: https://msdn.microsoft.com/library/system.net.http.httpclient(v=vs.110).aspx

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.

◆ RegisterDataFile()

void FiftyOne.Pipeline.Engines.Services.DataUpdateService.RegisterDataFile

(

AspectEngineDataFile

dataFile

)

Register an data file for automatic updates.

Parameters

dataFile - The details of the data file to register.

Implements FiftyOne.Pipeline.Engines.Services.IDataUpdateService.

◆ UnRegisterDataFile()

void FiftyOne.Pipeline.Engines.Services.DataUpdateService.UnRegisterDataFile

(

AspectEngineDataFile

dataFile

)

Unregister a data file.

Parameters

dataFile - The data file to unregister

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.

Property Documentation

◆ DebugLoggingEnabled

bool FiftyOne.Pipeline.Engines.Services.DataUpdateService.DebugLoggingEnabled

get set

Enables logging debug information (intermediate states and results).

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.

◆ OnDataFileUpdatedEntered

Action FiftyOne.Pipeline.Engines.Services.DataUpdateService.OnDataFileUpdatedEntered

Called when DataFileUpdated(object, FileSystemEventArgs) starts

◆ OnDataFileUpdatedWillExit

Action FiftyOne.Pipeline.Engines.Services.DataUpdateService.OnDataFileUpdatedWillExit

Called when DataFileUpdated(object, FileSystemEventArgs) will exit

◆ OnTimeredCheckForUpdateEntered

Action FiftyOne.Pipeline.Engines.Services.DataUpdateService.OnTimeredCheckForUpdateEntered

Called when CheckForUpdate(object) starts

◆ OnTimeredCheckForUpdateWillExit

Action FiftyOne.Pipeline.Engines.Services.DataUpdateService.OnTimeredCheckForUpdateWillExit

Called when CheckForUpdate(object) will exit

On This Page

• Public Member Functions
• Properties
• Events
• List of all members

Generated by doxygen 1.8.15