Subscription.h File Reference

Go to the source code of this file.

Classes
class	RobotRaconteur::ServiceSubscriptionFilterNode
	Subscription filter node information. More...
class	RobotRaconteur::ServiceSubscriptionFilterAttribute
	Subscription filter attribute for use with ServiceSubscriptionFilter. More...
class	RobotRaconteur::ServiceSubscriptionFilterAttributeGroup
	Subscription filter attribute group for use with ServiceSubscriptionFilter. More...
class	RobotRaconteur::ServiceSubscriptionFilter
	Subscription filter. More...
class	RobotRaconteur::ServiceSubscriptionClientID
	ClientID for use with ServiceSubscription. More...
class	RobotRaconteur::ServiceInfo2Subscription
	Subscription for information about detected services. More...
class	RobotRaconteur::ServiceSubscription
	Subscription that automatically connects services and manages lifecycle of connected services. More...
class	RobotRaconteur::WireSubscriptionBase
	Base class for WireSubscription. More...
class	RobotRaconteur::WireSubscription< T >
	Subscription for wire members that aggregates the values from client wire connections. More...
class	RobotRaconteur::PipeSubscriptionBase
	Base class for PipeSubscription. More...
class	RobotRaconteur::PipeSubscription< T >
	Subscription for pipe members that aggregates incoming packets from client pipe endpoints. More...
class	RobotRaconteur::SubObjectSubscription
	Subscription for sub objects of the default client. More...
struct	RobotRaconteur::ServiceSubscriptionManagerDetails
	ServiceSubscriptionManager subscription connection information. More...
class	RobotRaconteur::ServiceSubscriptionManager
	Class to manage multiple subscriptions to services. More...

Typedefs
using	RobotRaconteur::ServiceSubscriptionFilterNodePtr = boost::shared_ptr< ServiceSubscriptionFilterNode >
	Convenience alias for ServiceSubscriptionFilterNode shared_ptr.
using	RobotRaconteur::ServiceSubscriptionFilterPtr = boost::shared_ptr< ServiceSubscriptionFilter >
	Convenience alias for ServiceSubscriptionFilter shared_ptr.
using	RobotRaconteur::ServiceInfo2SubscriptionPtr = boost::shared_ptr< ServiceInfo2Subscription >
	Convenience alias for ServiceInfo2Subscription shared_ptr.
using	RobotRaconteur::ServiceSubscriptionPtr = boost::shared_ptr< ServiceSubscription >
	Convenience alias for ServiceSubscription shared_ptr.
template<typename T >
using	RobotRaconteur::PipeSubscriptionPtr = boost::shared_ptr< PipeSubscription< T > >
	Convenience alias for PipeSubscription shared_ptr.
template<typename T >
using	RobotRaconteur::WireSubscriptionPtr = boost::shared_ptr< WireSubscription< T > >
	Convenience alias for WireSubscription shared_ptr.
using	RobotRaconteur::SubObjectSubscriptionPtr = boost::shared_ptr< SubObjectSubscription >
	Convenience alias for SubObjectSubscription shared_ptr.

Enumerations
enum	RobotRaconteur::ServiceSubscriptionFilterAttributeGroupOperation { RobotRaconteur::ServiceSubscriptionFilterAttributeGroupOperation_OR , RobotRaconteur::ServiceSubscriptionFilterAttributeGroupOperation_AND , RobotRaconteur::ServiceSubscriptionFilterAttributeGroupOperation_NOR , RobotRaconteur::ServiceSubscriptionFilterAttributeGroupOperation_NAND }
	Comparison operations for ServiceSubscriptionFilterAttributeGroup. More...
enum	RobotRaconteur::ServiceSubscriptionManager_CONNECTION_METHOD { RobotRaconteur::ServiceSubscriptionManager_CONNECTION_METHOD_DEFAULT , RobotRaconteur::ServiceSubscriptionManager_CONNECTION_METHOD_URL , RobotRaconteur::ServiceSubscriptionManager_CONNECTION_METHOD_TYPE }
	Connection method for ServiceSubscriptionManager subscription. More...

Functions
ServiceSubscriptionFilterAttribute	RobotRaconteur::CreateServiceSubscriptionFilterAttributeRegex (boost::string_ref regex_value)
	Create a ServiceSubscriptionFilterAttribute from a regex string. More...
ServiceSubscriptionFilterAttribute	RobotRaconteur::CreateServiceSubscriptionFilterAttributeRegex (boost::string_ref name, boost::string_ref regex_value)
	Create a ServiceSubscriptionFilterAttribute from a regex string. More...
