Robot Raconteur Core C++ Library
Loading...
Searching...
No Matches
RobotRaconteur::ServiceSubscriptionManagerDetails Struct Reference

ServiceSubscriptionManager subscription connection information. More...

#include <Subscription.h>

Public Member Functions

 ServiceSubscriptionManagerDetails ()
 Construct a new ServiceSubscriptionManagerDetails object.
 ServiceSubscriptionManagerDetails (const boost::string_ref &Name, ServiceSubscriptionManager_CONNECTION_METHOD ConnectionMethod=ServiceSubscriptionManager_CONNECTION_METHOD_DEFAULT, const std::vector< std::string > &Urls=std::vector< std::string >(), const boost::string_ref &UrlUsername="", const boost::intrusive_ptr< RRMap< std::string, RRValue > > &UrlCredentials=boost::intrusive_ptr< RRMap< std::string, RRValue > >(), const std::vector< std::string > &ServiceTypes=std::vector< std::string >(), const boost::shared_ptr< ServiceSubscriptionFilter > &Filter=boost::shared_ptr< ServiceSubscriptionFilter >(), bool Enabled=true)
 Construct a new ServiceSubscriptionManagerDetails object with parameters.

Public Attributes

std::string Name
 The local name of the subscription.
ServiceSubscriptionManager_CONNECTION_METHOD ConnectionMethod
 The connection method to use, URL or service type.
std::vector< std::string > Urls
 The URLs to use for subscription.
std::string UrlUsername
 The username to use for URLs (optional).
boost::intrusive_ptr< RRMap< std::string, RRValue > > UrlCredentials
 The credentials to use for URLs (optional).
std::vector< std::string > ServiceTypes
 The service types to use for subscription.
boost::shared_ptr< ServiceSubscriptionFilterFilter
 The filter to use for subscription when service type is used (optional).
bool Enabled
 If the subscription is enabled.

Detailed Description

ServiceSubscriptionManager subscription connection information.

Contains the connection information for a ServiceSubscriptionManager subscription and the local name of the subscription

Constructor & Destructor Documentation

◆ ServiceSubscriptionManagerDetails()

RobotRaconteur::ServiceSubscriptionManagerDetails::ServiceSubscriptionManagerDetails ( const boost::string_ref & Name,
ServiceSubscriptionManager_CONNECTION_METHOD ConnectionMethod = ServiceSubscriptionManager_CONNECTION_METHOD_DEFAULT,
const std::vector< std::string > & Urls = std::vector< std::string >(),
const boost::string_ref & UrlUsername = "",
const boost::intrusive_ptr< RRMap< std::string, RRValue > > & UrlCredentials = boost::intrusive_ptr< RRMap< std::string, RRValue > >(),
const std::vector< std::string > & ServiceTypes = std::vector< std::string >(),
const boost::shared_ptr< ServiceSubscriptionFilter > & Filter = boost::shared_ptr< ServiceSubscriptionFilter >(),
bool Enabled = true )

Construct a new ServiceSubscriptionManagerDetails object with parameters.

Parameters
NameThe local name of the subscription
ConnectionMethodThe connection method to use, URL or service type
UrlsThe URLs to use for subscription
UrlUsernameThe username to use for URLs (optional)
UrlCredentialsThe credentials to use for URLs (optional)
ServiceTypesThe service types to use for subscription
FilterThe filter to use for subscription when service type is used (optional)
EnabledIf the subscription is enabled

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