Click or drag to resize
AircraftFetcherTKey, TDetail Class
A base class for fetcher implementations that register an aircraft and then periodically fetch records related to that aircraft.
Inheritance Hierarchy
SystemObject
  VirtualRadar.InterfaceAircraftFetcherTKey, TDetail

Namespace: VirtualRadar.Interface
Assembly: VirtualRadar.Interface (in VirtualRadar.Interface.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
public abstract class AircraftFetcher<TKey, TDetail> : IDisposable
where TDetail : class

Type Parameters

TKey
The type of key to use when indexing the lookup details.
TDetail
The type of the DTO returned by the fetcher.

The AircraftFetcherTKey, TDetail type exposes the following members.

Constructors
Properties
  NameDescription
Protected propertyAutomaticDeregisterIntervalMilliseconds
Gets the number of milliseconds that have to pass after the last registration before the aircraft is automatically deregistered.
Protected propertyAutomaticRecheckIntervalMilliseconds
Gets the number of milliseconds between automatic refetches of the aircraft data. 0 indicates that automatic refetching is not required.
Protected propertyDisposed
Gets a value indicating that the object has been disposed.
Protected propertyForceRefetchOnFastTick
Gets or sets a value that, when set, will force a refresh of all aircraft on the next fast tick.
Top
Methods
  NameDescription
Public methodDispose
See interface docs.
Protected methodDispose(Boolean)
Disposes of or finalises the object.
Protected methodDoExtraFastTimerTickWork
Called after the basic fast timer tick work has been completed.
Protected methodDoExtraSlowTimerTickWork
Called after the basic slow timer tick work has been completed.
Protected methodDoFetchAircraft
Fetches the detail for the aircraft, raising any events necessary when a change has been detected.
Protected methodDoFetchManyAircraft
When overridden by a derivee this fetches many aircraft details simultaneously.
Protected methodDoInitialise
Initialises the object. This is called within a lock, do not call Initialise from within this.
Protected methodDoRegisterAircraft
Registers or refreshes the entry for the key passed across.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFauxFetchAircraft
Fakes an aircraft fetch. Some derivees may hook events that pre-fetch the interesting data and they don't want to fetch it again with a call to FetchAircraft, so this applies the same lock as FetchAircraft and calls the action passed across.
Protected methodFinalize
Finalises the object.
(Overrides ObjectFinalize.)
Protected methodGetFetchedDetailUnderLock
Returns the fetched detail for a key.
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Protected methodGetRegisteredAircraft
Returns a copy of the dictionary that holds all of the registered aircraft for which at least one fetch has already been made.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodInitialise
Initialises the object.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodRecheckAll
Refetches all expired records, optionally forcing a refetch of records even if they have not expired.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks
There are no unit tests on this class, it is an implementation detail for fetchers that use it. The unit tests must be on the fetchers themselves.
See Also