package/inc/ThreadedDeflater.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_PACKAGE_THREADEDDEFLATER_HXX
  21 #define INCLUDED_PACKAGE_THREADEDDEFLATER_HXX
  22
  23 #include <com/sun/star/uno/Sequence.hxx>
  24 #include <package/packagedllapi.hxx>
  25 #include <comphelper/threadpool.hxx>
  26 #include <atomic>
  27 #include <memory>
  28
  29 namespace ZipUtils
  30 {
  31 /// Parallel compression a stream using the libz deflate algorithm.
  32 ///
  33 /// Almost a replacement for the Deflater class. Call startDeflate() with the data,
  34 /// check with finished() or waitForTasks() and retrieve result with getOutput().
  35 /// The class will internally split into multiple threads.
  36 class ThreadedDeflater final
  37 {
  38     class Task;
  39     // Note: All this should be lock-less. Each task writes only to its part
  40     // of the data, flags are atomic.
  41     std::vector<std::vector<sal_Int8>> outBuffers;
  42     std::shared_ptr<comphelper::ThreadTaskTag> threadTaskTag;
  43     css::uno::Sequence<sal_Int8> inBuffer;
  44     int zlibLevel;
  45     std::atomic<int> pendingTasksCount;
  46
  47 public:
  48     // Unlike with Deflater class, bNoWrap is always true.
  49     ThreadedDeflater(sal_Int32 nSetLevel);
  50     ~ThreadedDeflater() COVERITY_NOEXCEPT_FALSE;
  51     void startDeflate(const css::uno::Sequence<sal_Int8>& rBuffer);
  52     void waitForTasks();
  53     bool finished() const;
  54     css::uno::Sequence<sal_Int8> getOutput() const;
  55     void clear();
  56 };
  57
  58 } // namespace
  59
  60 #endif
  61
  62 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */