Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add explanation for ROS_DISABLE_LOANED_MESSAGES. #324

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions articles/zero_copy.md
Original file line number Diff line number Diff line change
Expand Up @@ -293,6 +293,17 @@ void
rclcpp::Subscription::handle_loaned_message(void * loaned_message, const rmw_message_info_t & message_info)
```

### ROS_DISABLE_LOANED_MESSAGES

By default, `Loaned Messages` will try to borrow memory from the underlying middleware.
The `ROS_DISABLE_LOANED_MESSAGES` environment variable is provided so the user can disable `Loaned Messages` and fallback to normal publisher / subscription without any code change or middleware configuration.

How to disable `Loaned Messages`:

```
export ROS_DISABLE_LOANED_MESSAGES=1
```

## Additional Considerations

### Loaning non-POD messages
Expand Down