LocalIdentifiersManager.h File Reference

Go to the source code of this file.

Functions
LocalIdentifierLockPtr	RobotRaconteur::Companion::Util::GetIdentifierForNameAndLock (const std::string &category, const std::string &name, boost::shared_ptr< RobotRaconteur::RobotRaconteurNode > node=boost::shared_ptr< RobotRaconteur::RobotRaconteurNode >())
	Get the Identifier For Name And Lock object.

Detailed Description

Author

John Wason, PhD

Copyright

Copyright 2023 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.

Function Documentation

GetIdentifierForNameAndLock()

LocalIdentifierLockPtr RobotRaconteur::Companion::Util::GetIdentifierForNameAndLock	(	const std::string &	category,
		const std::string &	name,
		boost::shared_ptr< RobotRaconteur::RobotRaconteurNode >	node = boost::shared_ptr< RobotRaconteur::RobotRaconteurNode >() )

Get the Identifier For Name And Lock object.

This function is used to get a local identifier for a name. The identifier is locked to prevent other processes from using the same identifier. The identifier is locked until the LocalIdentifierLockPtr is destroyed.

This function is used to automatically generate UUID identifiers for services from a name and persist them to the local system.

Parameters

category	The category of the identifier. Should be "device" in most cases.
name	The name of the identifier
node	The Robot Raconteur node

Returns

LocalIdentifierLockPtr