rcl  master
C API providing common ROS client library functionality.
Macros | Functions
rmw_implementation_identifier_check.h File Reference
#include "rcl/visibility_control.h"
Include dependency graph for rmw_implementation_identifier_check.h:

Go to the source code of this file.

Macros

#define RMW_IMPLEMENTATION_ENV_VAR_NAME   "RMW_IMPLEMENTATION"
 The environment variable name to control which RMW implementation is used.
 
#define RCL_ASSERT_RMW_ID_MATCHES_ENV_VAR_NAME   "RCL_ASSERT_RMW_ID_MATCHES"
 

Functions

rcl_ret_t rcl_rmw_implementation_identifier_check (void)
 Check whether the RMW implementation in use matches what the user requested. More...
 

Macro Definition Documentation

◆ RCL_ASSERT_RMW_ID_MATCHES_ENV_VAR_NAME

#define RCL_ASSERT_RMW_ID_MATCHES_ENV_VAR_NAME   "RCL_ASSERT_RMW_ID_MATCHES"

The environment variable name to control whether the chosen RMW implementation matches the one that is in use.

Function Documentation

◆ rcl_rmw_implementation_identifier_check()

rcl_ret_t rcl_rmw_implementation_identifier_check ( void  )

Check whether the RMW implementation in use matches what the user requested.

Returns
RCL_RET_OK if the RMW implementation in use matches what the user requested, or
RCL_RET_MISMATCHED_RMW_ID if the RMW implementation does not match, or
RCL_RET_BAD_ALLOC if memory allocation failed, or
RCL_RET_ERROR if some other error occurred.