ARC SDK
Public Member Functions
Arc::EndpointQueryOptions< Endpoint > Class Template Reference

The EntityRetriever<Endpoint> (a.k.a. ServiceEndpointRetriever) needs different options. More...

#include <EntityRetrieverPlugin.h>

Public Member Functions

 EndpointQueryOptions (bool recursive=false, const std::list< std::string > &capabilityFilter=std::list< std::string >(), const std::list< std::string > &rejectedServices=std::list< std::string >(), const std::set< std::string > &preferredInterfaceNames=std::set< std::string >())
 Options for recursivity, filtering of capabilities and rejecting services. More...
 
bool recursiveEnabled () const
 
const std::list< std::string > & getCapabilityFilter () const
 
const std::list< std::string > & getRejectedServices () const
 
const std::set< std::string > & getPreferredInterfaceNames () const
 

Detailed Description

template<>
class Arc::EndpointQueryOptions< Endpoint >

The EntityRetriever<Endpoint> (a.k.a. ServiceEndpointRetriever) needs different options.

Constructor & Destructor Documentation

◆ EndpointQueryOptions()

Arc::EndpointQueryOptions< Endpoint >::EndpointQueryOptions ( bool  recursive = false,
const std::list< std::string > &  capabilityFilter = std::list<std::string>(),
const std::list< std::string > &  rejectedServices = std::list<std::string>(),
const std::set< std::string > &  preferredInterfaceNames = std::set<std::string>() 
)
inline

Options for recursivity, filtering of capabilities and rejecting services.

Parameters
[in]recursiveRecursive query means that if a service registry is discovered that will be also queried for additional services
[in]capabilityFilterOnly those services will be discovered which has at least one capability from this list.
[in]rejectedServicesIf a service's URL contains any item from this list, the services will be not returned among the results.
[in]preferredInterfaceNamesSet of preferred interface names

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