package/source/zipapi/XBufferedThreadedStream.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
  10 #ifndef INCLUDED_PACKAGE_SOURCE_ZIPAPI_XBUFFEREDTHREADEDSTREAM_HXX
  11 #define INCLUDED_PACKAGE_SOURCE_ZIPAPI_XBUFFEREDTHREADEDSTREAM_HXX
  12
  13 #include <salhelper/thread.hxx>
  14 #include "XUnbufferedStream.hxx"
  15 #include <queue>
  16 #include <vector>
  17 #include <mutex>
  18 #include <condition_variable>
  19
  20 typedef css::uno::Sequence< sal_Int8 > Buffer;
  21
  22 class XBufferedThreadedStream : public cppu::WeakImplHelper< css::io::XInputStream >
  23 {
  24 private:
  25     const css::uno::Reference<XInputStream> mxSrcStream;
  26     sal_Int64 mnPos;                                           /// position in stream
  27     sal_Int64 mnStreamSize;                                    /// available size of stream
  28
  29     Buffer maInUseBuffer;                                   /// Buffer block in use
  30     int mnOffset;                                           /// position in maInUseBuffer
  31     std::queue < Buffer > maPendingBuffers;                 /// Buffers that are available for use
  32     std::queue < Buffer > maUsedBuffers;
  33
  34     rtl::Reference< salhelper::Thread > mxUnzippingThread;
  35     std::mutex maBufferProtector;                           /// mutex protecting Buffer queues.
  36     std::condition_variable maBufferConsumeResume;
  37     std::condition_variable maBufferProduceResume;
  38     bool mbTerminateThread;                                 /// indicates the failure of one of the threads
  39
  40     css::uno::Any maSavedException;                         /// exception caught during unzipping is saved to be thrown during reading
  41
  42     static const size_t nBufferLowWater = 2;
  43     static const size_t nBufferHighWater = 4;
  44     static const size_t nBufferSize = 32 * 1024;
  45
  46     const Buffer& getNextBlock();
  47     sal_Int64 remainingSize() const { return mnStreamSize - mnPos; }
  48     bool hasBytes() const { return mnPos < mnStreamSize; }
  49
  50     bool canProduce() const
  51     {
  52         return( mbTerminateThread || maPendingBuffers.size() < nBufferHighWater );
  53     }
  54
  55     bool canConsume() const
  56     {
  57         return( mbTerminateThread || !maPendingBuffers.empty() );
  58     }
  59
  60 public:
  61     XBufferedThreadedStream(
  62                   const css::uno::Reference<XInputStream>& xSrcStream,
  63                   sal_Int64 nStreamSize /* cf. sal_Int32 available(); */ );
  64
  65     virtual ~XBufferedThreadedStream() override;
  66
  67     void produce();
  68     void setTerminateThread();
  69     void saveException(const css::uno::Any &rAny) { maSavedException = rAny; }
  70
  71     // XInputStream
  72     virtual sal_Int32 SAL_CALL readBytes( css::uno::Sequence< sal_Int8 >& aData, sal_Int32 nBytesToRead ) override;
  73     virtual sal_Int32 SAL_CALL readSomeBytes( css::uno::Sequence< sal_Int8 >& aData, sal_Int32 nMaxBytesToRead ) override;
  74     virtual void SAL_CALL skipBytes( sal_Int32 nBytesToSkip ) override;
  75     virtual sal_Int32 SAL_CALL available(  ) override;
  76     virtual void SAL_CALL closeInput(  ) override;
  77 };
  78 #endif
  79
  80 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */