Chromium Code Reviews| OLD | NEW |
|---|---|
| (Empty) | |
| 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 | |
| 3 // found in the LICENSE file. | |
| 4 | |
| 5 #ifndef WEBKIT_FILEAPI_FILE_WRITER_H_ | |
| 6 #define WEBKIT_FILEAPI_FILE_WRITER_H_ | |
| 7 #pragma once | |
| 8 | |
| 9 #include "base/basictypes.h" | |
| 10 #include "net/base/completion_callback.h" | |
| 11 #include "net/base/net_errors.h" | |
|
kinuko
2012/04/24 09:26:50
This file is probably not needed in .h
kinaba
2012/04/24 09:47:42
Done.
| |
| 12 | |
| 13 namespace net { | |
| 14 class IOBuffer; | |
| 15 } | |
| 16 | |
| 17 namespace fileapi { | |
| 18 | |
| 19 // A generic interface for writing to a file-like object. | |
| 20 class FileWriter { | |
| 21 public: | |
| 22 // Closes the file. If there's an in-flight operation, it is canceled (i.e., | |
| 23 // the callback function associated with the operation is not called). | |
| 24 virtual ~FileWriter() {} | |
| 25 | |
| 26 // Writes to the current cursor position asynchronously. | |
| 27 // | |
| 28 // Up to buf_len bytes will be written. (In other words, partial | |
| 29 // writes are allowed.) If the write completed synchronously, it returns | |
| 30 // the number of bytes written. If the operation could not be performed, it | |
| 31 // returns an error code. Otherwise, net::ERR_IO_PENDING is returned, and the | |
| 32 // callback will be run on the thread where Write() was called when the write | |
| 33 // has completed. | |
| 34 // | |
| 35 // It is invalid to call Write while there is an in-flight async operation. | |
| 36 virtual int Write(net::IOBuffer* buf, int buf_len, | |
| 37 const net::CompletionCallback& callback) = 0; | |
| 38 | |
| 39 // Cancels an in-flight async operation. | |
| 40 // | |
| 41 // If the cancel is finished synchronously, it returns net::OK. If the | |
| 42 // cancel could not be performed, it returns an error code. Otherwise, | |
| 43 // net::ERR_IO_PENDING is returned, and the callback will be run on the thread | |
| 44 // where Cancel() was called when the cancel has completed. | |
|
kinuko
2012/04/24 09:26:50
Could you also mention that it returns with ERR_UN
kinaba
2012/04/24 09:47:42
Done.
| |
| 45 // | |
| 46 // In either case, the callback function passed to the in-flight async | |
| 47 // operation is dismissed immediately when Cancel() is called, and thus | |
| 48 // will never be called. | |
| 49 virtual int Cancel(const net::CompletionCallback& callback) = 0; | |
| 50 }; | |
| 51 | |
| 52 } // namespace fileapi | |
| 53 | |
| 54 #endif // WEBKIT_FILEAPI_FILE_WRITER_H_ | |
| 55 | |
| OLD | NEW |