us::ServiceTrackerCustomizer< S, T > Struct Template Reference

#include <usServiceTrackerCustomizer.h>

Inheritance diagram for us::ServiceTrackerCustomizer< S, T >:

Public Types
typedef S	ServiceType
	The service type being tracked. More...
typedef T	TrackedType
	The tracked object type. More...
typedef ServiceReference< ServiceType >	ServiceReferenceType
	The service reference type for the tracked service. More...

Public Member Functions
virtual	~ServiceTrackerCustomizer ()
	Destructor. More...
virtual TrackedType	AddingService (const ServiceReferenceType &reference)=0
	A service is being added to the ServiceTracker. More...
virtual void	ModifiedService (const ServiceReferenceType &reference, TrackedType service)=0
	A service tracked by the ServiceTracker has been modified. More...
virtual void	RemovedService (const ServiceReferenceType &reference, TrackedType service)=0
	A service tracked by the ServiceTracker has been removed. More...

Detailed Description

template<class S, class T = S*>
struct us::ServiceTrackerCustomizer< S, T >

The ServiceTrackerCustomizer interface allows a ServiceTracker to customize the service objects that are tracked. A ServiceTrackerCustomizer is called when a service is being added to a ServiceTracker. The ServiceTrackerCustomizer can then return an object for the tracked service. A ServiceTrackerCustomizer is also called when a tracked service is modified or has been removed from a ServiceTracker.

The methods in this interface may be called as the result of a ServiceEvent being received by a ServiceTracker. Since ServiceEvents are synchronously delivered, it is highly recommended that implementations of these methods do not register (ModuleContext::RegisterService), modify ( ServiceRegistration::SetProperties) or unregister ( ServiceRegistration::Unregister) a service while being synchronized on any object.

The ServiceTracker class is thread-safe. It does not call a ServiceTrackerCustomizer while holding any locks. ServiceTrackerCustomizer implementations must also be thread-safe.

Template Parameters

S	The type of the service being tracked
T	The type of the tracked object.

Remarks

This class is thread safe.

Definition at line 54 of file usServiceTrackerCustomizer.h.

Member Typedef Documentation

ServiceReferenceType

template<class S , class T = S*>

typedef ServiceReference<ServiceType> us::ServiceTrackerCustomizer< S, T >::ServiceReferenceType

The service reference type for the tracked service.

Definition at line 63 of file usServiceTrackerCustomizer.h.

ServiceType

template<class S , class T = S*>

typedef S us::ServiceTrackerCustomizer< S, T >::ServiceType

The service type being tracked.

Definition at line 57 of file usServiceTrackerCustomizer.h.

TrackedType

template<class S , class T = S*>

typedef T us::ServiceTrackerCustomizer< S, T >::TrackedType

The tracked object type.

Definition at line 60 of file usServiceTrackerCustomizer.h.

Constructor & Destructor Documentation

~ServiceTrackerCustomizer()

template<class S , class T = S*>

virtual us::ServiceTrackerCustomizer< S, T >::~ServiceTrackerCustomizer ( )

inlinevirtual

Destructor.

Definition at line 66 of file usServiceTrackerCustomizer.h.

Member Function Documentation

AddingService()

template<class S , class T = S*>

virtual TrackedType us::ServiceTrackerCustomizer< S, T >::AddingService ( const ServiceReferenceType &  reference )

pure virtual

A service is being added to the ServiceTracker.

This method is called before a service which matched the search parameters of the ServiceTracker is added to the ServiceTracker. This method should return the service object to be tracked for the specified ServiceReference. The returned service object is stored in the ServiceTracker and is available from the GetService and GetServices methods.

Parameters

[in]

reference

The reference to the service being added to the ServiceTracker.

Returns

The service object to be tracked for the specified referenced service or 0 if the specified referenced service should not be tracked.

Implemented in us::ServiceTracker< mitk::InteractionEventObserver >, us::ServiceTracker< mitk::CustomMimeType, mitk::MimeTypeTrackerTypeTraits >, us::ServiceTracker< ctkXnatSession >, and us::ServiceTracker< Annotation >.

ModifiedService()

template<class S , class T = S*>

virtual void us::ServiceTrackerCustomizer< S, T >::ModifiedService ( const ServiceReferenceType &  reference, TrackedType  service  )

pure virtual

A service tracked by the ServiceTracker has been modified.

This method is called when a service being tracked by the ServiceTracker has had it properties modified.

Parameters

[in]	reference	The reference to the service that has been modified.
[in]	service	The service object for the specified referenced service.

RemovedService()

template<class S , class T = S*>

virtual void us::ServiceTrackerCustomizer< S, T >::RemovedService ( const ServiceReferenceType &  reference, TrackedType  service  )

pure virtual

A service tracked by the ServiceTracker has been removed.

This method is called after a service is no longer being tracked by the ServiceTracker.

Parameters

[in]	reference	The reference to the service that has been removed.
[in]	service	The service object for the specified referenced service.

---

The documentation for this struct was generated from the following file:

• usServiceTrackerCustomizer.h