Source/WebCore/Modules/streams/ReadableStreamController.h

   1 /*
   2  * Copyright (C) 2015 Canon Inc.
   3  * Copyright (C) 2015 Igalia S.L.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted, provided that the following conditions
   7  * are required to be met:
   8  *
   9  * 1.  Redistributions of source code must retain the above copyright
  10  *     notice, this list of conditions and the following disclaimer.
  11  * 2.  Redistributions in binary form must reproduce the above copyright
  12  *     notice, this list of conditions and the following disclaimer in the
  13  *     documentation and/or other materials provided with the distribution.
  14  * 3.  Neither the name of Canon Inc. nor the names of
  15  *     its contributors may be used to endorse or promote products derived
  16  *     from this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY CANON INC. AND ITS CONTRIBUTORS "AS IS" AND ANY
  19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  21  * DISCLAIMED. IN NO EVENT SHALL CANON INC. AND ITS CONTRIBUTORS BE LIABLE FOR
  22  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  24  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  25  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  26  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  27  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 #ifndef ReadableStreamController_h
  31 #define ReadableStreamController_h
  32
  33 #if ENABLE(STREAMS_API)
  34
  35 #include "ReadableJSStream.h"
  36
  37 namespace WebCore {
  38
  39 // This class is only used for JS source readable streams to allow enqueuing, closing or erroring a readable stream.
  40 // Its definition is at https://streams.spec.whatwg.org/#rs-controller-class.
  41 // Note that its constructor is taking a ReadableJSStream as it should only be used for JS sources.
  42 class ReadableStreamController {
  43 public:
  44     explicit ReadableStreamController(ReadableJSStream& stream)
  45         : m_stream(stream) { }
  46
  47     ReadableJSStream& stream() { return m_stream; }
  48
  49     void ref() { m_stream.ref(); }
  50     void deref() { m_stream.deref(); }
  51
  52     double desiredSize() const { return m_stream.desiredSize(); }
  53
  54 private:
  55     ReadableJSStream& m_stream;
  56 };
  57
  58 }
  59
  60 #endif
  61
  62 #endif // ReadableStream_h