ServiceSubscriptionFilterAttribute	RobotRaconteur::CreateServiceSubscriptionFilterAttributeCombinedIdentifier (boost::string_ref combined_identifier)
	Create a ServiceSubscriptionFilterAttribute from a combined identifier string. More...
ServiceSubscriptionFilterAttribute	RobotRaconteur::CreateServiceSubscriptionFilterAttributeIdentifier (boost::string_ref identifier_name, boost::string_ref uuid_string)
	Create a ServiceSubscriptionFilterAttribute from an identifier. More...
ServiceSubscriptionFilterAttribute	RobotRaconteur::CreateServiceSubscriptionFilterAttributeIdentifier (boost::string_ref name, boost::string_ref identifier_name, boost::string_ref uuid_string)
	Create a ServiceSubscriptionFilterAttribute from an identifier. More...

Detailed Description

Author

John Wason, PhD

Copyright

Copyright 2011-2020 Wason Technology, LLC

License

Software License Agreement (Apache License)

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Enumeration Type Documentation

ServiceSubscriptionFilterAttributeGroupOperation

enum RobotRaconteur::ServiceSubscriptionFilterAttributeGroupOperation

Comparison operations for ServiceSubscriptionFilterAttributeGroup.

Enumerator
ServiceSubscriptionFilterAttributeGroupOperation_OR	OR operation.
ServiceSubscriptionFilterAttributeGroupOperation_AND	AND operation.
ServiceSubscriptionFilterAttributeGroupOperation_NOR	NOR operation. Also used for NOT.
ServiceSubscriptionFilterAttributeGroupOperation_NAND	NAND operation.

ServiceSubscriptionManager_CONNECTION_METHOD

enum RobotRaconteur::ServiceSubscriptionManager_CONNECTION_METHOD

Connection method for ServiceSubscriptionManager subscription.

Select between using URLs or service types for subscription

Enumerator
ServiceSubscriptionManager_CONNECTION_METHOD_DEFAULT	Implicitly select between URL and service types.
ServiceSubscriptionManager_CONNECTION_METHOD_URL	Use URLs types for subscription.
ServiceSubscriptionManager_CONNECTION_METHOD_TYPE	Use service types for subscription.

Function Documentation

CreateServiceSubscriptionFilterAttributeCombinedIdentifier()

ServiceSubscriptionFilterAttribute RobotRaconteur::CreateServiceSubscriptionFilterAttributeCombinedIdentifier

(

boost::string_ref

combined_identifier

)

Create a ServiceSubscriptionFilterAttribute from a combined identifier string.

The identifier may be a name, UUID, or a combination of both using a "|" to separate the name and UUID.

Parameters

value

The identifier as a string

Returns

ServiceSubscriptionFilterAttribute The created attribute

CreateServiceSubscriptionFilterAttributeIdentifier() [1/2]

ServiceSubscriptionFilterAttribute RobotRaconteur::CreateServiceSubscriptionFilterAttributeIdentifier	(	boost::string_ref	identifier_name,
		boost::string_ref	uuid_string
	)

Create a ServiceSubscriptionFilterAttribute from an identifier.

Parameters

identifier_name	The identifier name
uuid_string	The identifier UUID as a string

Returns

ServiceSubscriptionFilterAttribute The created attribute

CreateServiceSubscriptionFilterAttributeIdentifier() [2/2]

ServiceSubscriptionFilterAttribute RobotRaconteur::CreateServiceSubscriptionFilterAttributeIdentifier	(	boost::string_ref	name,
		boost::string_ref	identifier_name,
		boost::string_ref	uuid_string
	)

Create a ServiceSubscriptionFilterAttribute from an identifier.

Parameters

name	The attribute name
identifier_name	The identifier name
uuid_string	The identifier UUID as a string

Returns

ServiceSubscriptionFilterAttribute The created attribute

CreateServiceSubscriptionFilterAttributeRegex() [1/2]

ServiceSubscriptionFilterAttribute RobotRaconteur::CreateServiceSubscriptionFilterAttributeRegex	(	boost::string_ref	name,
		boost::string_ref	regex_value
	)

Create a ServiceSubscriptionFilterAttribute from a regex string.

Parameters

name	The attribute name
regex_value	The regex string to compile

Returns

ROBOTRACONTEUR_CORE_API

CreateServiceSubscriptionFilterAttributeRegex() [2/2]

ServiceSubscriptionFilterAttribute RobotRaconteur::CreateServiceSubscriptionFilterAttributeRegex

(

boost::string_ref

regex_value

)

Create a ServiceSubscriptionFilterAttribute from a regex string.

Parameters

regex_value

The regex string to compile

Returns

ServiceSubscriptionFilterAttribute The created attribute