Source/WebCore/fileapi/AsyncFileStream.h

   1 /*
   2  * Copyright (C) 2010 Google Inc.  All rights reserved.
   3  * Copyright (C) 2010, 2012 Apple Inc. All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met:
   8  *
   9  *     * Redistributions of source code must retain the above copyright
  10  * notice, this list of conditions and the following disclaimer.
  11  *     * Redistributions in binary form must reproduce the above
  12  * copyright notice, this list of conditions and the following disclaimer
  13  * in the documentation and/or other materials provided with the
  14  * distribution.
  15  *     * Neither the name of Google Inc. nor the names of its
  16  * contributors may be used to endorse or promote products derived from
  17  * this software without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 #ifndef AsyncFileStream_h
  33 #define AsyncFileStream_h
  34
  35 #if ENABLE(BLOB)
  36
  37 #include <wtf/Forward.h>
  38 #include <wtf/RefCounted.h>
  39 #include <wtf/RefPtr.h>
  40
  41 namespace WebCore {
  42
  43 class FileStreamClient;
  44 class FileStream;
  45 class KURL;
  46
  47 class AsyncFileStream : public RefCounted<AsyncFileStream> {
  48 public:
  49     static PassRefPtr<AsyncFileStream> create(FileStreamClient*);
  50     ~AsyncFileStream();
  51
  52     void getSize(const String& path, double expectedModificationTime);
  53     void openForRead(const String& path, long long offset, long long length);
  54     void openForWrite(const String& path);
  55     void close();
  56     void read(char* buffer, int length);
  57     void write(const KURL& blobURL, long long position, int length);
  58     void truncate(long long position);
  59
  60     // Stops the proxy and schedules it to be destructed. All the pending tasks will be aborted and the file stream will be closed.
  61     // Note: the caller should deref the instance immediately after calling stop().
  62     void stop();
  63
  64     FileStreamClient* client() const { return m_client; }
  65     void setClient(FileStreamClient* client) { m_client = client; }
  66
  67 private:
  68     AsyncFileStream(FileStreamClient*);
  69
  70     // Called on File thread.
  71     void startOnFileThread();
  72     void stopOnFileThread();
  73     void getSizeOnFileThread(const String& path, double expectedModificationTime);
  74     void openForReadOnFileThread(const String& path, long long offset, long long length);
  75     void openForWriteOnFileThread(const String& path);
  76     void closeOnFileThread();
  77     void readOnFileThread(char* buffer, int length);
  78     void writeOnFileThread(const KURL& blobURL, long long position, int length);
  79     void truncateOnFileThread(long long position);
  80
  81     RefPtr<FileStream> m_stream;
  82
  83     FileStreamClient* m_client;
  84 };
  85
  86 } // namespace WebCore
  87
  88 #endif // ENABLE(BLOB)
  89
  90 #endif // AsyncFileStream_h