Home | History | Annotate | Download | only in streams
      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/core/v8/ScriptWrappable.h"
     35 #include "core/dom/ActiveDOMObject.h"
     36 #include "platform/heap/Handle.h"
     37 #include "platform/weborigin/KURL.h"
     38 #include "wtf/PassRefPtr.h"
     39 #include "wtf/RefCounted.h"
     40 #include "wtf/text/WTFString.h"
     41 
     42 namespace blink {
     43 
     44 class ExecutionContext;
     45 
     46 class Stream FINAL : public RefCountedWillBeGarbageCollectedFinalized<Stream>, public ScriptWrappable, public ActiveDOMObject {
     47     DEFINE_WRAPPERTYPEINFO();
     48 public:
     49     static PassRefPtrWillBeRawPtr<Stream> create(ExecutionContext* context, const String& mediaType)
     50     {
     51         RefPtrWillBeRawPtr<Stream> stream = adoptRefWillBeNoop(new Stream(context, mediaType));
     52         stream->suspendIfNeeded();
     53         return stream.release();
     54     }
     55 
     56     virtual ~Stream();
     57 
     58     // Returns the internal URL referring to this stream.
     59     const KURL& url() const { return m_internalURL; }
     60     // Returns the media type of this stream.
     61     const String& type() const { return m_mediaType; }
     62 
     63     // Appends data to this stream.
     64     void addData(const char* data, size_t len);
     65     // Mark this stream finalized so that a reader of this stream is notified
     66     // of EOF.
     67     void finalize();
     68     // Mark this stream finalized due to an error so that a reader of this
     69     // stream is notified of EOF due to the error.
     70     void abort();
     71 
     72     // Allow an external reader class to mark this object neutered so that they
     73     // won't load the corresponding stream again. All stream objects are
     74     // read-once for now.
     75     void neuter() { m_isNeutered = true; }
     76     bool isNeutered() const { return m_isNeutered; }
     77 
     78     // Implementation of ActiveDOMObject.
     79     //
     80     // FIXME: Implement suspend() and resume() when necessary.
     81     virtual void suspend() OVERRIDE;
     82     virtual void resume() OVERRIDE;
     83     virtual void stop() OVERRIDE;
     84 
     85     void trace(Visitor*) { }
     86 
     87 protected:
     88     Stream(ExecutionContext*, const String& mediaType);
     89 
     90     // This is an internal URL referring to the blob data associated with this object. It serves
     91     // as an identifier for this blob. The internal URL is never used to source the blob's content
     92     // into an HTML or for FileRead'ing, public blob URLs must be used for those purposes.
     93     KURL m_internalURL;
     94 
     95     String m_mediaType;
     96 
     97     bool m_isNeutered;
     98 };
     99 
    100 } // namespace blink
    101 
    102 #endif // Stream_h
    103