us::ServiceReferenceBase Class Reference

#include <usServiceReferenceBase.h>

Inheritance diagram for us::ServiceReferenceBase:

Public Member Functions
	ServiceReferenceBase (const ServiceReferenceBase &ref)
	Copy constructor. More...
	operator bool_type () const
	Converts this ServiceReferenceBase instance into a boolean expression. If this instance was default constructed or the service it references has been unregistered, the conversion returns false, otherwise it returns true. More...
ServiceReferenceBase &	operator= (int null)
	Releases any resources held or locked by this ServiceReferenceBase and renders it invalid. More...
	~ServiceReferenceBase ()
	Destructor. More...
Any	GetProperty (const std::string &key) const
	Returns the property value to which the specified property key is mapped in the properties ServiceProperties object of the service referenced by this ServiceReferenceBase object. More...
void	GetPropertyKeys (std::vector< std::string > &keys) const
	Returns a list of the keys in the ServiceProperties object of the service referenced by this ServiceReferenceBase object. More...
Module *	GetModule () const
	Returns the module that registered the service referenced by this ServiceReferenceBase object. More...
void	GetUsingModules (std::vector< Module * > &modules) const
	Returns the modules that are using the service referenced by this ServiceReferenceBase object. Specifically, this method returns the modules whose usage count for that service is greater than zero. More...
std::string	GetInterfaceId () const
	Returns the interface identifier this ServiceReferenceBase object is bound to. More...
bool	IsConvertibleTo (const std::string &interfaceid) const
	Checks whether this ServiceReferenceBase object can be converted to another ServiceReferenceBase object, which will be bound to the given interface identifier. More...
bool	operator< (const ServiceReferenceBase &reference) const
	Compares this ServiceReferenceBase with the specified ServiceReferenceBase for order. More...
bool	operator== (const ServiceReferenceBase &reference) const
	Equality comparison operator. More...
bool	operator== (std::nullptr_t) const noexcept
	Equality comparison with nullptr. More...
ServiceReferenceBase &	operator= (const ServiceReferenceBase &reference)
	Copy assignment operator. More...

Detailed Description

A reference to a service.

Note

This class is provided as public API for low-level service queries only. In almost all cases you should use the template ServiceReference instead.

Definition at line 34 of file usServiceReferenceBase.h.

Constructor & Destructor Documentation

ServiceReferenceBase()

us::ServiceReferenceBase::ServiceReferenceBase

(

const ServiceReferenceBase &

ref

)

Copy constructor.

~ServiceReferenceBase()

us::ServiceReferenceBase::~ServiceReferenceBase

(

)

Destructor.

Member Function Documentation

GetInterfaceId()

std::string us::ServiceReferenceBase::GetInterfaceId

(

)

const

Returns the interface identifier this ServiceReferenceBase object is bound to.

A default constructed ServiceReferenceBase object is not bound to any interface identifier and calling this method will return an empty string.

Returns

The interface identifier for this ServiceReferenceBase object.

Referenced by us::ServiceReference< S >::ServiceReference().

GetModule()

Module* us::ServiceReferenceBase::GetModule

(

)

const

Returns the module that registered the service referenced by this ServiceReferenceBase object.

This method must return 0 when the service has been unregistered. This can be used to determine if the service has been unregistered.

Returns

The module that registered the service referenced by this ServiceReferenceBase object; 0 if that service has already been unregistered.

See also

ModuleContext::RegisterService(const InterfaceMap&, const ServiceProperties&)

GetProperty()

Any us::ServiceReferenceBase::GetProperty

(

const std::string &

key

)

const

Returns the property value to which the specified property key is mapped in the properties ServiceProperties object of the service referenced by this ServiceReferenceBase object.

Property keys are case-insensitive.

This method continues to return property values after the service has been unregistered. This is so references to unregistered services can still be interrogated.

If this ServiceReferenceBase is invalid (default-constructed), returns an empty Any.

Parameters

[in]

key

The property key.

Returns

The property value to which the key is mapped; an invalid Any if there is no property named after the key or the reference is invalid.

GetPropertyKeys()

void us::ServiceReferenceBase::GetPropertyKeys

(

std::vector< std::string > &

keys

)

const

Returns a list of the keys in the ServiceProperties object of the service referenced by this ServiceReferenceBase object.

This method will continue to return the keys after the service has been unregistered. This is so references to unregistered services can still be interrogated.

If this ServiceReferenceBase is invalid (default-constructed), keys is left unchanged.

Parameters

[out]

keys

A vector being filled with the property keys.

GetUsingModules()

void us::ServiceReferenceBase::GetUsingModules

(

std::vector< Module * > &

modules

)

const

Returns the modules that are using the service referenced by this ServiceReferenceBase object. Specifically, this method returns the modules whose usage count for that service is greater than zero.

If this ServiceReferenceBase is invalid (default-constructed), modules is left unchanged.

Parameters

[out]

modules

A list of modules whose usage count for the service referenced by this ServiceReferenceBase object is greater than zero.

IsConvertibleTo()

bool us::ServiceReferenceBase::IsConvertibleTo

(

const std::string &

interfaceid

)

const

Checks whether this ServiceReferenceBase object can be converted to another ServiceReferenceBase object, which will be bound to the given interface identifier.

ServiceReferenceBase objects can be converted if the underlying service implementation was registered under multiple service interfaces.

Parameters

[in]

interfaceid

The target interface identifier.

Returns

true if this ServiceReferenceBase object can be converted, false otherwise.

Referenced by us::ServiceReference< S >::ServiceReference().

operator bool_type()

us::ServiceReferenceBase::operator bool_type

(

)

const

Converts this ServiceReferenceBase instance into a boolean expression. If this instance was default constructed or the service it references has been unregistered, the conversion returns false, otherwise it returns true.

operator<()

bool us::ServiceReferenceBase::operator<

(

const ServiceReferenceBase &

reference

)

const

Compares this ServiceReferenceBase with the specified ServiceReferenceBase for order.

If this ServiceReferenceBase and the specified ServiceReferenceBase have the same service id they are equal. This ServiceReferenceBase is less than the specified ServiceReferenceBase if it has a lower service ranking and greater if it has a higher service ranking. Otherwise, if this ServiceReferenceBase and the specified ServiceReferenceBase have the same service ranking, this ServiceReferenceBase is less than the specified ServiceReferenceBase if it has a higher service id and greater if it has a lower service id.

Parameters

[in]

reference

The ServiceReferenceBase to be compared.

Returns

Returns a false or true if this ServiceReferenceBase is less than or greater than the specified ServiceReferenceBase.

operator=() [1/2]

ServiceReferenceBase& us::ServiceReferenceBase::operator=

(

const ServiceReferenceBase &

reference

)

Copy assignment operator.

operator=() [2/2]

ServiceReferenceBase& us::ServiceReferenceBase::operator=

(

int

null

)

Releases any resources held or locked by this ServiceReferenceBase and renders it invalid.

operator==() [1/2]

bool us::ServiceReferenceBase::operator==

(

const ServiceReferenceBase &

reference

)

const

Equality comparison operator.

operator==() [2/2]

bool us::ServiceReferenceBase::operator== ( std::nullptr_t  ) const

noexcept

Equality comparison with nullptr.

---

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

• usServiceReferenceBase.h