OLD | NEW |
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef WEBKIT_FILEAPI_FILE_WRITER_H_ | 5 #ifndef WEBKIT_FILEAPI_FILE_WRITER_H_ |
6 #define WEBKIT_FILEAPI_FILE_WRITER_H_ | 6 #define WEBKIT_FILEAPI_FILE_WRITER_H_ |
7 #pragma once | 7 #pragma once |
8 | 8 |
9 #include "base/basictypes.h" | 9 #include "base/basictypes.h" |
10 #include "net/base/completion_callback.h" | 10 #include "net/base/completion_callback.h" |
(...skipping 13 matching lines...) Expand all Loading... |
24 | 24 |
25 // Writes to the current cursor position asynchronously. | 25 // Writes to the current cursor position asynchronously. |
26 // | 26 // |
27 // Up to buf_len bytes will be written. (In other words, partial | 27 // Up to buf_len bytes will be written. (In other words, partial |
28 // writes are allowed.) If the write completed synchronously, it returns | 28 // writes are allowed.) If the write completed synchronously, it returns |
29 // the number of bytes written. If the operation could not be performed, it | 29 // the number of bytes written. If the operation could not be performed, it |
30 // returns an error code. Otherwise, net::ERR_IO_PENDING is returned, and the | 30 // returns an error code. Otherwise, net::ERR_IO_PENDING is returned, and the |
31 // callback will be run on the thread where Write() was called when the write | 31 // callback will be run on the thread where Write() was called when the write |
32 // has completed. | 32 // has completed. |
33 // | 33 // |
| 34 // This errors out (either synchronously or via callback) with: |
| 35 // net::ERR_FILE_NOT_FOUND: When the target file is not found. |
| 36 // net::ERR_ACCESS_DENIED: When the target file is a directory or |
| 37 // the writer has no permission on the file. |
| 38 // net::ERR_FILE_NO_SPACE: When the write will result in out of quota |
| 39 // or there is not enough room left on the disk. |
| 40 // |
34 // It is invalid to call Write while there is an in-flight async operation. | 41 // It is invalid to call Write while there is an in-flight async operation. |
35 virtual int Write(net::IOBuffer* buf, int buf_len, | 42 virtual int Write(net::IOBuffer* buf, int buf_len, |
36 const net::CompletionCallback& callback) = 0; | 43 const net::CompletionCallback& callback) = 0; |
37 | 44 |
38 // Cancels an in-flight async operation. | 45 // Cancels an in-flight async operation. |
39 // | 46 // |
40 // If the cancel is finished synchronously, it returns net::OK. If the | 47 // If the cancel is finished synchronously, it returns net::OK. If the |
41 // cancel could not be performed, it returns an error code. Especially when | 48 // cancel could not be performed, it returns an error code. Especially when |
42 // there is no in-flight operation, net::ERR_UNEXPECTED is returned. | 49 // there is no in-flight operation, net::ERR_UNEXPECTED is returned. |
43 // Otherwise, net::ERR_IO_PENDING is returned, and the callback will be run on | 50 // Otherwise, net::ERR_IO_PENDING is returned, and the callback will be run on |
44 // the thread where Cancel() was called when the cancel has completed. It is | 51 // the thread where Cancel() was called when the cancel has completed. It is |
45 // invalid to call Cancel() more than once on the same async operation. | 52 // invalid to call Cancel() more than once on the same async operation. |
46 // | 53 // |
47 // In either case, the callback function passed to the in-flight async | 54 // In either case, the callback function passed to the in-flight async |
48 // operation is dismissed immediately when Cancel() is called, and thus | 55 // operation is dismissed immediately when Cancel() is called, and thus |
49 // will never be called. | 56 // will never be called. |
50 virtual int Cancel(const net::CompletionCallback& callback) = 0; | 57 virtual int Cancel(const net::CompletionCallback& callback) = 0; |
51 }; | 58 }; |
52 | 59 |
53 } // namespace fileapi | 60 } // namespace fileapi |
54 | 61 |
55 #endif // WEBKIT_FILEAPI_FILE_WRITER_H_ | 62 #endif // WEBKIT_FILEAPI_FILE_WRITER_H_ |
56 | |
OLD | NEW |