ROS 2 rclcpp + rcl - jazzy  jazzy
ROS 2 C++ Client Library with ROS Client Library
Macros | Functions | Variables
domain_id.h File Reference
#include <stddef.h>
#include "rcl/types.h"
#include "rcl/visibility_control.h"
#include "rmw/domain_id.h"
Include dependency graph for domain_id.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define RCL_DEFAULT_DOMAIN_ID   RMW_DEFAULT_DOMAIN_ID
 The default domain ID used by RCL.
 

Functions

RCL_PUBLIC rcl_ret_t rcl_get_default_domain_id (size_t *domain_id)
 Determine the default domain ID, based on the environment. More...
 

Variables

const char *const RCL_DOMAIN_ID_ENV_VAR
 

Function Documentation

◆ rcl_get_default_domain_id()

RCL_PUBLIC rcl_ret_t rcl_get_default_domain_id ( size_t *  domain_id)

Determine the default domain ID, based on the environment.

Parameters
[out]domain_idMust not be NULL.
Returns
RCL_RET_INVALID_ARGUMENT if an argument is invalid, or,
RCL_RET_ERROR in case of an unexpected error, or,
RCL_RET_OK.

Definition at line 28 of file domain_id.c.

References RCL_RET_ERROR, and RCL_RET_INVALID_ARGUMENT.

Referenced by rcl_init(), and rclcpp::InitOptions::use_default_domain_id().

Here is the caller graph for this function: