[Kde-pim] [Differential] [Commented On] D2096: ResourceBase: try to document a bit better what streaming is about

[dvratil (Daniel Vrátil)]

dvratil added inline comments.

INLINE COMMENTS

> resourcebase.h:515
> +     * @note The recommended way is therefore:
> +     * setDisableAutomaticItemDeliveryDone(true) +
> +     * setItemStreamingEnabled(true) + setTotalItems() +

Maybe a pseudocode would be even better? What do you think about this?

  setDisableAutomaticDeliveryDone(true);
  setItemStreamingEnabled(true);
  setTotalItems(X); // X = sum of all items in all batches
  
  while (...) {
      itemsRetrievedIncremental(...);
      // or itemsRetrieved(...);
  }
  
  itemsRetrievalDone();

> resourcebase.h:521
>       * @param amount number of items that will arrive in streaming mode
>       */
>      void setTotalItems(int amount);

@see setDisableStreamingEnabled(bool)
  @see setItemStreamingEnabled(bool)

> resourcebase.h:532
>       *
>       * @note This needs to be called once, before the item sync started.
>       *

...before the item sync **is** started

REPOSITORY
  rAKONADI Akonadi

REVISION DETAIL
  https://phabricator.kde.org/D2096

EMAIL PREFERENCES
  https://phabricator.kde.org/settings/panel/emailpreferences/

To: dfaure, dvratil
Cc: kde-pim, #kde_pim, dvasin, winterz, smartins, vkrause, mlaurent, knauss, dvratil
_______________________________________________
KDE PIM mailing list kde-pim at kde.org
https://mail.kde.org/mailman/listinfo/kde-pim
KDE PIM home page at http://pim.kde.org/