Skip to content

Commit a49cd8b

Browse files
Update deprecated API with WriterHistory::create_change (#1170)
Signed-off-by: Carlos Ferreira González <carlosferreira@eprosima.com>
1 parent 3c8edb9 commit a49cd8b

2 files changed

Lines changed: 3 additions & 3 deletions

File tree

docs/03-exports/aliases-api.include

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -936,12 +936,12 @@
936936

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

942941
.. |History-api| replace:: :cpp:class:`History <eprosima::fastdds::rtps::History>`
943942
.. |WriterHistory-api| replace:: :cpp:class:`WriterHistory <eprosima::fastdds::rtps::WriterHistory>`
944943
.. |WriterHistory::add_change-api| replace:: :cpp:func:`WriterHistory::add_change() <eprosima::fastdds::rtps::WriterHistory::add_change>`
944+
.. |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)>`
945945
.. |ReaderHistory-api| replace:: :cpp:class:`ReaderHistory <eprosima::fastdds::rtps::ReaderHistory>`
946946
.. |CacheChange_t-api| replace:: :cpp:class:`CacheChange_t<eprosima::fastdds::rtps::CacheChange_t>`
947947

docs/fastdds/rtps_layer/rtps_layer.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,9 +94,9 @@ Changes are always managed by the History.
9494
You can add a new :class:`CacheChange_t` to the History of the Writer to send data.
9595
The procedure is as follows:
9696

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

0 commit comments

Comments
 (0)