[Streams API] Implement a barebone ReadableStream interface
[WebKit-https.git] / Source / WebCore / Modules / streams / ReadableStreamSource.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 ReadableStreamSource_h
31 #define ReadableStreamSource_h
32
33 #if ENABLE(STREAMS_API)
34
35 #include "ExceptionCode.h"
36 #include <wtf/RefCounted.h>
37 #include <wtf/text/WTFString.h>
38
39 namespace WebCore {
40
41 // ReadableStreamSource is the interface used by ReadableStream to pull data.
42 class ReadableStreamSource: public RefCounted<ReadableStreamSource> {
43 public:
44     virtual ~ReadableStreamSource() { }
45
46     virtual void pull() { }
47
48     virtual bool shouldApplyBackpressure(unsigned /*queueSize*/)
49     {
50         return true;
51     }
52
53     // Return true if cancelled (sync case) and false in async case.
54     virtual bool cancel(const String& /*reason*/)
55     {
56         return true;
57     }
58
59     virtual bool isErrored() { return false; }
60 };
61
62 }
63
64 #endif
65
66 #endif // ReadableStreamSource_h