Directories on local system used by the node. More...

#include <NodeDirectories.h>

Public Attributes
boost::filesystem::path	system_data_dir
	Robot Raconteur System data directory.
boost::filesystem::path	system_config_dir
	Robot Raconteur System config directory.
boost::filesystem::path	system_state_dir
	Robot Raconteur System config directory.
boost::filesystem::path	system_cache_dir
	Robot Raconteur System cache directory.
boost::filesystem::path	system_run_dir
	Robot Raconteur System run directory.
boost::filesystem::path	user_data_dir
	Robot Raconteur User data directory.
boost::filesystem::path	user_config_dir
	Robot Raconteur User config directory.
boost::filesystem::path	user_state_dir
	Robot Raconteur User state directory.
boost::filesystem::path	user_cache_dir
	Robot Raconteur User cache directory.
boost::filesystem::path	user_run_dir
	Robot Raconteur User state directory.

Detailed Description

Directories on local system used by the node.

The node uses local directories to load configuration information, cache data, communicate with other processes, etc. These directories can be configured using the NodeDirectories structure and RobotRaconteurNode::GetNodeDirectories() and RobotRaconteurNode::SetNodeDirectories() Use GetDefaultNodeDirectories() to retrieve the default directories.

Note: for root user, system and user directories are identical

Member Data Documentation

◆ system_cache_dir

boost::filesystem::path RobotRaconteur::NodeDirectories::system_cache_dir

Robot Raconteur System cache directory.

Default value Unix: /var/cache/robotraconteur Default value Windows: PROGRAMDATA%\RobotRaconteur\cache Environmental variable override: ROBOTRACONTEUR_SYSTEM_CACHE_DIR

◆ system_config_dir

boost::filesystem::path RobotRaconteur::NodeDirectories::system_config_dir

Robot Raconteur System config directory.

Default value Unix: /etc/robotraconteur Default value Windows: PROGRAMDATA%\RobotRaconteur\ Environmental variable override: ROBOTRACONTEUR_SYSTEM_CONFIG_DIR

◆ system_data_dir

boost::filesystem::path RobotRaconteur::NodeDirectories::system_data_dir

Robot Raconteur System data directory.

Default value Unix : /usr/local/share/robotraconteur Default value Windows: PROGRAMDATA%\RobotRaconteur\data Environmental variable override: ROBOTRACONTEUR_SYSTEM_DATA_DIR

◆ system_run_dir

boost::filesystem::path RobotRaconteur::NodeDirectories::system_run_dir

Robot Raconteur System run directory.

Default value: /var/run/robotraconteur Default value Windows: PROGRAMDATA%\RobotRaconteur\run Environmental variable override: ROBOTRACONTEUR_SYSTEM_RUN_DIR

◆ system_state_dir

boost::filesystem::path RobotRaconteur::NodeDirectories::system_state_dir

Robot Raconteur System config directory.

Default value Unix: /var/lib/robotraconteur Default value Windows: PROGRAMDATA%\RobotRaconteur\state Environmental variable override: ROBOTRACONTEUR_SYSTEM_STATE_DIR

◆ user_cache_dir

boost::filesystem::path RobotRaconteur::NodeDirectories::user_cache_dir

Robot Raconteur User cache directory.

Default value Unix: $HOME/.cache/RobotRaconteur or $XDG_CACHE_HOME/RobotRaconteur Default value Windows: LOCALAPPDATA%\RobotRaconteur\cache Environmental variable override: ROBOTRACONTEUR_USER_CACHE_DIR

◆ user_config_dir

boost::filesystem::path RobotRaconteur::NodeDirectories::user_config_dir

Robot Raconteur User config directory.

Default value Unix: $HOME/.config/RobotRaconteur or $XDG_CONFIG_HOME/RobotRaconteur Default value Windows: LOCALAPPDATA%\RobotRaconteur\ Environmental variable override: ROBOTRACONTEUR_USER_CONFIG_DIR

◆ user_data_dir

boost::filesystem::path RobotRaconteur::NodeDirectories::user_data_dir

Robot Raconteur User data directory.

Default value Unix: $HOME/.local/share/RobotRaconteur or $XDG_DATA_HOME/RobotRaconteur Default value Windows: LOCALAPPDATA%\RobotRaconteur\data Environmental variable override: ROBOTRACONTEUR_USER_DATA_DIR

◆ user_run_dir

boost::filesystem::path RobotRaconteur::NodeDirectories::user_run_dir

Robot Raconteur User state directory.

Default value Unix: $XDG_RUNTIME_DIR/robotraconteur or /tmp/robotraconteur-run-$UID Default value Windows: LOCALAPPDATA%\RobotRaconteur\run Default value for root: {system_run_dir}/root Environmental variable override: ROBOTRACONTEUR_USER_RUN_DIR

◆ user_state_dir

boost::filesystem::path RobotRaconteur::NodeDirectories::user_state_dir