AircraftFetcher(TKey, TDetail) Class

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

C++

Copy

public abstract class AircraftFetcher<TKey, TDetail> : IDisposable
where TDetail : class

Public MustInherit Class AircraftFetcher(Of TKey, TDetail As Class)
	Implements IDisposable

generic<typename TKey, typename TDetail>
where TDetail : ref class
public ref class AircraftFetcher abstract : IDisposable

[<AbstractClassAttribute>]
type AircraftFetcher<'TKey, 'TDetail when 'TDetail : not struct> =  
    class
        interface IDisposable
    end

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

	Name	Description
	AircraftFetcherTKey, TDetail	Creates a new object.

Top

Properties

	Name	Description
	AutomaticDeregisterIntervalMilliseconds	Gets the number of milliseconds that have to pass after the last registration before the aircraft is automatically deregistered.
	AutomaticRecheckIntervalMilliseconds	Gets the number of milliseconds between automatic refetches of the aircraft data. 0 indicates that automatic refetching is not required.
	Disposed	Gets a value indicating that the object has been disposed.
	ForceRefetchOnFastTick	Gets or sets a value that, when set, will force a refresh of all aircraft on the next fast tick.

Top

Methods

	Name	Description
	Dispose	See interface docs.
	Dispose(Boolean)	Disposes of or finalises the object.
	DoExtraFastTimerTickWork	Called after the basic fast timer tick work has been completed.
	DoExtraSlowTimerTickWork	Called after the basic slow timer tick work has been completed.
	DoFetchAircraft	Fetches the detail for the aircraft, raising any events necessary when a change has been detected.
	DoFetchManyAircraft	When overridden by a derivee this fetches many aircraft details simultaneously.
	DoInitialise	Initialises the object. This is called within a lock, do not call Initialise from within this.
	DoRegisterAircraft	Registers or refreshes the entry for the key passed across.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	FauxFetchAircraft	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.
	Finalize	Finalises the object. (Overrides ObjectFinalize.)
	GetFetchedDetailUnderLock	Returns the fetched detail for a key.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetRegisteredAircraft	Returns a copy of the dictionary that holds all of the registered aircraft for which at least one fetch has already been made.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Initialise	Initialises the object.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	RecheckAll	Refetches all expired records, optionally forcing a refetch of records even if they have not expired.
	ToString	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.

Reference

VirtualRadar.Interface Namespace