51Degrees Pipeline .NET  4.1

51Degrees Pipeline for .NET

FiftyOne.Pipeline.Engines.Services Namespace Reference

Classes

class  DataUpdateCompleteArgs
Event arguments used when an 'UpdteComplete' event is fired by an IDataUpdateService More...
class  DataUpdateEventArgs
Event arguments used when events are fired by an IDataUpdateService More...
class  DataUpdateService
Service that manages updates to data files that are used by IAspectEngine instances. More...
interface  IDataUpdateService
Service that manages updates to data files that are used by IOnPremiseAspectEngine instances. More...
interface  IMissingPropertyService
Service that determines the reason for a property not being populated by an engine. More...
class  MissingPropertyResult
Details of why a property is not populated by an engine. More...
class  MissingPropertyService
Service that determines the reason for a property not being populated by an engine. More...
enum  AutoUpdateStatus {
  AutoUpdateStatus.UNSPECIFIED, AutoUpdateStatus.AUTO_UPDATE_SUCCESS, AutoUpdateStatus.AUTO_UPDATE_HTTPS_ERR, AutoUpdateStatus.AUTO_UPDATE_NOT_NEEDED,
  AutoUpdateStatus.AUTO_UPDATE_IN_PROGRESS, AutoUpdateStatus.AUTO_UPDATE_MASTER_FILE_CANT_RENAME, AutoUpdateStatus.AUTO_UPDATE_ERR_429_TOO_MANY_ATTEMPTS, AutoUpdateStatus.AUTO_UPDATE_ERR_403_FORBIDDEN,
  AutoUpdateStatus.AUTO_UPDATE_ERR_READING_STREAM, AutoUpdateStatus.AUTO_UPDATE_ERR_MD5_VALIDATION_FAILED, AutoUpdateStatus.AUTO_UPDATE_NEW_FILE_CANT_RENAME, AutoUpdateStatus.AUTO_UPDATE_REFRESH_FAILED,
  AutoUpdateStatus.AUTO_UPDATE_NO_CONFIGURATION, AutoUpdateStatus.AUTO_UPDATE_TEMP_PATH_NOT_SET, AutoUpdateStatus.AUTO_UPDATE_UNKNOWN_ERROR, AutoUpdateStatus.AUTO_UPDATE_TIMEOUT
}
Possible status values for the data update process. More...
enum  MissingPropertyReason { MissingPropertyReason.DataFileUpgradeRequired, MissingPropertyReason.PropertyExculdedFromEngineConfiguration, MissingPropertyReason.CloudEngine, MissingPropertyReason.Unknown }
The reason a property is not populated by an engine. More...

Enumeration Type Documentation

◆ AutoUpdateStatus

Possible status values for the data update process.

Enumerator

UNSPECIFIED 

Status has not been set.

AUTO_UPDATE_SUCCESS 

Update completed successfully.

AUTO_UPDATE_HTTPS_ERR 

HTTPS connection could not be established.

AUTO_UPDATE_NOT_NEEDED 

No need to perform update.

AUTO_UPDATE_IN_PROGRESS 

Update currently under way.

AUTO_UPDATE_MASTER_FILE_CANT_RENAME 

Path to master file is directory not file

AUTO_UPDATE_ERR_429_TOO_MANY_ATTEMPTS 

51Degrees server responded with 429: too many attempts.

///

AUTO_UPDATE_ERR_403_FORBIDDEN 

51Degrees server responded with 403 meaning key is blacklisted.

AUTO_UPDATE_ERR_READING_STREAM 

Used when IO operations with input or output stream failed.

AUTO_UPDATE_ERR_MD5_VALIDATION_FAILED 

MD5 validation failed

AUTO_UPDATE_NEW_FILE_CANT_RENAME 

The new data file can't be renamed to replace the previous one.

AUTO_UPDATE_REFRESH_FAILED 

Refreshing the engine with the new data caused an error to occur.

AUTO_UPDATE_NO_CONFIGURATION 

There was no data file configuration matching the specified identifier.

AUTO_UPDATE_TEMP_PATH_NOT_SET 

A temporary file path was required but has not been set.

AUTO_UPDATE_UNKNOWN_ERROR 

There was an error while checking for an update that was not anticipated by the developers of this service.

AUTO_UPDATE_TIMEOUT 

An operation could not be completed within the expected time.

◆ MissingPropertyReason

The reason a property is not populated by an engine.

Enumerator

DataFileUpgradeRequired 

The property was not populated because the data file being used does not contain that property.

For example, the free, lite 51Degrees device detection data file has only a handful of properties of the 250+ that are available in the paid-for versions.

PropertyExculdedFromEngineConfiguration 

The property was not included in the list of properties that were passed in when the engine was created.

Restricting the list of properties that you want an engine to populate can result in improved performance. However, if you then request a property that is not in that list then it will not be populated.

CloudEngine 

51Degrees cloud engines use a 'resourceKey' to determine the properties that should be returned in the response.

This reason indicates that the resource key probably does not include the requested property. A new resource key will need to be created that does include the property before you will be able to access it.

Unknown 

The reason for the property not being present could not be determined.

On This Page