Skip to content

Update deprecated API with WriterHistory::create_change #1170

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update deprecated API with WriterHistory::create_change #1170

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/03-exports/aliases-api.include
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -936,12 +936,12 @@

.. |RTPSWriters-api| replace:: :cpp:class:`RTPSWriters <eprosima::fastdds::rtps::RTPSWriter>`
.. |WriterAttributes-api| replace:: :cpp:class:`WriterAttributes<eprosima::fastdds::rtps::WriterAttributes>`
.. |RTPSWriters::new_change-api| replace:: :cpp:func:`RTPSWriter::new_change() <eprosima::fastdds::rtps::RTPSWriter::new_change>`
.. |RTPSWriters::wait_for_all_acked-api| replace:: :cpp:func:`RTPSWriter::wait_for_all_acked <eprosima::fastdds::rtps::RTPSWriter::wait_for_all_acked>`

.. |History-api| replace:: :cpp:class:`History <eprosima::fastdds::rtps::History>`
.. |WriterHistory-api| replace:: :cpp:class:`WriterHistory <eprosima::fastdds::rtps::WriterHistory>`
.. |WriterHistory::add_change-api| replace:: :cpp:func:`WriterHistory::add_change() <eprosima::fastdds::rtps::WriterHistory::add_change>`
.. |WriterHistory::create_change-api| replace:: :cpp:func:`WriterHistory::create_change() <CacheChange_t* eprosima::fastdds::rtps::WriterHistory::create_change(uint32_t payload_size, ChangeKind_t change_kind, InstanceHandle_t handle)>`
.. |ReaderHistory-api| replace:: :cpp:class:`ReaderHistory <eprosima::fastdds::rtps::ReaderHistory>`
.. |CacheChange_t-api| replace:: :cpp:class:`CacheChange_t<eprosima::fastdds::rtps::CacheChange_t>`

Expand Down
4 changes: 2 additions & 2 deletions docs/fastdds/rtps_layer/rtps_layer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,9 @@ Changes are always managed by the History.
You can add a new :class:`CacheChange_t` to the History of the Writer to send data.
The procedure is as follows:

1. Request a :class:`CacheChange_t` from the Writer with |RTPSWriters::new_change-api|.
1. Request a :class:`CacheChange_t` from the Writer History with |WriterHistory::create_change-api|.
In order to allocate enough memory,
you need to provide a callback that returns the maximum number bytes in the payload.
you need to provide as argument the maximum number of bytes in the payload.
2. Fill the :class:`CacheChange_t` with the data.
3. Add it to the History with |WriterHistory::add_change-api|.

Expand Down