| 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 // This file defines FileStream::Context class. | 5 // This file defines FileStream::Context class. |
| 6 // The general design of FileStream is as follows: file_stream.h defines | 6 // The general design of FileStream is as follows: file_stream.h defines |
| 7 // FileStream class which basically is just an "wrapper" not containing any | 7 // FileStream class which basically is just an "wrapper" not containing any |
| 8 // specific implementation details. It re-routes all its method calls to | 8 // specific implementation details. It re-routes all its method calls to |
| 9 // the instance of FileStream::Context (FileStream holds a scoped_ptr to | 9 // the instance of FileStream::Context (FileStream holds a scoped_ptr to |
| 10 // FileStream::Context instance). Context was extracted into a different class | 10 // FileStream::Context instance). Context was extracted into a different class |
| (...skipping 143 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 154 void OnFileOpened(); | 154 void OnFileOpened(); |
| 155 | 155 |
| 156 #if defined(OS_WIN) | 156 #if defined(OS_WIN) |
| 157 void IOCompletionIsPending(const CompletionCallback& callback, IOBuffer* buf); | 157 void IOCompletionIsPending(const CompletionCallback& callback, IOBuffer* buf); |
| 158 | 158 |
| 159 // Implementation of MessageLoopForIO::IOHandler. | 159 // Implementation of MessageLoopForIO::IOHandler. |
| 160 virtual void OnIOCompleted(base::MessageLoopForIO::IOContext* context, | 160 virtual void OnIOCompleted(base::MessageLoopForIO::IOContext* context, |
| 161 DWORD bytes_read, | 161 DWORD bytes_read, |
| 162 DWORD error) override; | 162 DWORD error) override; |
| 163 | 163 |
| 164 // Invokes the user callback. |
| 165 void InvokeUserCallback(); |
| 166 |
| 167 // Deletes an orphaned context. |
| 168 void DeleteOrphanedContext(); |
| 169 |
| 164 // The ReadFile call on Windows can execute synchonously at times. | 170 // The ReadFile call on Windows can execute synchonously at times. |
| 165 // http://support.microsoft.com/kb/156932. This ends up blocking the calling | 171 // http://support.microsoft.com/kb/156932. This ends up blocking the calling |
| 166 // thread which is undesirable. To avoid this we execute the ReadFile call | 172 // thread which is undesirable. To avoid this we execute the ReadFile call |
| 167 // on a worker thread. | 173 // on a worker thread. |
| 168 // The |context| parameter is a weak pointer instance passed to the worker | 174 // The |context| parameter is a pointer to the current Context instance. It |
| 169 // pool. | 175 // is safe to pass this as is to the pool as the Context instance should |
| 176 // remain valid until the pending Read operation completes. |
| 170 // The |file| parameter is the handle to the file being read. | 177 // The |file| parameter is the handle to the file being read. |
| 171 // The |buf| parameter is the buffer where we want the ReadFile to read the | 178 // The |buf| parameter is the buffer where we want the ReadFile to read the |
| 172 // data into. | 179 // data into. |
| 173 // The |buf_len| parameter contains the number of bytes to be read. | 180 // The |buf_len| parameter contains the number of bytes to be read. |
| 174 // The |overlapped| parameter is a pointer to the OVERLAPPED structure being | 181 // The |overlapped| parameter is a pointer to the OVERLAPPED structure being |
| 175 // used. | 182 // used. |
| 176 // The |origin_thread_loop| is a MessageLoopProxy instance used to post tasks | 183 // The |origin_thread_loop| is a MessageLoopProxy instance used to post tasks |
| 177 // back to the originating thread. | 184 // back to the originating thread. |
| 178 static void ReadAsync( | 185 static void ReadAsync( |
| 179 const base::WeakPtr<FileStream::Context>& context, | 186 FileStream::Context* context, |
| 180 HANDLE file, | 187 HANDLE file, |
| 181 scoped_refptr<net::IOBuffer> buf, | 188 scoped_refptr<net::IOBuffer> buf, |
| 182 int buf_len, | 189 int buf_len, |
| 183 OVERLAPPED* overlapped, | 190 OVERLAPPED* overlapped, |
| 184 scoped_refptr<base::MessageLoopProxy> origin_thread_loop); | 191 scoped_refptr<base::MessageLoopProxy> origin_thread_loop); |
| 185 | 192 |
| 186 // This callback executes on the main calling thread. It informs the caller | 193 // This callback executes on the main calling thread. It informs the caller |
| 187 // about the result of the ReadFile call. | 194 // about the result of the ReadFile call. |
| 195 // The |read_file_ret| parameter contains the return value of the ReadFile |
| 196 // call. |
| 197 // The |bytes_read| contains the number of bytes read from the file, if |
| 198 // ReadFile succeeds. |
| 188 // The |os_error| parameter contains the value of the last error returned by | 199 // The |os_error| parameter contains the value of the last error returned by |
| 189 // the ReadFile API. | 200 // the ReadFile API. |
| 190 void ReadAsyncResult(DWORD os_error); | 201 void ReadAsyncResult(BOOL read_file_ret, DWORD bytes_read, DWORD os_error); |
| 191 | 202 |
| 192 #elif defined(OS_POSIX) | 203 #elif defined(OS_POSIX) |
| 193 // ReadFileImpl() is a simple wrapper around read() that handles EINTR | 204 // ReadFileImpl() is a simple wrapper around read() that handles EINTR |
| 194 // signals and calls RecordAndMapError() to map errno to net error codes. | 205 // signals and calls RecordAndMapError() to map errno to net error codes. |
| 195 IOResult ReadFileImpl(scoped_refptr<IOBuffer> buf, int buf_len); | 206 IOResult ReadFileImpl(scoped_refptr<IOBuffer> buf, int buf_len); |
| 196 | 207 |
| 197 // WriteFileImpl() is a simple wrapper around write() that handles EINTR | 208 // WriteFileImpl() is a simple wrapper around write() that handles EINTR |
| 198 // signals and calls MapSystemError() to map errno to net error codes. | 209 // signals and calls MapSystemError() to map errno to net error codes. |
| 199 // It tries to write to completion. | 210 // It tries to write to completion. |
| 200 IOResult WriteFileImpl(scoped_refptr<IOBuffer> buf, int buf_len); | 211 IOResult WriteFileImpl(scoped_refptr<IOBuffer> buf, int buf_len); |
| 201 #endif | 212 #endif |
| 202 | 213 |
| 203 base::File file_; | 214 base::File file_; |
| 204 bool async_in_progress_; | 215 bool async_in_progress_; |
| 205 bool orphaned_; | 216 bool orphaned_; |
| 206 scoped_refptr<base::TaskRunner> task_runner_; | 217 scoped_refptr<base::TaskRunner> task_runner_; |
| 207 | 218 |
| 208 #if defined(OS_WIN) | 219 #if defined(OS_WIN) |
| 209 base::MessageLoopForIO::IOContext io_context_; | 220 base::MessageLoopForIO::IOContext io_context_; |
| 210 CompletionCallback callback_; | 221 CompletionCallback callback_; |
| 211 scoped_refptr<IOBuffer> in_flight_buf_; | 222 scoped_refptr<IOBuffer> in_flight_buf_; |
| 212 // WeakPtrFactory for posting tasks back to |this|. | 223 // This flag is set to true when we receive a Read request which is queued to |
| 213 base::WeakPtrFactory<Context> weak_ptr_factory_; | 224 // the thread pool. |
| 225 bool async_read_initiated_; |
| 226 // This flag is set to true when we receive a notification ReadAsyncResult() |
| 227 // on the calling thread which indicates that the asynchronous Read |
| 228 // operation is complete. |
| 229 bool async_read_completed_; |
| 230 // This flag is set to true when we receive an IO completion notification for |
| 231 // an asynchonously initiated Read operaton. OnIOComplete(). |
| 232 bool io_complete_for_read_received_; |
| 233 // Tracks the result of the IO completion operation. Set in OnIOComplete. |
| 234 int result_; |
| 214 #endif | 235 #endif |
| 215 | 236 |
| 216 DISALLOW_COPY_AND_ASSIGN(Context); | 237 DISALLOW_COPY_AND_ASSIGN(Context); |
| 217 }; | 238 }; |
| 218 | 239 |
| 219 } // namespace net | 240 } // namespace net |
| 220 | 241 |
| 221 #endif // NET_BASE_FILE_STREAM_CONTEXT_H_ | 242 #endif // NET_BASE_FILE_STREAM_CONTEXT_H_ |
| OLD | NEW |