Unity Scopes API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
unity::scopes::Registry Class Referenceabstract

White pages service for available scopes. More...

#include <unity/scopes/Registry.h>

Inheritance diagram for unity::scopes::Registry:

Public Member Functions

virtual ScopeMetadata get_metadata (std::string const &scope_id)=0
 Returns the metadata for the scope with the given ID. More...
 
virtual MetadataMap list ()=0
 Returns a map containing the metadata for all scopes. More...
 
virtual MetadataMap list_if (std::function< bool(ScopeMetadata const &item)> predicate)=0
 Returns a map containing only those scopes for which predicate returns true. More...
 
- Public Member Functions inherited from unity::scopes::Object
virtual std::string endpoint ()=0
 Returns the endpoint this proxy connects to. More...
 
virtual std::string identity ()=0
 Returns the identity of the target object of this proxy. More...
 
virtual std::string category ()=0
 Returns the category of the target object of this proxy. More...
 
virtual int64_t timeout ()=0
 Returns the timeout in milliseconds if this proxy is a twoway proxy. More...
 
virtual std::string to_string ()=0
 converts a proxy into its string representation. More...
 

Detailed Description

White pages service for available scopes.

You can obtain a proxy to the registry by calling Runtime::registry().

Member Function Documentation

virtual ScopeMetadata unity::scopes::Registry::get_metadata ( std::string const &  scope_id)
pure virtual

Returns the metadata for the scope with the given ID.

Returns
The metadata for the scope.
Exceptions
NotFoundExceptionif no scope with the given name exists.
virtual MetadataMap unity::scopes::Registry::list ( )
pure virtual

Returns a map containing the metadata for all scopes.

Returns
The metadata for all scopes.
virtual MetadataMap unity::scopes::Registry::list_if ( std::function< bool(ScopeMetadata const &item)>  predicate)
pure virtual

Returns a map containing only those scopes for which predicate returns true.

Parameters
predicatea function object that must return true for each metadata item to be included in the map.
Returns
The metadata items for which the predicate returned true.

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