ReadableStreamController.h   [plain text]

/*
 * Copyright (C) 2015 Canon Inc.
 * Copyright (C) 2015 Igalia S.L.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted, provided that the following conditions
 * are required to be met:
 *
 * 1.  Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 * 2.  Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 * 3.  Neither the name of Canon Inc. nor the names of
 *     its contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY CANON INC. AND ITS CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL CANON INC. AND ITS CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef ReadableStreamController_h
#define ReadableStreamController_h

#if ENABLE(STREAMS_API)

#include "ReadableJSStream.h"

namespace WebCore {

typedef int ExceptionCode;

// This class is only used for JS source readable streams to allow enqueuing, closing or erroring a readable stream.
// Its definition is at https://streams.spec.whatwg.org/#rs-controller-class.
// Note that its constructor is taking a ReadableJSStream as it should only be used for JS sources.
class ReadableStreamController {
public:
    explicit ReadableStreamController(ReadableJSStream& stream)
        : m_stream(stream) { }

    ReadableJSStream& stream() { return m_stream; }

    void error(JSC::ExecState* state, JSC::JSValue value, ExceptionCode& ec) { m_stream.error(*state, value, ec); }

    void enqueue(JSC::ExecState* state, JSC::JSValue value) { m_stream.enqueue(*state, value); }

    void ref() { m_stream.ref(); }
    void deref() { m_stream.deref(); }

    void close(ExceptionCode& ec) { m_stream.close(ec); }
    double desiredSize() const { return m_stream.desiredSize(); }

private:
    ReadableJSStream& m_stream;
};

}

#endif

#endif // ReadableStream_h