d547d2ccb0582f529a55adbd33e0ecca5acf9f96
[WebKit-https.git] / Source / WebCore / Modules / streams / ReadableStreamReader.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 ReadableStreamReader_h
31 #define ReadableStreamReader_h
32
33 #if ENABLE(STREAMS_API)
34
35 #include "ActiveDOMObject.h"
36 #include "ReadableStream.h"
37 #include "ScriptWrappable.h"
38 #include <functional>
39 #include <wtf/Ref.h>
40 #include <wtf/RefCounted.h>
41
42 namespace WebCore {
43
44 // ReadableStreamReader implements the core of the streams API ReadableStreamReader functionality.
45 // It handles in particular access to the chunks and state of a ReadableStream.
46 // See https://streams.spec.whatwg.org/#reader-class for more information.
47 class ReadableStreamReader : public ActiveDOMObject, public ScriptWrappable, public RefCounted<ReadableStreamReader> {
48 public:
49     enum class State {
50         Readable,
51         Closed,
52         Errored
53     };
54
55     virtual ~ReadableStreamReader();
56
57     ReadableStream* stream() { return m_stream.get(); }
58
59     typedef std::function<void()> ClosedSuccessCallback;
60     typedef std::function<void()> ClosedErrorCallback;
61     void closed(ClosedSuccessCallback, ClosedErrorCallback);
62
63     void changeStateToClosed();
64
65 protected:
66     ReadableStreamReader(ReadableStream&);
67
68     void releaseStream();
69
70 private:
71     // ActiveDOMObject API.
72     const char* activeDOMObjectName() const override;
73     bool canSuspendForPageCache() const override;
74     void initialize();
75
76     RefPtr<ReadableStream> m_stream;
77     State m_state { State::Readable };
78
79     ClosedSuccessCallback m_closedSuccessCallback;
80 };
81
82 }
83
84 #endif
85
86 #endif // ReadableStream_h