1
0
mirror of https://github.com/codership/wsrep-lib.git synced 2025-07-25 21:41:56 +03:00

Document log_position param in client_service::prepare_data_for_replication()

This commit is contained in:
Daniele Sciascia
2019-02-14 08:53:20 +01:00
parent 68adbe35f6
commit e02f617d5f

View File

@ -100,12 +100,17 @@ namespace wsrep
/** /**
* Prepare a buffer containing data for the next fragment to replicate. * Prepare a buffer containing data for the next fragment to replicate.
* The caller may set log_position to record the database specific
* position corresponding to changes contained in the buffer.
* When the call returns, the log_position will be available to read
* from streaming_context::log_position().
* *
* @return Zero in case of success, non-zero on failure. * @return Zero in case of success, non-zero on failure.
* If there is no data to replicate, the method shall return * If there is no data to replicate, the method shall return
* zero and leave the buffer empty. * zero and leave the buffer empty.
*/ */
virtual int prepare_fragment_for_replication(wsrep::mutable_buffer&, size_t&) = 0; virtual int prepare_fragment_for_replication(wsrep::mutable_buffer& buffer,
size_t& log_position) = 0;
/** /**
* Remove fragments from the storage within current transaction. * Remove fragments from the storage within current transaction.