ServiceRegistration

template <class I1, class... Interfaces>
class cppmicroservices::ServiceRegistration
#include <cppmicroservices/ServiceRegistration.h>

A registered service.

The framework returns a ServiceRegistration object when a BundleContext::RegisterService() method invocation is successful. The ServiceRegistration object is for the private use of the registering bundle and should not be shared with other bundles.

The ServiceRegistration object may be used to update the properties of the service or to unregister the service.

See
BundleContext::RegisterService()
Template Parameters
  • I1: Class type of the first service interface
  • Interfaces: Template parameter pack containing zero or more service interfaces

Inherits from cppmicroservices::ServiceRegistrationBase

Public Functions

ServiceRegistration()

Creates an invalid ServiceRegistration object.

You can use this object in boolean expressions and it will evaluate to false.

template <class Interface>
ServiceReference<Interface> GetReference() const

Returns a ServiceReference object for a service being registered.

The ServiceReference object may be shared with other bundles.

Return
ServiceReference object.
Exceptions
  • std::logic_error: If this ServiceRegistration object has already been unregistered or if it is invalid.

ServiceReference<I1> GetReference() const

Returns a ServiceReference object for a service being registered.

The ServiceReference object refers to the first interface type and may be shared with other bundles.

Return
ServiceReference object.
Exceptions
  • std::logic_error: If this ServiceRegistration object has already been unregistered or if it is invalid.

class cppmicroservices::ServiceRegistrationBase
#include <cppmicroservices/ServiceRegistrationBase.h>

A registered service.

The framework returns a ServiceRegistrationBase object when a BundleContext::RegisterService() method invocation is successful. The ServiceRegistrationBase object is for the private use of the registering bundle and should not be shared with other bundles.

The ServiceRegistrationBase object may be used to update the properties of the service or to unregister the service.

Note

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

See
BundleContext::RegisterService()

Subclassed by cppmicroservices::ServiceRegistration< I1, Interfaces >, cppmicroservices::ServiceRegistration< cppmicroservices::HttpServlet >

Public Functions

ServiceRegistrationBase(const ServiceRegistrationBase &reg)
ServiceRegistrationBase(ServiceRegistrationBase &&reg)
operator bool() const

A boolean conversion operator converting this ServiceRegistrationBase object to true if it is valid and to false otherwise.

A ServiceRegistrationBase object is invalid if it was default-constructed or was invalidated by assigning 0 to it.

See
operator=(std::nullptr_t)
Return
true if this ServiceRegistrationBase object is valid, false otherwise.

ServiceRegistrationBase &operator=(std::nullptr_t)

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

Return
This ServiceRegistrationBase object.

~ServiceRegistrationBase()
ServiceReferenceBase GetReference(const std::string &interfaceId = std::string()) const

Returns a ServiceReferenceBase object for a service being registered.

The ServiceReferenceBase object may be shared with other bundles.

Return
ServiceReference object.
Exceptions

void SetProperties(const ServiceProperties &properties)

Updates the properties associated with a service.

The Constants::OBJECTCLASS and Constants::SERVICE_ID keys cannot be modified by this method. These values are set by the framework when the service is registered in the environment.

The following steps are taken to modify service properties:

  1. The service’s properties are replaced with the provided properties.
  2. A service event of type ServiceEvent::SERVICE_MODIFIED is fired.

Parameters
  • properties: The properties for this service. See ServiceProperties for a list of standard service property keys. Changes should not be made to this object after calling this method. To update the service’s properties this method should be called again.
Exceptions
  • std::logic_error: If this ServiceRegistrationBase object has already been unregistered or if it is invalid.
  • std::invalid_argument: If properties contains case variants of the same key name or if the number of the keys of properties exceeds the value returned by std::numeric_limits<int>::max().

void Unregister()

Unregisters a service.

Remove a ServiceRegistrationBase object from the framework service registry. All ServiceRegistrationBase objects associated with this ServiceRegistrationBase object can no longer be used to interact with the service once unregistration is complete.

The following steps are taken to unregister a service:

  1. The service is removed from the framework service registry so that it can no longer be obtained.
  2. A service event of type ServiceEvent::SERVICE_UNREGISTERING is fired so that bundles using this service can release their use of the service. Once delivery of the service event is complete, the ServiceRegistrationBase objects for the service may no longer be used to get a service object for the service.
  3. For each bundle whose use count for this service is greater than zero: The bundle’s use count for this service is set to zero. If the service was registered with a ServiceFactory object, the ServiceFactory::UngetService method is called to release the service object for the bundle.

Exceptions

bool operator<(const ServiceRegistrationBase &o) const

Compare two ServiceRegistrationBase objects.

If both ServiceRegistrationBase objects are valid, the comparison is done using the underlying ServiceReference object. Otherwise, this ServiceRegistrationBase object is less than the other object if and only if this object is invalid and the other object is valid.

Return
true if this ServiceRegistrationBase object is less than the other object.
Parameters

bool operator==(const ServiceRegistrationBase &registration) const
ServiceRegistrationBase &operator=(const ServiceRegistrationBase &registration)
ServiceRegistrationBase &operator=(ServiceRegistrationBase &&registration)

Friends

friend gr_serviceregistration::::std::hash< ServiceRegistrationBase >
template<>
struct std::hash<cppmicroservices::ServiceRegistrationBase>
#include <cppmicroservices/ServiceRegistrationBase.h>

Hash functor specialization for ServiceRegistrationBase objects.