-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
move the exlpanation to How To Guide section.
Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
- Loading branch information
1 parent
18949c6
commit 1f8ca65
Showing
3 changed files
with
56 additions
and
47 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
.. _ZeroCopyLoanedMessages: | ||
|
||
Zero Copy Loaned Messages | ||
========================= | ||
|
||
.. contents:: Contents | ||
:depth: 1 | ||
:local: | ||
|
||
See the `Loaned Messages <https://design.ros2.org/articles/zero_copy.html>`__ article for details on ``ROS_DISABLE_LOANED_MESSAGES`` environment variable. | ||
|
||
How to disable Loaned Messages | ||
------------------------------ | ||
|
||
In default, *Loaned Messages* will try to borrow the memory from underlying middleware if it supports *Loaned Messages*. | ||
``ROS_DISABLE_LOANED_MESSAGES`` environment variable is provided to user that allows to disable *Loaned Messages* and fallback to normal publisher / subscription w/o any code change or middleware configuration. | ||
You can set the environment variable with the following command: | ||
|
||
.. tabs:: | ||
|
||
.. group-tab:: Linux | ||
|
||
.. code-block:: console | ||
export ROS_DISABLE_LOANED_MESSAGES=1 | ||
To maintain this setting between shell sessions, you can add the command to your shell startup script: | ||
|
||
.. code-block:: console | ||
echo "export ROS_DISABLE_LOANED_MESSAGES=1" >> ~/.bashrc | ||
.. group-tab:: macOS | ||
|
||
.. code-block:: console | ||
export ROS_DISABLE_LOANED_MESSAGES=1 | ||
To maintain this setting between shell sessions, you can add the command to your shell startup script: | ||
|
||
.. code-block:: console | ||
echo "export ROS_DISABLE_LOANED_MESSAGES=1" >> ~/.bash_profile | ||
.. group-tab:: Windows | ||
|
||
.. code-block:: console | ||
set ROS_DISABLE_LOANED_MESSAGES=1 | ||
If you want to make this permanent between shell sessions, also run: | ||
|
||
.. code-block:: console | ||
setx ROS_DISABLE_LOANED_MESSAGES 1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters