1/*
2 * Copyright (C) 2013 Google Inc. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
6 * met:
7 *
8 *     * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 *     * Redistributions in binary form must reproduce the above
11 * copyright notice, this list of conditions and the following disclaimer
12 * in the documentation and/or other materials provided with the
13 * distribution.
14 *     * Neither the name of Google Inc. nor the names of its
15 * contributors may be used to endorse or promote products derived from
16 * this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30
31#ifndef Stream_h
32#define Stream_h
33
34#include "bindings/v8/ScriptWrappable.h"
35#include "weborigin/KURL.h"
36#include "wtf/PassRefPtr.h"
37#include "wtf/RefCounted.h"
38#include "wtf/text/WTFString.h"
39
40namespace WebCore {
41
42class Stream : public ScriptWrappable, public RefCounted<Stream> {
43public:
44    static PassRefPtr<Stream> create(const String& mediaType)
45    {
46        return adoptRef(new Stream(mediaType));
47    }
48
49    virtual ~Stream();
50
51    // Returns the internal URL referring to this stream.
52    const KURL& url() const { return m_internalURL; }
53    // Returns the media type of this stream.
54    const String& type() const { return m_mediaType; }
55
56    // Appends data to this stream.
57    void addData(const char* data, size_t len);
58    // Mark this stream finalized so that a reader of this stream is notified
59    // of EOF.
60    void finalize();
61
62    // Allow an external reader class to mark this object neutered so that they
63    // won't load the corresponding stream again. All stream objects are
64    // read-once for now.
65    void neuter() { m_isNeutered = true; }
66    bool isNeutered() const { return m_isNeutered; }
67
68protected:
69    explicit Stream(const String& mediaType);
70
71    // This is an internal URL referring to the blob data associated with this object. It serves
72    // as an identifier for this blob. The internal URL is never used to source the blob's content
73    // into an HTML or for FileRead'ing, public blob URLs must be used for those purposes.
74    KURL m_internalURL;
75
76    String m_mediaType;
77
78    bool m_isNeutered;
79};
80
81} // namespace WebCore
82
83#endif // Stream_h
84